aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/ale-vim.txt
blob: aa2045ace1023da35318ddf3abd892fb288f7c93 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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: