summaryrefslogtreecommitdiff
path: root/doc/ale-lua.txt
blob: ee0a8780283fc3122b2f4abdeb823b09b20d831e (plain)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
===============================================================================
ALE Lua Integration                                           *ale-lua-options*


===============================================================================
cspell                                                         *ale-lua-cspell*

See |ale-cspell-options|


===============================================================================
lua-format                                                 *ale-lua-lua-format*

g:ale_lua_lua_format_executable               *g:ale_lua_lua_format_executable*
                                              *b:ale_lua_lua_format_executable*
  Type: |String|
  Default: `'lua-format'`

  This variable can be changed to change the path to lua-format.


g:ale_lua_lua_format_options                     *g:ale_lua_lua_format_options*
                                                 *b:ale_lua_lua_format_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to lua-format.


===============================================================================
lua-language-server                               *ale-lua-lua-language-server*
                                                      *ale-lua-language-server*

g:ale_lua_language_server_executable     *g:ale_lua_language_server_executable*
                                         *b:ale_lua_language_server_executable*
  Type: |String|
  Default: `'lua-language-server'`

  This variable can be changed to set the path to lua-language-server.

  If you have compiled the language server yourself in `/some/path`, the path
  will be `'/some/path/bin/lua-language-server'`.


g:ale_lua_language_server_config             *g:ale_lua_language_server_config*
                                             *b:ale_lua_language_server_config*
  Type: |Dictionary|
  Default: `{}`

  Dictionary containing configuration settings that will be passed to the
  language server.

  For available configuration parameters, see `Settings` on the luals wiki:

  https://luals.github.io/wiki/settings/


===============================================================================
luac                                                             *ale-lua-luac*

g:ale_lua_luac_executable                           *g:ale_lua_luac_executable*
                                                    *b:ale_lua_luac_executable*
  Type: |String|
  Default: `'luac'`

  This variable can be changed to change the path to luac.


===============================================================================
luacheck                                                     *ale-lua-luacheck*

g:ale_lua_luacheck_executable                   *g:ale_lua_luacheck_executable*
                                                *b:ale_lua_luacheck_executable*
  Type: |String|
  Default: `'luacheck'`

  This variable can be changed to change the path to luacheck.


g:ale_lua_luacheck_options                         *g:ale_lua_luacheck_options*
                                                   *b:ale_lua_luacheck_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to luacheck.


===============================================================================
luafmt                                                         *ale-lua-luafmt*

g:ale_lua_luafmt_executable                       *g:ale_lua_luafmt_executable*
                                                  *b:ale_lua_luafmt_executable*
  Type: |String|
  Default: `'luafmt'`

  This variable can be set to use a different executable for luafmt.


g:ale_lua_luafmt_options                             *g:ale_lua_luafmt_options*
                                                     *b:ale_lua_luafmt_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the luafmt fixer.


===============================================================================
selene                                                         *ale-lua-selene*

g:ale_lua_selene_executable                       *g:ale_lua_selene_executable*
                                                  *b:ale_lua_selene_executable*
  Type: |String|
  Default: `'selene'`

  This variable can be set to use a different executable for selene.


g:ale_lua_selene_options                             *g:ale_lua_selene_options*
                                                     *b:ale_lua_selene_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to selene.


===============================================================================
stylua                                                         *ale-lua-stylua*

g:ale_lua_stylua_executable                       *g:ale_lua_stylua_executable*
                                                  *b:ale_lua_stylua_executable*
  Type: |String|
  Default: `'stylua'`

  This variable can be set to use a different executable for stylua.


g:ale_lua_stylua_options                             *g:ale_lua_stylua_options*
                                                     *b:ale_lua_stylua_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the stylua fixer.


===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: