X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0ee596c5c5e11fc79598407eaf22f83d279f7e9e..5a4872f466ebd76ddd532bdf2798554421c53df4:/.vim/bundle/ale/doc/ale-vim.txt diff --git a/.vim/bundle/ale/doc/ale-vim.txt b/.vim/bundle/ale/doc/ale-vim.txt new file mode 100644 index 00000000..aa2045ac --- /dev/null +++ b/.vim/bundle/ale/doc/ale-vim.txt @@ -0,0 +1,93 @@ +=============================================================================== +ALE Vim Integration *ale-vim-options* + + +=============================================================================== +vimls *ale-vim-vimls* + + The `vim-language-server` is the engine that powers VimL editor support + using the Language Server Protocol. See the installation instructions: + https://github.com/iamcco/vim-language-server#install + + *ale-options.vim_vimls_executable* + *g:ale_vim_vimls_executable* + *b:ale_vim_vimls_executable* +vim_vimls_executable +g:ale_vim_vimls_executable + Type: |String| + Default: `'vim-language-server'` + + This option can be set to change the executable path for vimls. + + *ale-options.vim_vimls_config* + *g:ale_vim_vimls_config* + *b:ale_vim_vimls_config* +vim_vimls_config +g:ale_vim_vimls_config + Type: |Dictionary| + Default: `{}` + + Dictionary containing configuration settings that will be passed to the + language server. For example: > + + let g:ale_vim_vimls_config = { + \ 'vim': { + \ 'iskeyword': '@,48-57,_,192-255,-#', + \ 'vimruntime': '', + \ 'runtimepath': '', + \ 'diagnostic': {'enable': v:true}, + \ 'indexes': { + \ 'runtimepath': v:true, + \ 'gap': 100, + \ 'count': 3, + \ 'projectRootPatterns': ['.git', 'autoload', 'plugin'], + \ }, + \ 'suggest': { + \ 'fromVimruntime': v:true, + \ 'fromRuntimepath': v:false, + \ }, + \ }, + \} +< + Consult the vim-language-server documentation for more information about + settings. + + *ale-options.vim_vimls_use_global* + *g:ale_vim_vimls_use_global* + *b:ale_vim_vimls_use_global* +vim_vimls_use_global +g:ale_vim_vimls_use_global + Type: |Number| + Default: `get(g:, 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| + + +=============================================================================== +vint *ale-vim-vint* + + *ale-options.vim_vint_executable* + *g:ale_vim_vint_executable* + *b:ale_vim_vint_executable* +vim_vint_executable +g:ale_vim_vint_executable + Type: |String| + Default: `'vint'` + + This option can be set to change the executable path for Vint. + + *ale-options.vim_vint_show_style_issues* + *g:ale_vim_vint_show_style_issues* + *b:ale_vim_vint_show_style_issues* +vim_vint_show_style_issues +g:ale_vim_vint_show_style_issues + Type: |Number| + Default: `1` + + This variable will enable/disable style issues for Vint. When this option + is disabled, only warnings and errors which are not purely style issues + will be reported. + + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: