Skip to content

Commit d09f87c

Browse files
committed
Readme tweaks
Closes #396
1 parent c55f962 commit d09f87c

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

readme.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -162,26 +162,26 @@ You can configure some options in XO by putting it in package.json:
162162

163163
### envs
164164

165-
Type: `Array`<br>
165+
Type: `string[]`<br>
166166
Default: `['node']`
167167

168168
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.
169169

170170
### globals
171171

172-
Type: `Array`
172+
Type: `string[]`
173173

174174
Additional global variables your code accesses during execution.
175175

176176
### ignores
177177

178-
Type: `Array`
178+
Type: `string[]`
179179

180180
Some [paths](lib/options-manager.js) are ignored by default, including paths in `.gitignore`. Additional ignores can be added here.
181181

182182
### space
183183

184-
Type: `boolean`, `number`<br>
184+
Type: `boolean | number`<br>
185185
Default: `false` *(tab indentation)*
186186

187187
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
190190

191191
### rules
192192

193-
Type: `Object`
193+
Type: `object`
194194

195195
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.
196196

@@ -199,7 +199,7 @@ Please take a moment to consider if you really need to use this option.
199199
### semicolon
200200

201201
Type: `boolean`<br>
202-
Default: `true` *(semicolons required)*
202+
Default: `true` *(Semicolons required)*
203203

204204
Set it to `false` to enforce no-semicolon style.
205205

@@ -223,33 +223,34 @@ If contradicting options are set for both Prettier and XO an error will be throw
223223

224224
### nodeVersion
225225

226-
Type: `string`, `boolean`<br>
226+
Type: `string | boolean`<br>
227227
Default: Value of the `engines.node` key in the project `package.json`
228228

229229
Enable rules specific to the Node.js versions within the configured range.
230+
230231
If set to `false`, no rules specific to a Node.js version will be enabled.
231232

232233
### plugins
233234

234-
Type: `Array`
235+
Type: `string[]`
235236

236237
Include third-party [plugins](https://eslint.org/docs/user-guide/configuring.html#configuring-plugins).
237238

238239
### extends
239240

240-
Type: `Array`, `string`
241+
Type: `string | string[]`
241242

242243
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).
243244

244245
### extensions
245246

246-
Type: `Array`
247+
Type: `string[]`
247248

248249
Allow more extensions to be linted besides `.js` and `.jsx`. Make sure they're supported by ESLint or an ESLint plugin.
249250

250251
### settings
251252

252-
Type: `Object`
253+
Type: `object`
253254

254255
[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.
255256

@@ -407,7 +408,6 @@ XO is based on ESLint. This project started out as just a shareable ESLint confi
407408

408409
## Support
409410

410-
- [Gitter chat](https://gitter.im/xojs/Lobby)
411411
- [Twitter](https://twitter.com/sindresorhus)
412412

413413

@@ -438,8 +438,3 @@ You can also find some nice dynamic XO badges on [badgen.net](https://badgen.net
438438

439439
- [James Talmage](https://github.com/jamestalmage)
440440
- [Michael Mayer](https://github.com/schnittstabil)
441-
442-
443-
## License
444-
445-
MIT

0 commit comments

Comments
 (0)