eslint-plugin-testing-library

ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library

---

Installation

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.

Usage

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"
  }
}

Shareable configurations

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.

DOM Testing Library

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"]
}

Angular

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"]
}

React

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"]
}

Vue

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"]
}

Supported Rules

Rule	Description	Configurations	Fixable
await-async-query	Enforce async queries to have proper await
await-async-utils	Enforce async utils to be awaited properly
await-fire-event	Enforce async fire event methods to be awaited
consistent-data-testid	Ensure data-testid values match a provided regex.
no-await-sync-query	Disallow unnecessary await for sync queries
no-container	Disallow the use of container methods
no-debug	Disallow the use of debug
no-dom-import	Disallow importing from DOM Testing Library
no-manual-cleanup	Disallow the use of cleanup
no-multiple-assertions-wait-for	Disallow the use of multiple expect inside waitFor
no-promise-in-fire-event	Disallow the use of promises passed to a fireEvent method
no-side-effects-wait-for	Disallow the use of side effects inside waitFor
no-wait-for-empty-callback	Disallow empty callbacks for waitFor and waitForElementToBeRemoved
prefer-explicit-assert	Suggest using explicit assertions rather than just getBy* queries
prefer-find-by	Suggest using findBy* methods instead of the waitFor + getBy queries
prefer-presence-queries	Enforce specific queries when checking element is present or not
prefer-screen-queries	Suggest using screen while using queries
prefer-wait-for	Use waitFor instead of deprecated wait methods

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Mario Beltrán Alarcón 💻 📖 👀 ⚠️ 🚇 🐛	Thomas Lombart 💻 📖 👀 ⚠️ 🚇	Ben Monro 💻 📖 ⚠️	Nicola Molinari 💻 ⚠️ 📖 👀	Aarón García Hervás 📖	Matej Šnuderl 🤔 📖	Adrià Fontcuberta 💻 ⚠️
Jon Aldinger 📖	Thomas Knickman 💻 📖 ⚠️	Kevin Sullivan 📖	Jakub Jastrzębski 💻 📖 ⚠️	Nikolay Stoynov 📖	marudor 💻 ⚠️	Tim Deschryver 💻 📖 🤔 👀 ⚠️ 🐛 🚇 📦
Tobias Deekens 🐛	Victor Cordova 💻 ⚠️ 🐛	Dmitry Lobanov 💻 ⚠️	Kent C. Dodds 🐛	Gonzalo D'Elia 💻 ⚠️ 📖 👀	Jeff Rifwald 📖	Leandro Lourenci 🐛 💻 ⚠️
Miguel Erja González 🐛	Pavel Pustovalov 🐛	Jacob Parish 🐛 💻 ⚠️	Nick McCurdy 🤔 💻 👀	Stefan Cameron 🐛	Mateus Felix 💻 ⚠️ 📖	Renato Augusto Gama dos Santos 🤔 💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!