Eslint plugin for Jest
$ yarn add --dev eslint eslint-plugin-jest
Note: If you installed ESLint globally then you must also install eslint-plugin-jest
globally.
Add jest
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"jest"
]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"jest/no-disabled-tests": "warn",
"jest/no-focused-tests": "error",
"jest/no-identical-title": "error",
"jest/valid-expect": "error"
}
}
You can also whitelist the environment variables provided by Jest by doing:
{
"env": {
"jest/globals": true
}
}
- no-disabled-tests - disallow disabled tests.
- no-focused-tests - disallow focused tests.
- no-identical-title - disallow identical titles.
- valid-expect - ensure expect is called correctly.
This plugin exports a recommended configuration that enforces good testing practices.
To enable this configuration use the extends
property in your .eslintrc
config file:
{
"extends": ["plugin:jest/recommended"]
}
See ESLint documentation for more information about extending configuration files.
The rules enabled in this configuration are: