This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/syntax-checking/README.org
2016-01-31 23:04:48 -05:00

56 lines
2.3 KiB
Org Mode

#+TITLE: Syntax Checking layer
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../../css/readtheorg.css" />
[[file:img/flycheck.png]]
* Table of Contents :TOC_4_org:noexport:
- [[Description][Description]]
- [[Install][Install]]
- [[Layer][Layer]]
- [[Enabling/Disabling 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=. You will need to
add =syntax-checking= to the existing =dotspacemacs-configuration-layers= list in this
file.
** 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
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=.
* Key Bindings
| Key Binding | Description |
|-------------+--------------------------------------------------------------|
| ~SPC e c~ | clear errors |
| ~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 t s~ | toggle flycheck |