| 1 | # Coorpacademy ESLint plugin
|
| 2 |
|
| 3 | [](https://github.com/CoorpAcademy/eslint-plugin-coorpacademy)
|
| 4 | [](https://travis-ci.com/CoorpAcademy/eslint-plugin-coorpacademy)
|
| 5 |
|
| 6 | CoorpAcademy's ESLint rules and configs.
|
| 7 |
|
| 8 | ## Installation
|
| 9 |
|
| 10 | ```console
|
| 11 | npm install --save-dev eslint @coorpacademy/eslint-plugin-coorpacademy
|
| 12 | ```
|
| 13 |
|
| 14 | ## Usage
|
| 15 |
|
| 16 | This package provides multiple configuration for different purposes, that you can apply together in you project as needed. To use them, set the `extends` key of your `.eslintrc` file and add `@coorpacademy/coorpacademy` to your list of plugins.
|
| 17 |
|
| 18 | ```json
|
| 19 | {
|
| 20 | "extends": [
|
| 21 | "plugin:@coorpacademy/coorpacademy/core",
|
| 22 | "plugin:@coorpacademy/coorpacademy/mocha",
|
| 23 | "plugin:@coorpacademy/coorpacademy/ava",
|
| 24 | "..."
|
| 25 | ],
|
| 26 | "plugins": [
|
| 27 | "@coorpacademy/coorpacademy"
|
| 28 | ]
|
| 29 | }
|
| 30 | ```
|
| 31 |
|
| 32 | Available rule sets are:
|
| 33 | - [ava](./config/ava.js): Rules for when using AVA
|
| 34 | - [core](./config/core.js): Shared ESLint rules
|
| 35 | - [es20XX](./config/es20XX.js): Rules for when using ES2015+ syntax
|
| 36 | - [flowtype](./config/flowtype.js): Rules for when using Flowtype
|
| 37 | - [lodash-fp](./config/lodash-fp.js): Rules for when using Lodash's FP flavor
|
| 38 | - [mocha](./config/mocha.js): Rules for when using Mocha
|
| 39 | - [prettier](./config/prettier.js): Disables all stylistic rules but adds source code auto-formatting.
|
| 40 | - [react](./config/react.js): Rules for when using React
|