You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+12-17Lines changed: 12 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -162,26 +162,26 @@ You can configure some options in XO by putting it in package.json:
162
162
163
163
### envs
164
164
165
-
Type: `Array`<br>
165
+
Type: `string[]`<br>
166
166
Default: `['node']`
167
167
168
168
Which [environments](https://eslint.org/docs/user-guide/configuring#specifying-environments) your code is designed to run in. Each environment brings with it a certain set of predefined global variables.
169
169
170
170
### globals
171
171
172
-
Type: `Array`
172
+
Type: `string[]`
173
173
174
174
Additional global variables your code accesses during execution.
175
175
176
176
### ignores
177
177
178
-
Type: `Array`
178
+
Type: `string[]`
179
179
180
180
Some [paths](lib/options-manager.js) are ignored by default, including paths in `.gitignore`. Additional ignores can be added here.
181
181
182
182
### space
183
183
184
-
Type: `boolean`, `number`<br>
184
+
Type: `boolean | number`<br>
185
185
Default: `false`*(tab indentation)*
186
186
187
187
Set it to `true` to get 2-space indentation or specify the number of spaces.
@@ -190,7 +190,7 @@ This option exists for pragmatic reasons, but I would strongly recommend you rea
190
190
191
191
### rules
192
192
193
-
Type: `Object`
193
+
Type: `object`
194
194
195
195
Override any of the [default rules](https://github.com/xojs/eslint-config-xo/blob/master/index.js). See the [ESLint docs](https://eslint.org/docs/rules/) for more info on each rule.
196
196
@@ -199,7 +199,7 @@ Please take a moment to consider if you really need to use this option.
199
199
### semicolon
200
200
201
201
Type: `boolean`<br>
202
-
Default: `true`*(semicolons required)*
202
+
Default: `true`*(Semicolons required)*
203
203
204
204
Set it to `false` to enforce no-semicolon style.
205
205
@@ -223,33 +223,34 @@ If contradicting options are set for both Prettier and XO an error will be throw
223
223
224
224
### nodeVersion
225
225
226
-
Type: `string`, `boolean`<br>
226
+
Type: `string | boolean`<br>
227
227
Default: Value of the `engines.node` key in the project `package.json`
228
228
229
229
Enable rules specific to the Node.js versions within the configured range.
230
+
230
231
If set to `false`, no rules specific to a Node.js version will be enabled.
231
232
232
233
### plugins
233
234
234
-
Type: `Array`
235
+
Type: `string[]`
235
236
236
237
Include third-party [plugins](https://eslint.org/docs/user-guide/configuring.html#configuring-plugins).
237
238
238
239
### extends
239
240
240
-
Type: `Array`, `string`
241
+
Type: `string | string[]`
241
242
242
243
Use one or more [shareable configs](https://eslint.org/docs/developer-guide/shareable-configs.html) or [plugin configs](https://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin) to override any of the default rules (like `rules` above).
243
244
244
245
### extensions
245
246
246
-
Type: `Array`
247
+
Type: `string[]`
247
248
248
249
Allow more extensions to be linted besides `.js` and `.jsx`. Make sure they're supported by ESLint or an ESLint plugin.
249
250
250
251
### settings
251
252
252
-
Type: `Object`
253
+
Type: `object`
253
254
254
255
[Shared ESLint settings](https://eslint.org/docs/user-guide/configuring#adding-shared-settings) exposed to rules. For example, to configure the [`import`](https://github.com/benmosher/eslint-plugin-import#settings) plugin to use your webpack configuration for determining search paths, you can put `{"import/resolver": "webpack"}` here.
255
256
@@ -407,7 +408,6 @@ XO is based on ESLint. This project started out as just a shareable ESLint confi
407
408
408
409
## Support
409
410
410
-
-[Gitter chat](https://gitter.im/xojs/Lobby)
411
411
-[Twitter](https://twitter.com/sindresorhus)
412
412
413
413
@@ -438,8 +438,3 @@ You can also find some nice dynamic XO badges on [badgen.net](https://badgen.net
0 commit comments