Basic ESLint rules used by Bonnier News. The configuration works both with CommonJS and ES6 modules,
and the appropriate setup will be used by looking at the projects package.json
type property.
For Node versions that support it (version 16 and above), the es2022
environment will also be activated. Otherwise es2021
will be used.
Install eslint
and @bonniernews/eslint-config
:
npm install --save-dev eslint @bonniernews/eslint-config
To activate the config, you need to add the following to your .eslintrc.json
-file:
{
"root": true,
"extends": [ "@bonniernews" ]
}
To activate the config, you need to add the following to your .eslintrc.json
-file:
{
"root": true,
"extends": [ "@bonniernews/eslint-config/react" ]
}
This will enable the react plugin for *.jsx
-files.
To activate the config, you need to add the following to your .eslintrc.json
-file:
{
"root": true,
"extends": [ "@bonniernews/eslint-config/typescript" ]
}
This will enable the typescript plugin for *.ts
-files.
To activate the config, you need to add the following to your .eslintrc.json
-file:
{
"root": true,
"extends": [ "@bonniernews/eslint-config/typescript-react" ]
}
This will enable the typescript and react plugin for *.tsx
-files.
You can also choose to use the test config, which is adapted to testing using mocha
, mocha-cakes-2
and chai
. To also enable this,
either add a separate test configuration file extending from "@bonniernews/eslint-config/test"
, or use the "@bonniernews/eslint-config/all"
in your root configuration to activate everything together:
{
"root": true,
"extends": [ "@bonniernews/eslint-config/all" ]
}
This will activate the test configuration for all files inside directories named test
or tests
.
Run with:
npx eslint .
- We advice to remove any
husky
hooks that uses libraries such aspretty-quick
from yourpackage.json
- Subsequently remove any use of
pretty-quick
if possible. - Remove any previous use of sharable ESLint configs from
package.json
, i.e.:eslint-config-airbnb
eslint-config-google
eslint-config-prettier
- Remove
eslint-plugin-prettier
frompackage.json
- If you get errors similar to the ones below, please update the
eslint
dependancy.- Definition for rule 'no-nonoctal-decimal-escape' was not found
- Definition for rule 'no-unsafe-optional-chaining' was not found
- If you still have issues; try updating
npm
(if you use nvmnvm install-latest-npm
) &prettier
as-well - Remove any 'eslint-disable-line no-unused-expressions' directives added because of chai assertions, they are not
needed anymore (
eslint-plugin-chai-friendly
is used in test). - Remove any globals and special rules related to
mocha-cakes-2
in your test configuration, they already exist in the@bonniernews/eslint-config/test
and@bonniernews/eslint-config/all
configs.
Once you complete the steps above run the following:
npx eslint . --fix
If you want to use Prettier, run it before eslint. ESLint should be the final judge, i.e. run:
npx prettier --save .
npx eslint . --fix
This will format the entire code base according to the rules of Prettier and the config.
Can be found here.
Released under the MIT license.