Left: | ||
Right: |
OLD | NEW |
---|---|
(Empty) | |
1 # eslint-config-eyeo | |
2 | |
3 An [ESLint](http://eslint.org) configuration that checks for compliance with the | |
4 [Adblock Plus coding style guide](https://adblockplus.org/coding-style#javascrip t) | |
5 which is used for all eyeo projects. | |
6 | |
7 ## Installation | |
8 | |
9 npm install -g eslint eslint-config-eyeo | |
10 | |
11 (As root, or using sudo.) | |
Wladimir Palant
2017/02/14 12:43:20
Nit: I'm not a big fan of having an entire sentenc
kzar
2017/02/15 05:24:22
(Done.)
| |
12 | |
13 ## Usage | |
14 | |
15 To lint a JavaScript file using ESLint you simply run the `eslint` command with | |
Wladimir Palant
2017/02/14 12:43:20
Nit: Please avoid using the word "simply" in instr
kzar
2017/02/15 05:24:22
Good point, Done.
| |
16 the file as an argument. For example: | |
17 | |
18 eslint some-file.js | |
19 | |
20 (For advanced usage see `eslint --help`.) | |
Wladimir Palant
2017/02/14 12:43:20
Nit: Parentheses are unnecessary here.
kzar
2017/02/15 05:24:22
Done.
| |
21 | |
22 In order to use eslint-config-eyeo your project's ESLint configuration | |
23 should extend from it. A minimal example looks like this: | |
24 | |
25 { | |
26 "extends": "eslint-config-eyeo", | |
27 "root": true | |
28 } | |
29 | |
30 (For projects without an ESLint configuration you can create your own | |
31 personal configuration in `~/.eslintrc.json`, but take care to remove | |
32 the `"root": true` section from the above example.) | |
Wladimir Palant
2017/02/14 12:43:20
Nit: Parentheses are unnecessary here.
kzar
2017/02/15 05:24:22
Done.
| |
OLD | NEW |