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 ## Usage | |
12 | |
13 To lint a JavaScript file using ESLint you run the `eslint` command with the | |
14 file as an argument. For example: | |
15 | |
16 eslint some-file.js | |
17 | |
18 For advanced usage see `eslint --help`. | |
19 | |
20 In order to use eslint-config-eyeo your project's ESLint configuration | |
21 should extend from it. A minimal example looks like this: | |
22 | |
23 { | |
24 "extends": "eslint-config-eyeo", | |
25 "root": true | |
26 } | |
27 | |
28 For projects without an ESLint configuration you can create your own | |
29 personal configuration in `~/.eslintrc.json`, but take care to remove | |
30 the `"root": true` section from the above example. | |
OLD | NEW |