TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
spacemacs/layers/+checkers/syntax-checking/README.org
smile13241324 252c94a1ce doc: revise docs for auto-complete and syntax-checking layers 
Syntax-checking and auto-complete layers should more
directly communicate that their function depends on
the installation of individual language layers to avoid
misunderstandings with new users who only install
syntax-checking or auto-complete and install the packages
manually.
2018-08-15 22:15:45 +01:00

3.1 KiB
Raw Blame History

Syntax Checking layer

/TakeV/spacemacs/media/commit/252c94a1ce046a3551860d0da24b4a00d656b66d/layers/+checkers/syntax-checking/img/flycheck.png

Description

This layer adds on the fly syntax checking to all supported language layers.

Features:

  • Support for automatic syntax checking with Flycheck for various language layers
  • Tooltip syntax errors with popwin

Install

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add syntax-checking to the existing dotspacemacs-configuration-layers list in this file.

As this is a support layer you will also have to install at least one supported language layer for it to have any effect.

Enabling/Disabling tooltips

By default tooltips are enabled and used whenever it is possible. You can disable them by setting the variable syntax-checking-enable-tooltips to nil:

(setq-default dotspacemacs-configuration-layers
  '((syntax-checking :variables syntax-checking-enable-tooltips nil)))

Disabling by default

By default, syntax-checking is enabled in all available major modes (except for emacs-lisp-mode) and may be toggled off with SPC t s. You can default this to off by setting the variable syntax-checking-enable-by-default to nil:

(setq-default dotspacemacs-configuration-layers
  '((syntax-checking :variables syntax-checking-enable-by-default nil)))

If you want more fine-grained control, you can configure the variable flycheck-global-modes instead. Note that this variable should be manipulated in dotspacemacs/user-config.

Bitmaps

If the original flycheck fringe bitmaps are more to your liking, you can set the variable syntax-checking-use-original-bitmaps to t:

(setq-default dotspacemacs-configuration-layers
  '((syntax-checking :variables syntax-checking-use-original-bitmaps t)))

Key Bindings

Key Binding Description
SPC e b check for errors now
SPC e c clear errors
SPC e h describe flycheck checker
SPC e l display a list of all the errors
SPC e L display a list of all the errors and focus the errors buffer
SPC e s set flycheck checker
SPC e S set flycheck checker executable
SPC e v verify flycheck setup
SPC t s toggle flycheck
SPC e x explain the error at point