summaryrefslogtreecommitdiff
path: root/doc/ale-javascript.txt
blob: 2eab11774c66ba67a1248318321b3967c0160fcb (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
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
===============================================================================
ALE JavaScript Integration                             *ale-javascript-options*


-------------------------------------------------------------------------------
eslint                                                  *ale-javascript-eslint*

g:ale_javascript_eslint_executable         *g:ale_javascript_eslint_executable*
                                           *b:ale_javascript_eslint_executable*
  Type: |String|
  Default: `'eslint'`

  ALE will first discover the eslint path in an ancestor node_modules
  directory. If no such path exists, this variable will be used instead.

  This variable can be set to change the path to eslint. If you have eslint_d
  installed, you can set this option to use eslint_d instead.

  If you wish to use only a globally installed version of eslint, set
  |g:ale_javascript_eslint_use_global| to `1`.


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

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


g:ale_javascript_eslint_use_global         *g:ale_javascript_eslint_use_global*
                                           *b:ale_javascript_eslint_use_global*
  Type: |Number|
  Default: `0`

  This variable controls whether or not ALE will search for a local path for
  eslint first. If this variable is set to `1`, then ALE will always use the
  global version of eslint, in preference to locally installed versions of
  eslint in node_modules.


-------------------------------------------------------------------------------
prettier                                              *ale-javascript-prettier*

g:ale_javascript_prettier_executable     *g:ale_javascript_prettier_executable*
                                         *b:ale_javascript_prettier_executable*
  Type: |String|
  Default: `'prettier'`

  ALE will first discover the prettier 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 prettier set
  |g:ale_javascript_prettier_use_global| to `1`.


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

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


g:ale_javascript_prettier_use_global     *g:ale_javascript_prettier_use_global*
                                         *b:ale_javascript_prettier_use_global*
  Type: |Number|
  Default: `0`

  This variable controls whether or not ALE will search for a local path for
  prettier first. If this variable is set to `1`, then ALE will always use the
  global version of Prettier.


-------------------------------------------------------------------------------
prettier-eslint                                *ale-javascript-prettier-eslint*

g:ale_javascript_prettier_eslint_executable
                                  *g:ale_javascript_prettier_eslint_executable*
                                  *b:ale_javascript_prettier_eslint_executable*
  Type: |String|
  Default: `'prettier-eslint'`

  ALE will first discover the prettier-eslint 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 prettier-eslint set
  |g:ale_javascript_prettier_eslint_use_global| to `1`.


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

  This variable can be set to pass additional options to prettier-eslint.


g:ale_javascript_prettier_eslint_use_global
                                  *g:ale_javascript_prettier_eslint_use_global*
                                  *b:ale_javascript_prettier_eslint_use_global*
  Type: |Number|
  Default: `0`

  This variable controls whether or not ALE will search for a local path for
  prettier-eslint first. If this variable is set to `1`, then ALE will always
  use the global version of Prettier-eslint.


-------------------------------------------------------------------------------
flow                                                      *ale-javascript-flow*

g:ale_javascript_flow_executable             *g:ale_javascript_flow_executable*
                                             *b:ale_javascript_flow_executable*
  Type: |String|
  Default: `'flow'`

  ALE will first discover the flow 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 flow, set
  |g:ale_javascript_flow_use_global| to `1`.


g:ale_javascript_flow_use_global             *g:ale_javascript_flow_use_global*
                                             *b:ale_javascript_flow_use_global*
  Type: |Number|
  Default: `0`

  This variable controls whether or not ALE will search for a local path for
  flow first. If this variable is set to `1`, then ALE will always use the
  global version of flow, in preference to locally installed versions of
  flow in node_modules.


-------------------------------------------------------------------------------
jshint                                                  *ale-javascript-jshint*

g:ale_javascript_jshint_executable         *g:ale_javascript_jshint_executable*
                                           *b:ale_javascript_jshint_executable*
  Type: |String|
  Default: `'jshint'`

  ALE will first discover the jshint path in an ancestor node_modules
  directory. If no such path exists, this variable will be used instead.

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

  If you wish to use only a globally installed version of jshint, set
  |g:ale_javascript_jshint_use_global| to `1`.


g:ale_javascript_jshint_use_global         *g:ale_javascript_jshint_use_global*
                                           *b:ale_javascript_jshint_use_global*
  Type: |Number|
  Default: `0`

  This variable controls whether or not ALE will search for a local path for
  jshint first. If this variable is set to `1`, then ALE will always use the
  global version of jshint, in preference to locally installed versions of
  jshint in node_modules.


-------------------------------------------------------------------------------
standard                                              *ale-javascript-standard*

g:ale_javascript_standard_executable     *g:ale_javascript_standard_executable*
                                         *b:ale_javascript_standard_executable*
  Type: |String|
  Default: `'standard'`

  Same as the eslint option.

  See: |g:ale_javascript_eslint_executable|


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

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


g:ale_javascript_standard_use_global     *g:ale_javascript_standard_use_global*
                                         *b:ale_javascript_standard_use_global*
  Type: |Number|
  Default: `0`

  Same as the eslint option.

  See: |g:ale_javascript_eslint_use_global|


-------------------------------------------------------------------------------
xo                                                          *ale-javascript-xo*

g:ale_javascript_xo_executable                 *g:ale_javascript_xo_executable*
                                               *b:ale_javascript_xo_executable*
  Type: |String|
  Default: `'xo'`

  Same as the eslint option.

  See: |g:ale_javascript_eslint_executable|


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

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


g:ale_javascript_xo_use_global                 *g:ale_javascript_xo_use_global*
                                               *b:ale_javascript_xo_use_global*
  Type: |Number|
  Default: `0`

  Same as the eslint option.

  See: |g:ale_javascript_eslint_use_global|


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