From aa51aeef28bdcaa9ec77e9e88c4c722e7b9b5d6d Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Thu, 24 Sep 2020 00:23:11 +0800 Subject: [PATCH] Update checkers layer doc (#3832) --- docs/cn/documentation.md | 2 +- docs/cn/layers/checkers.md | 6 +++++- docs/documentation.md | 2 +- docs/layers/checkers.md | 5 ++++- 4 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/cn/documentation.md b/docs/cn/documentation.md index 97486dd4e..6d6a10333 100644 --- a/docs/cn/documentation.md +++ b/docs/cn/documentation.md @@ -294,7 +294,7 @@ SpaceVim 默认安装了一些插件,如果需要禁用某个插件,可以 ```vim function! myspacevim#before() abort - let g:neomake_enabled_c_makers = ['clang'] + let g:neomake_c_enabled_makers = ['clang'] nnoremap jk endfunction diff --git a/docs/cn/layers/checkers.md b/docs/cn/layers/checkers.md index ddb21bac1..832088350 100644 --- a/docs/cn/layers/checkers.md +++ b/docs/cn/layers/checkers.md @@ -44,10 +44,14 @@ SpaceVim 选项: | 选项名称 | 默认值 | 描述 | | ----------------- | ------ | ----------------------------------- | -| `enable_neomake` | true | 使用 Neomake 作为默认的语法检查插件 | +| `enable_neomake` | true | 使用 [neomake](https://github.com/neomake/neomake) 作为默认的语法检查插件 | | `enable_ale` | false | 使用 Ale 作为默认语法检查插件 | | `lint_on_the_fly` | false | 启用实时语法检查 | +Neomake 的设置需要使用启动函数,在启动函数里,可以使用 Vim 脚本, +关于 neomake 所有的配置相关信息,可以查阅 `:h neomake`。 + + **NOTE:** 如果你需要使用 Ale 作为默认检查工具,SpaceVim 选项需要加入: ```toml diff --git a/docs/documentation.md b/docs/documentation.md index 141dc00b2..b48bdf9a4 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -309,7 +309,7 @@ with contents for example ```vim function! myspacevim#before() abort - let g:neomake_enabled_c_makers = ['clang'] + let g:neomake_c_enabled_makers = ['clang'] nnoremap jk endfunction diff --git a/docs/layers/checkers.md b/docs/layers/checkers.md index aa000c6e8..9b59aad42 100644 --- a/docs/layers/checkers.md +++ b/docs/layers/checkers.md @@ -46,10 +46,13 @@ the following options are SpaceVim option, you need to config them in `[options] | Name | default value | description | | ----------------- | ------------- | -------------------------------------------------------- | -| `enable_neomake` | `true` | Use neomake as default checking tools | +| `enable_neomake` | `true` | Use [neomake](https://github.com/neomake/neomake) as default checking tools | | `enable_ale` | `false` | Use ale as default checking tools | | `lint_on_the_fly` | `false` | Syntax checking on the fly feature, disabled by default. | +If you want to config neomake, you can use bootstrap functions. Within bootstrap functions, +you can use vim script. For all the info about neomake configuration, please checkout `:h neomake`. + **NOTE:** if you want to use ale, you need: ```toml