| 1 | # eslint-plugin-github
|
| 2 |
|
| 3 | ## Installation
|
| 4 |
|
| 5 | ```sh
|
| 6 | $ npm install --save-dev eslint
|
| 7 | $ npm install --save-dev eslint-plugin-github
|
| 8 | ```
|
| 9 |
|
| 10 | Run initialization wizard.
|
| 11 |
|
| 12 | ```sh
|
| 13 | $ node_modules/.bin/eslint-github-init
|
| 14 | ```
|
| 15 |
|
| 16 | Set up `npm run lint` script.
|
| 17 |
|
| 18 | ```json
|
| 19 | {
|
| 20 | "private": true,
|
| 21 | "scripts": {
|
| 22 | "lint": "github-lint"
|
| 23 | }
|
| 24 | }
|
| 25 | ```
|
| 26 |
|
| 27 | The `github-lint` command will run `eslint`, `flow` and flow coverage checking depending on your project configuration.
|