LEFT | RIGHT |
(no file at all) | |
| 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 This command requires administrator privileges so you might need to use `sudo`. |
| 12 |
| 13 ## Usage |
| 14 |
| 15 To lint a JavaScript file using ESLint you run the `eslint` command with the |
| 16 file as an argument. For example: |
| 17 |
| 18 eslint some-file.js |
| 19 |
| 20 For advanced usage see `eslint --help`. |
| 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. |
LEFT | RIGHT |