Bond Sports ESLint configs
A collection of ESlint configs for various frameworks and environments.
Available Configs
- ts-base: base configurations for typescript.
- react: rules for react (extends react-app).
- jest: rules for jest.
Installation
$ npm install --save-dev eslint @bondsports/eslint-config
or
$ yarn add --dev eslint @bondsports/eslint-config
Usage
Add the configs you want to the extend section of your eslintConfig
of your package.json
, or to your .eslintrc
configuration file.
Note: make sure to add ts-base
last.
"eslintConfig": {
"extends": [
"@bondsports/eslint-config/react",
"@bondsports/eslint-config/ts-base"
]
}
Then add the path to your TypeScript configuration file to the parserOptions
"eslintConfig": {
"parserOptions": {
"project": "./path/to/your/tsconfig.json"
}
}
Adding new Configs
Add a new file and name it as you would like. Inside export the ESLint configuration.
module.exports = {
extends: ['plugin:jest/recommended', 'plugin:jest/style'],
plugins: ['jest'],
env: {
'jest/globals': true,
},
};
after you finished developing the config, make sure it works by using the --print-config
flag of ESLint, in the project you use for testing.
$ npx eslint --print-config index.ts
Dont forget adding the config to this readme
Issues
If any linting error is appearing twice, or you have any other problem, please open an issue with all the details you have.