ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library
You'll first need to install ESLint:
$ npm i eslint --save-dev
Next, install eslint-plugin-testing-library:
$ npm install eslint-plugin-testing-library --save-dev
Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-testing-library globally.
Add testing-library to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
"plugins": ["testing-library"]
}Then configure the rules you want to use under the rules section.
{
"rules": {
"testing-library/await-async-query": "error",
"testing-library/no-await-sync-query": "error",
"testing-library/no-debug": "warn"
}
}This plugin exports several recommended configurations that enforce good practices for specific Testing Library packages.
You can find more info about enabled rules in the Supported Rules section within the Configurations column.
Enforces recommended rules for DOM Testing Library.
To enable this configuration use the extends property in your
.eslintrc config file:
{
"extends": ["plugin:testing-library/dom"]
}Enforces recommended rules for Angular Testing Library.
To enable this configuration use the extends property in your
.eslintrc config file:
{
"extends": ["plugin:testing-library/angular"]
}Enforces recommended rules for React Testing Library.
To enable this configuration use the extends property in your
.eslintrc config file:
{
"extends": ["plugin:testing-library/react"]
}Enforces recommended rules for Vue Testing Library.
To enable this configuration use the extends property in your
.eslintrc config file:
{
"extends": ["plugin:testing-library/vue"]
}| Rule | Description | Configurations | Fixable |
|---|---|---|---|
| testing-library/await-async-query | Enforce promises from async queries to be handled |     |
|
| testing-library/await-async-utils | Enforce async utils to be awaited properly | |
|
| testing-library/await-fire-event | Enforce promises from fire event methods to be handled | |
|
| testing-library/consistent-data-testid | Ensure data-testid values match a provided regex. |
||
| testing-library/no-await-sync-events | Disallow unnecessary await for sync events |
||
| testing-library/no-await-sync-query | Disallow unnecessary await for sync queries |
|
|
| testing-library/no-container | Disallow the use of container methods |
|
|
| testing-library/no-debug | Disallow the use of debug |
|
|
| testing-library/no-dom-import | Disallow importing from DOM Testing Library | |
 |
| testing-library/no-manual-cleanup | Disallow the use of cleanup |
||
| testing-library/no-node-access | Disallow direct Node access | |
|
| testing-library/no-promise-in-fire-event | Disallow the use of promises passed to a fireEvent method |
||
| testing-library/no-render-in-setup | Disallow the use of render in setup functions |
||
| testing-library/no-wait-for-empty-callback | Disallow empty callbacks for waitFor and waitForElementToBeRemoved |
|
|
| testing-library/no-wait-for-multiple-assertions | Disallow the use of multiple expect inside waitFor |
||
| testing-library/no-wait-for-side-effects | Disallow the use of side effects inside waitFor |
||
| testing-library/no-wait-for-snapshot | Ensures no snapshot is generated inside of a waitFor call |
||
| testing-library/prefer-explicit-assert | Suggest using explicit assertions rather than just getBy* queries |
||
| testing-library/prefer-find-by | Suggest using findBy* methods instead of the waitFor + getBy queries |
|
|
| testing-library/prefer-presence-queries | Enforce specific queries when checking element is present or not | ||
| testing-library/prefer-user-event | Suggest using userEvent library instead of fireEvent for simulating user interaction |
|
|
| testing-library/prefer-screen-queries | Suggest using screen while using queries | |
|
| testing-library/prefer-wait-for | Use waitFor instead of deprecated wait methods |
|
|
| testing-library/render-result-naming-convention | Enforce a valid naming for return value from render |
|
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!