| 1 | # ESlint Configurations
|
| 2 | Standard configurations for [ESLint](https://eslint.org/).
|
| 3 |
|
| 4 | **Why?** — We use ESLint for quality control of our code. The standard ESLint configurations ensure that we use the same rules across all our projects.
|
| 5 |
|
| 6 | This package provides the following ESLint configurations:
|
| 7 | - [**config/eslint/default**](#default) — Default ESLint configuration;
|
| 8 | - [**config/eslint/jest**](#jest) — Extends `config/eslint/default`
|
| 9 | to work inside folders with Jest tests.
|
| 10 |
|
| 11 | To use them just create the following `.eslintrc` in your code:
|
| 12 | ```json
|
| 13 | {
|
| 14 | "extends": "./node_modules/topcoder-react-utils/config/eslint/default.json"
|
| 15 | }
|
| 16 | ```
|
| 17 | `.eslintrc` allows you to further modify ESLint configuration, but it is not recommended without a very good and special reason.
|
| 18 |
|
| 19 | ### Configuration Details
|
| 20 | - <a name="default">**`config/eslint/default`**</a>
|
| 21 |
|
| 22 | Under the hood it matches the standard
|
| 23 | [AirBnB ESLint](https://www.npmjs.com/package/eslint-config-airbnb) config,
|
| 24 | and just adds a few plugins to ensure that ESLint properly cooperates with
|
| 25 | Babel to understand JS and JSX constructs we use in our code.
|
| 26 |
|
| 27 | - <a name="jest">**`config/eslint/jest`**</a>
|
| 28 |
|
| 29 | Extends `config/eslint/default` to work well in the folders with Jest tests.
|
| 30 |
|
| 31 |
|
| 32 |
|
| 33 |
|