1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:30:04 +08:00

doc: update doc of checkers layer

This commit is contained in:
Shidong Wang 2021-09-19 22:57:47 +08:00
parent 3fc49916cc
commit 5f434d28c8
2 changed files with 24 additions and 2 deletions

View File

@ -9,7 +9,18 @@
""
" @section checkers, layer-checkers
" @parentsection layers
" SpaceVim uses neomake as default syntax checker.
" The `checkers` layer provides syntax lint feature. The default lint engine
" is |neomake|, this can be changed by `lint_engine` option:
" >
" [options]
" lint_engine = 'ale'
" <
"
" @subsection options
"
" - `lint_on_the_fly`: Syntax checking on the fly feature, disabled by default.
" - `lint_on_save`: Run syntax checking when saving a file.
" - `show_cursor_error`: Enable/Disable displaying error below current line.
if exists('s:show_cursor_error')

View File

@ -1450,7 +1450,18 @@ snippets directory is `~/.SpaceVim/snippets/`. If
==============================================================================
CHECKERS *SpaceVim-layer-checkers*
SpaceVim uses neomake as default syntax checker.
The `checkers` layer provides syntax lint feature. The default lint engine is
|neomake|, this can be changed by `lint_engine` option:
>
[options]
lint_engine = 'ale'
<
OPTIONS
`lint_on_the_fly`: Syntax checking on the fly feature, disabled by default.
`lint_on_save`: Run syntax checking when saving a file.
`show_cursor_error`: Enable/Disable displaying error below current line.
==============================================================================
COLORSCHEME *SpaceVim-layer-colorscheme*