eslint-config-revolut-react
v1.1.4
Published
Revolut eslint config for react web applications
Downloads
1,264
Readme
#eslint-config-revolut-react
Note that this config already included in @revolut/cra-overrides
so if you're using yarn v1
and not npm
you should be good to go from the version >=1.0.0
Before installation make your .eslintrc.json
, .eslintrc
into .eslintrc.js
and paste that in
require('eslint-config-revolut-react/patch')
module.exports = {
extends: ['revolut-react'],
}
What is this patch? Read here.
Standalone installation (if you're not using @revolut/cra-overrides)
Add these dependencies to the package.json
with constraints below. Although, try to avoid major bumps.
"eslint": ">=7.3.1",
"eslint-config-revolut-react": ">=1.0.1"
"prettier": ">=2.0.5"
You can search and replace >=
symbol with ^
:)
If you're using @revolut/cra-overrides
Having @revolut/cra-overrides
should be sufficient. Version 1.0.0
and onward.
Don't forget to bump prettier
so you have >2
Further migration guide (for users of 0.x.x
or @revolut/[email protected]
or any version of revolut-react-scripts
)
yarn, npm
@revolut/cra-overrides
users
- Bump
@revolut/cra-overrides
to version1.0.0
or higher - Add
SKIP_PREFLIGHT_CHECK=true
as ESLint will be bumped above version 6 up to>=7.3.1
and CRA will complain (this is temporary until CRA updated) - Add
resolutions
to enforce particular versions of the eslint plugins, parsers etc. (this is temporary until CRA updated)
{
"resolutions": {
"eslint": "7.3.1" // Whatever is the latest 7
}
}
Standalone or pnpm
users (yes, even if you're using @revolut/cra-overrides
with pnpm
)
You can check this PR for full example
- Remove all eslint related stuff from
package.json
- Copy paste these instead of them. (update to the latest on the day of reading that)
{
"devDependencies": {
"eslint": "7.3.1",
"eslint-config-revolut-react": "1.0.1",
"prettier": "2.0.5"
}
}
Common steps
- Run
npx eslint ./src --ext js,jsx,ts,tsx --fix --rule 'jest-dom/prefer-to-have-attribute: off' --rule 'jest-dom/prefer-to-have-text-content: off' --rule 'jest-dom/prefer-empty: off' --rule 'jest-dom/prefer-enabled-disabled: off' --rule 'jest-dom/prefer-enabled-disabled: off' --rule 'jest-dom/prefer-checked: off' --rule 'testing-library/prefer-find-by: off' --rule 'jest-dom/prefer-focus: off'
- Change your
eslint /src --ext js,jsx,ts,tsx --max-warnings 0
toeslint /src --ext js,jsx,ts,tsx
. - Make sure your
lint-staged
setup tho still have zero tolerance to warnings, to foster gradual adoption of new rules. - Ensure no errors left, only warnings.
- If there is a few simple errors fix them straight away. If there is a lot of them, make them warnings and create a task in JIRA to clean them up later.
Warning
jest-dom
and testing-library
plugins rarely have some false positives. Also, their fixes are destructive sometimes. (all bugs mostly reported)
You can and should apply auto-fixes file by file, it helps A LOT, but never on whole codebase as it will lead to broken tests
and a lot of unused variables etc. (if rules auto-fixes are still not fixed, if they are fixed, please contribute to this README!)