spacemacs/layers/syntax-checking/README.org

#+TITLE: Syntax Checking configuration layer for Spacemacs

[[file:img/flycheck.png]]

* Table of Contents                                                   :TOC@4:
 - [[#description][Description]]
 - [[#install][Install]]
   - [[#layer][Layer]]
   - [[#enablingdisabling-tooltips][Enabling/Disabling tooltips]]
   - [[#disabling-by-default][Disabling by default]]
 - [[#key-bindings][Key Bindings]]

* Description
This layer provides on the fly syntax checking using [[http://www.flycheck.org/][Flycheck]].

* Install
** Layer
To use this configuration layer add it to your =~/.spacemacs=

#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(syntax-checking))
#+END_SRC

** 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=:

#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers
  '((syntax-checking :variables syntax-checking-enable-tooltips nil)))
#+END_SRC

** Disabling by default
By default, syntax-checking is enabled in all available major modes 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=:

#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers
  '((syntax-checking :variables syntax-checking-enable-by-default nil)))
#+END_SRC

* Key Bindings

| Key Binding | Description                      |
|-------------+----------------------------------|
| ~SPC e c~   | clear errors                     |
| ~SPC e l~   | display a list of all the errors |
| ~SPC e s~   | set flycheck checker             |
| ~SPC e S~   | set flycheck checker executable  |
| ~SPC t s~   | toggle flycheck                  |