eslint-plugin-testing-library

ESLint plugin for 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 a recommended configuration that enforces good Testing Library practices (you can find more info about enabled rules in Supported Rules section within Recommended column).

To enable this configuration use the extends property in your .eslintrc config file:

{ "extends": ["plugin:testing-library/recommended"] }

Starting from the premise that DOM Testing Library is the base for the rest of Testing Library frameworks wrappers, this plugin also exports different configuration for those frameworks that enforces good practices for specific rules that only apply to them (you can find more info about enabled rules in Supported Rules section within Frameworks column).

Note that frameworks configurations enable their specific rules + recommended rules.

Available frameworks configurations are:

To enable this configuration use the extends property in your .eslintrc config file:

{ "extends": ["plugin:testing-library/angular"] }

To enable this configuration use the extends property in your .eslintrc config file:

{ "extends": ["plugin:testing-library/react"] }

To enable this configuration use the extends property in your .eslintrc config file:

{ "extends": ["plugin:testing-library/vue"] }

Rule	Description	Recommended	Frameworks	Fixable
await-async-query	Enforce async queries to have proper await
no-await-sync-query	Disallow unnecessary await for sync queries
no-debug	Disallow the use of debug
no-dom-import	Disallow importing from DOM Testing Library