Necessarily Precedes Mischief

    eslint-plugin-testing-library

    3.9.0 • Public • Published

    eslint-plugin-testing-library

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


    Build status Package version MIT License
    semantic-release PRs Welcome
    Watch on Github Star on Github Tweet

    All Contributors

    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

    Recommended

    This plugin exports a recommended configuration that enforces good Testing Library practices (you can find more info about enabled rules in the Supported Rules section within the Configurations column).

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

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

    Frameworks

    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 the Supported Rules section within the Configurations column).

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

    Available frameworks configurations are:

    Angular

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

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

    React

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

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

    Vue

    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 recommended-badge angular-badge react-badge vue-badge
    await-async-utils Enforce async utils to be awaited properly recommended-badge angular-badge react-badge vue-badge
    await-fire-event Enforce async fire event methods to be awaited vue-badge
    consistent-data-testid Ensure data-testid values match a provided regex.
    no-await-sync-query Disallow unnecessary await for sync queries recommended-badge angular-badge react-badge vue-badge
    no-debug Disallow the use of debug angular-badge react-badge vue-badge
    no-dom-import Disallow importing from DOM Testing Library angular-badge react-badge vue-badge fixable-badge
    no-manual-cleanup Disallow the use of cleanup
    no-render-in-setup Disallow the use of render in setup functions
    no-wait-for-empty-callback Disallow empty callbacks for waitFor and waitForElementToBeRemoved
    no-wait-for-snapshot Ensures no snapshot is generated inside of a waitFor call
    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 recommended-badge angular-badge react-badge vue-badge fixable-badge
    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 fixable-badge

    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

    🤔 💻 📖 ⚠️

    Josh Kelly

    💻

    Alessia Bellisario

    💻 ⚠️ 📖

    Spencer Miskoviak

    💻 ⚠️ 📖 🤔

    Giorgio Polvara

    💻 ⚠️ 📖

    Josh David

    📖

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

    Install

    npm i eslint-plugin-testing-library@3.9.0

    Version

    3.9.0

    License

    MIT

    Unpacked Size

    110 kB

    Total Files

    22

    Last publish

    Collaborators

    • belco
    • testing-library-bot
    • eslint-plugin-testing-library-bot