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
|
===============================================================================
ALE TypeScript Integration *ale-typescript-options*
===============================================================================
biome *ale-typescript-biome*
*ale-options.biome_executable*
*g:ale_biome_executable*
*b:ale_biome_executable*
biome_executable
g:ale_biome_executable
Type: |String|
Default: `'biome'`
*ale-options.biome_options*
*g:ale_biome_options*
*b:ale_biome_options*
biome_options
g:ale_biome_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to `biome check` when
applying fixes.
*ale-options.biome_use_global*
*g:ale_biome_use_global*
*b:ale_biome_use_global*
biome_use_global
g:ale_biome_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
*ale-options.biome_fixer_apply_unsafe*
*g:ale_biome_fixer_apply_unsafe*
*b:ale_biome_fixer_apply_unsafe*
biome_fixer_apply_unsafe
g:ale_biome_fixer_apply_unsafe
Type: |Number|
Default: `0`
If set to `1`, biome will apply unsafe fixes along with safe fixes.
*ale-options.biome_lsp_project_root*
*g:ale_biome_lsp_project_root*
*b:ale_biome_lsp_project_root*
biome_lsp_project_root
g:ale_biome_lsp_project_root
Type: |String|
Default: `''`
If this variable is left unset, ALE will try to find the project root by
executing the following steps in the given order:
1. Find an ancestor directory containing a biome.json.
2. Find an ancestor directory containing a biome.jsonc.
3. Find an ancestor directory containing a package.json.
4. Find an ancestor directory containing a .git folder.
5. Use the directory of the current buffer (if the buffer was opened from
a file).
===============================================================================
cspell *ale-typescript-cspell*
See |ale-cspell-options|
===============================================================================
deno *ale-typescript-deno*
Starting from version 1.6.0, Deno comes with its own language server. Earlier
versions are not supported.
-------------------------------------------------------------------------------
Options
*ale-options.deno_executable*
*g:ale_deno_executable*
*b:ale_deno_executable*
deno_executable
g:ale_deno_executable
Type: |String|
Default: `'deno'`
*ale-options.deno_lsp_project_root*
*g:ale_deno_lsp_project_root*
*b:ale_deno_lsp_project_root*
deno_lsp_project_root
g:ale_deno_lsp_project_root
Type: |String|
Default: `''`
If this variable is left unset, ALE will try to find the project root by
executing the following steps in the given order:
1. Find an ancestor directory containing a tsconfig.json.
2. Find an ancestor directory containing a .git folder.
3. Use the directory of the current buffer (if the buffer was opened from
a file).
*ale-options.deno_unstable*
*g:ale_deno_unstable*
*b:ale_deno_unstable*
deno_unstable
g:ale_deno_unstable
Type: |Number|
Default: `0`
Enable or disable unstable Deno features and APIs.
*ale-options.deno_import_map*
*g:ale_deno_import_map*
*b:ale_deno_import_map*
deno_import_map
g:ale_deno_import_map
Type: |String|
Default: `'import_map.json'`
Specify the import map filename to load url maps in a deno project.
===============================================================================
dprint *ale-typescript-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/typescript
===============================================================================
eslint *ale-typescript-eslint*
Because of how TypeScript compiles code to JavaScript and how interrelated
the two languages are, the `eslint` linter for TypeScript uses the JavaScript
options for `eslint` too. See: |ale-javascript-eslint|.
===============================================================================
prettier *ale-typescript-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
standard *ale-typescript-standard*
*ale-options.typescript_standard_executable*
*g:ale_typescript_standard_executable*
*b:ale_typescript_standard_executable*
typescript_standard_executable
g:ale_typescript_standard_executable
Type: |String|
Default: `'standard'`
See |ale-integrations-local-executables|
*ale-options.typescript_standard_options*
*g:ale_typescript_standard_options*
*b:ale_typescript_standard_options*
typescript_standard_options
g:ale_typescript_standard_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to standard.
*ale-options.typescript_standard_use_global*
*g:ale_typescript_standard_use_global*
*b:ale_typescript_standard_use_global*
typescript_standard_use_global
g:ale_typescript_standard_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
tslint *ale-typescript-tslint*
This linter isn't recommended, because TSLint can't be used for checking for
problems while you type. You should probably use the tsserver plugin instead.
tsserver plugins are described here:
https://github.com/Microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin
Follow the instructions on the plugin website for installing it:
https://github.com/Microsoft/typescript-tslint-plugin
Then disable TSLint in your typescript ftplugin file. >
let b:ale_linters_ignore = ['tslint']
<
Or in Lua: >
require("ale").setup.buffer({linters_ignore={"tslint"}})
<
-------------------------------------------------------------------------------
Options
*ale-options.typescript_tslint_executable*
*g:ale_typescript_tslint_executable*
*b:ale_typescript_tslint_executable*
typescript_tslint_executable
g:ale_typescript_tslint_executable
Type: |String|
Default: `'tslint'`
See |ale-integrations-local-executables|
*ale-options.typescript_tslint_config_path*
*g:ale_typescript_tslint_config_path*
*b:ale_typescript_tslint_config_path*
typescript_tslint_config_path
g:ale_typescript_tslint_config_path
Type: |String|
Default: `''`
ALE will first discover the tslint.json path in an ancestor directory. If no
such path exists, this variable will be used instead.
*ale-options.typescript_tslint_ignore_empty_files*
*g:ale_typescript_tslint_ignore_empty_files*
*b:ale_typescript_tslint_ignore_empty_files*
typescript_tslint_ignore_empty_files
g:ale_typescript_tslint_ignore_empty_files
Type: |Number|
Default: `0`
When set to `1`, ALE will not report any problems for empty files with
TSLint. ALE will still execute TSLint for the files, but ignore any problems
reported. This stops ALE from complaining about newly created files,
and files where lines have been added and then removed.
*ale-options.typescript_tslint_rules_dir*
*g:ale_typescript_tslint_rules_dir*
*b:ale_typescript_tslint_rules_dir*
typescript_tslint_rules_dir
g:ale_typescript_tslint_rules_dir
Type: |String|
Default: `''`
If this variable is set, ALE will use it as the rules directory for tslint.
*ale-options.typescript_tslint_use_global*
*g:ale_typescript_tslint_use_global*
*b:ale_typescript_tslint_use_global*
typescript_tslint_use_global
g:ale_typescript_tslint_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
tsserver *ale-typescript-tsserver*
*ale-options.typescript_tsserver_executable*
*g:ale_typescript_tsserver_executable*
*b:ale_typescript_tsserver_executable*
typescript_tsserver_executable
g:ale_typescript_tsserver_executable
Type: |String|
Default: `'tsserver'`
ALE will first discover the tsserver path in an ancestor node_modules
directory. If no such path exists, this variable will be used instead.
If you wish to use only a globally installed version of tsserver, set
|g:ale_typescript_tsserver_use_global| to `1`.
*ale-options.typescript_tsserver_config_path*
*g:ale_typescript_tsserver_config_path*
*b:ale_typescript_tsserver_config_path*
typescript_tsserver_config_path
g:ale_typescript_tsserver_config_path
Type: |String|
Default: `''`
ALE will first discover the tsserver.json path in an ancestor directory. If
no such path exists, this variable will be used instead.
*ale-options.typescript_tsserver_use_global*
*g:ale_typescript_tsserver_use_global*
*b:ale_typescript_tsserver_use_global*
typescript_tsserver_use_global
g:ale_typescript_tsserver_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for a local path for
tsserver first. If this variable is set to `1`, then ALE will always use the
global version of tsserver, in preference to locally installed versions of
tsserver in node_modules.
===============================================================================
xo *ale-typescript-xo*
*ale-options.typescript_xo_executable*
*g:ale_typescript_xo_executable*
*b:ale_typescript_xo_executable*
typescript_xo_executable
g:ale_typescript_xo_executable
Type: |String|
Default: `'xo'`
See |ale-integrations-local-executables|
*ale-options.typescript_xo_options*
*g:ale_typescript_xo_options*
*b:ale_typescript_xo_options*
typescript_xo_options
g:ale_typescript_xo_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to xo.
*ale-options.typescript_xo_use_global*
*g:ale_typescript_xo_use_global*
*b:ale_typescript_xo_use_global*
typescript_xo_use_global
g:ale_typescript_xo_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|