]> git.madduck.net Git - etc/vim.git/blob - .vim/bundle/ale/doc/ale-vim.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge commit '294584081929424aec883f90c7d6515b3743358d' as '.vim/bundle/vim-lsp-ale'
[etc/vim.git] / .vim / bundle / ale / doc / ale-vim.txt
1 ===============================================================================
2 ALE Vim Integration                                           *ale-vim-options*
3
4
5 ===============================================================================
6 vimls                                                           *ale-vim-vimls*
7
8   The `vim-language-server` is the engine that powers VimL editor support
9   using the Language Server Protocol.  See the installation instructions:
10   https://github.com/iamcco/vim-language-server#install
11
12                                              *ale-options.vim_vimls_executable*
13                                                    *g:ale_vim_vimls_executable*
14                                                    *b:ale_vim_vimls_executable*
15 vim_vimls_executable
16 g:ale_vim_vimls_executable
17   Type: |String|
18   Default: `'vim-language-server'`
19
20   This option can be set to change the executable path for vimls.
21
22                                                  *ale-options.vim_vimls_config*
23                                                        *g:ale_vim_vimls_config*
24                                                        *b:ale_vim_vimls_config*
25 vim_vimls_config
26 g:ale_vim_vimls_config
27   Type: |Dictionary|
28   Default: `{}`
29
30   Dictionary containing configuration settings that will be passed to the
31   language server. For example: >
32
33   let g:ale_vim_vimls_config = {
34   \   'vim': {
35   \       'iskeyword': '@,48-57,_,192-255,-#',
36   \       'vimruntime': '',
37   \       'runtimepath': '',
38   \       'diagnostic': {'enable': v:true},
39   \       'indexes': {
40   \           'runtimepath': v:true,
41   \           'gap': 100,
42   \           'count': 3,
43   \           'projectRootPatterns': ['.git', 'autoload', 'plugin'],
44   \       },
45   \       'suggest': {
46   \           'fromVimruntime': v:true,
47   \           'fromRuntimepath': v:false,
48   \       },
49   \   },
50   \}
51 <
52   Consult the vim-language-server documentation for more information about
53   settings.
54
55                                              *ale-options.vim_vimls_use_global*
56                                                    *g:ale_vim_vimls_use_global*
57                                                    *b:ale_vim_vimls_use_global*
58 vim_vimls_use_global
59 g:ale_vim_vimls_use_global
60   Type: |Number|
61   Default: `get(g:, 'ale_use_global_executables', 0)`
62
63   See |ale-integrations-local-executables|
64
65
66 ===============================================================================
67 vint                                                             *ale-vim-vint*
68
69                                               *ale-options.vim_vint_executable*
70                                                     *g:ale_vim_vint_executable*
71                                                     *b:ale_vim_vint_executable*
72 vim_vint_executable
73 g:ale_vim_vint_executable
74   Type: |String|
75   Default: `'vint'`
76
77   This option can be set to change the executable path for Vint.
78
79                                        *ale-options.vim_vint_show_style_issues*
80                                              *g:ale_vim_vint_show_style_issues*
81                                              *b:ale_vim_vint_show_style_issues*
82 vim_vint_show_style_issues
83 g:ale_vim_vint_show_style_issues
84   Type: |Number|
85   Default: `1`
86
87   This variable will enable/disable style issues for Vint. When this option
88   is disabled, only warnings and errors which are not purely style issues
89   will be reported.
90
91
92 ===============================================================================
93   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: