blob: dec7baaef5a0c09a2e7c69b06cdbdf720a875b55 (
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
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
===============================================================================
ALE Ruby Integration *ale-ruby-options*
===============================================================================
brakeman *ale-ruby-brakeman*
*ale-options.ruby_brakeman_executable*
*g:ale_ruby_brakeman_executable*
*b:ale_ruby_brakeman_executable*
ruby_brakeman_executable
g:ale_ruby_brakeman_executable
Type: |String|
Default: `'brakeman'`
Override the invoked brakeman binary. Set this to `'bundle'` to invoke
`'bundle` `exec` brakeman'.
*ale-options.ruby_brakeman_options*
*g:ale_ruby_brakeman_options*
*b:ale_ruby_brakeman_options*
ruby_brakeman_options
g:ale_ruby_brakeman_options
Type: |String|
Default: `''`
The contents of this variable will be passed through to brakeman.
===============================================================================
cspell *ale-ruby-cspell*
See |ale-cspell-options|
===============================================================================
debride *ale-ruby-debride*
*ale-options.ruby_debride_executable*
*g:ale_ruby_debride_executable*
*b:ale_ruby_debride_executable*
ruby_debride_executable
g:ale_ruby_debride_executable
Type: |String|
Default: `'debride'`
Override the invoked debride binary. Set this to `'bundle'` to invoke
`'bundle` `exec` debride'.
*ale-options.ruby_debride_options*
*g:ale_ruby_debride_options*
*b:ale_ruby_debride_options*
ruby_debride_options
g:ale_ruby_debride_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to debride.
===============================================================================
packwerk *ale-ruby-packwerk*
*ale-options.ruby_packwerk_executable*
*g:ale_ruby_packwerk_executable*
*b:ale_ruby_packwerk_executable*
ruby_packwerk_executable
g:ale_ruby_packwerk_executable
Type: |String|
Default: `'packwerk'`
Override the invoked packwerk binary. Set this to `'bundle'` to invoke
`'bundle` `exec` packwerk'.
*ale-options.ruby_packwerk_options*
*g:ale_ruby_packwerk_options*
*b:ale_ruby_packwerk_options*
ruby_packwerk_options
g:ale_ruby_packwerk_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to packwerk.
===============================================================================
prettier *ale-ruby-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
rails_best_practices *ale-ruby-rails_best_practices*
*ale-options.ruby_rails_best_practices_executable*
*g:ale_ruby_rails_best_practices_executable*
*b:ale_ruby_rails_best_practices_executable*
ruby_rails_best_practices_executable
g:ale_ruby_rails_best_practices_executable
Type: |String|
Default: `'rails_best_practices'`
Override the invoked rails_best_practices binary. Set this to `'bundle'` to
invoke `'bundle` `exec` rails_best_practices'.
*ale-options.ruby_rails_best_practices_options*
*g:ale_ruby_rails_best_practices_options*
*b:ale_ruby_rails_best_practices_options*
ruby_rails_best_practices_options
g:ale_ruby_rails_best_practices_options
Type: |String|
Default: `''`
The contents of this variable will be passed through to rails_best_practices.
===============================================================================
reek *ale-ruby-reek*
*ale-options.ruby_reek_executable*
*g:ale_ruby_reek_executable*
*b:ale_ruby_reek_executable*
ruby_reek_executable
g:ale_ruby_reek_executable
Type: |String|
Default: `'reek'`
Override the invoked reek binary. Set this to `'bundle'` to invoke
`'bundle` `exec` reek'.
*ale-options.ruby_reek_show_context*
*g:ale_ruby_reek_show_context*
*b:ale_ruby_reek_show_context*
ruby_reek_show_context
g:ale_ruby_reek_show_context
Type: |Number|
Default: `0`
Controls whether context is included in the linter message. Defaults to off
because context is usually obvious while viewing a file.
*ale-options.ruby_reek_show_wiki_link*
*g:ale_ruby_reek_show_wiki_link*
*b:ale_ruby_reek_show_wiki_link*
ruby_reek_show_wiki_link
g:ale_ruby_reek_show_wiki_link
Type: |Number|
Default: `0`
Controls whether linter messages contain a link to an explanatory wiki page
for the type of code smell. Defaults to off to improve readability.
===============================================================================
rubocop *ale-ruby-rubocop*
*ale-options.ruby_rubocop_executable*
*g:ale_ruby_rubocop_executable*
*b:ale_ruby_rubocop_executable*
ruby_rubocop_executable
g:ale_ruby_rubocop_executable
Type: |String|
Default: `'rubocop'`
Override the invoked rubocop binary. Set this to `'bundle'` to invoke
`'bundle` `exec` rubocop'.
*ale-options.ruby_rubocop_options*
*g:ale_ruby_rubocop_options*
*b:ale_ruby_rubocop_options*
ruby_rubocop_options
g:ale_ruby_rubocop_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to rubocop.
*ale-options.ruby_rubocop_auto_correct_all*
*g:ale_ruby_rubocop_auto_correct_all*
*b:ale_ruby_rubocop_auto_correct_all*
ruby_rubocop_auto_correct_all
g:ale_ruby_rubocop_auto_correct_all
Type: |Number|
Default: `0`
This variable can be changed to make rubocop to correct all offenses (unsafe).
===============================================================================
ruby *ale-ruby-ruby*
*ale-options.ruby_ruby_executable*
*g:ale_ruby_ruby_executable*
*b:ale_ruby_ruby_executable*
ruby_ruby_executable
g:ale_ruby_ruby_executable
Type: |String|
Default: `'ruby'`
This variable can be changed to use a different executable for ruby.
===============================================================================
rufo *ale-ruby-rufo*
*ale-options.ruby_rufo_executable*
*g:ale_ruby_rufo_executable*
*b:ale_ruby_rufo_executable*
ruby_rufo_executable
g:ale_ruby_rufo_executable
Type: |String|
Default: `'rufo'`
Override the invoked rufo binary. This is useful for running rufo from
binstubs or a bundle.
===============================================================================
solargraph *ale-ruby-solargraph*
*ale-options.ruby_solargraph_executable*
*g:ale_ruby_solargraph_executable*
*b:ale_ruby_solargraph_executable*
ruby_solargraph_executable
g:ale_ruby_solargraph_executable
Type: |String|
Default: `'solargraph'`
Override the invoked solargraph binary. Set this to `'bundle'` to invoke
`'bundle` `exec` solargraph'.
===============================================================================
sorbet *ale-ruby-sorbet*
*ale-options.ruby_sorbet_executable*
*g:ale_ruby_sorbet_executable*
*b:ale_ruby_sorbet_executable*
ruby_sorbet_executable
g:ale_ruby_sorbet_executable
Type: |String|
Default: `'srb'`
Override the invoked sorbet binary. Set this to `'bundle'` to invoke
`'bundle` `exec` srb'.
*ale-options.ruby_sorbet_options*
*g:ale_ruby_sorbet_options*
*b:ale_ruby_sorbet_options*
ruby_sorbet_options
g:ale_ruby_sorbet_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to sorbet.
*ale-options.ruby_sorbet_enable_watchman*
*g:ale_ruby_sorbet_enable_watchman*
*b:ale_ruby_sorbet_enable_watchman*
ruby_sorbet_enable_watchman
g:ale_ruby_sorbet_enable_watchman
Type: |Number|
Default: `0`
Whether or not to use watchman to let the LSP server to know about changes
to files from outside of vim. Defaults to disable watchman because it
requires watchman to be installed separately from sorbet.
*ale-options.ruby_sorbet_initialization_options*
*g:ale_ruby_sorbet_initialization_options*
*b:ale_ruby_sorbet_initialization_options*
ruby_sorbet_initialization_options
g:ale_ruby_sorbet_initialization_options
Type: |Dictionary|
Default: `{ 'highlightUntyped': v:false }`
This variable can be changed to modify initialization options provided to
the Sorbet language server. By default, a minimal object with defaults is
provided to ensure proper LSP initialization.
Setting this variable to a an empty object will cause sorbet LSP to
fail during initialization.
See https://sorbet.org/docs/lsp#initialize-request for available options.
===============================================================================
standardrb *ale-ruby-standardrb*
*ale-options.ruby_standardrb_executable*
*g:ale_ruby_standardrb_executable*
*b:ale_ruby_standardrb_executable*
ruby_standardrb_executable
g:ale_ruby_standardrb_executable
Type: |String|
Default: `'standardrb'`
Override the invoked standardrb binary. Set this to `'bundle'` to invoke
`'bundle` `exec` standardrb'.
*ale-options.ruby_standardrb_options*
*g:ale_ruby_standardrb_options*
*b:ale_ruby_standardrb_options*
ruby_standardrb_options
g:ale_ruby_standardrb_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to standardrb.
===============================================================================
syntax_tree *ale-ruby-syntax_tree*
*ale-options.ruby_syntax_tree_executable*
*g:ale_ruby_syntax_tree_executable*
*b:ale_ruby_syntax_tree_executable*
ruby_syntax_tree_executable
g:ale_ruby_syntax_tree_executable
Type: |String|
Default: `'stree'`
Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke
`'bundle` `exec` stree'.
*ale-options.ruby_syntax_tree_options*
*g:ale_ruby_syntax_tree_options*
*b:ale_ruby_syntax_tree_options*
ruby_syntax_tree_options
g:ale_ruby_syntax_tree_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to SyntaxTree.
===============================================================================
rubyfmt *ale-ruby-rubyfmt*
*ale-options.ruby_rubyfmt_executable*
*g:ale_ruby_rubyfmt_executable*
*b:ale_ruby_rubyfmt_executable*
ruby_rubyfmt_executable
g:ale_ruby_rubyfmt_executable
Type: |String|
Default: `'rubyfmt'`
This option can be changed to change the path for `rubyfmt`.
*ale-options.ruby_rubyfmt_options*
*g:ale_ruby_rubyfmt_options*
*b:ale_ruby_rubyfmt_options*
ruby_rubyfmt_options
g:ale_ruby_rubyfmt_options
Type: |String|
Default: `''`
This option can be changed to pass extra options to `'rubyfmt'`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|