Need help with eslint-plugin-jest-dom?
Click the β€œchat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

testing-library
162 Stars 14 Forks MIT License 94 Commits 6 Opened issues

Description

eslint rules for use with jest-dom

Services available

!
?

Need anything else?

Contributors list

eslint-plugin-jest-dom

ESLint plugin to follow best practices and anticipate common mistakes when writing tests with jest-dom.


Build Status Code Coverage version downloads MIT License

All Contributors <!-- ALL-CONTRIBUTORS-BADGE:END --> PRs Welcome Code of Conduct <!-- prettier-ignore-end -->

Table of Contents

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's

devDependencies
:
npm install --save-dev eslint-plugin-jest-dom

This library has a required

peerDependencies
listing for [
eslint
][eslint]

Usage

Add

jest-dom
to the plugins section of your
.eslintrc.js
configuration file. You can omit the
eslint-plugin-
prefix:
module.exports = {
  plugins: ["jest-dom"],
  rules: {
    // your configuration
  },
};

Then configure the rules you want to use under the rules section.

module.exports = {
  rules: {
    "jest-dom/prefer-checked": "error",
    "jest-dom/prefer-enabled-disabled": "error",
    "jest-dom/prefer-required": "error",
    "jest-dom/prefer-to-have-attribute": "error",
  },
};

Recommended Configuration

This plugin exports a recommended configuration that enforces good

jest-dom
practices (you can find more info about enabled rules in Supported Rules section).

To enable this configuration use the

extends
property in your
.eslintrc.js
config file:
module.exports = {
  extends: "plugin:jest-dom/recommended",
  rules: {
    // your configuration
  },
};

Supported Rules

πŸ‘ indicates that a rule is recommended for all users.

πŸ”§ indicates that a rule is fixable.

| Name | πŸ‘ | πŸ”§ | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- | --------------------------------------------------------------------- | | prefer-checked | πŸ‘ | πŸ”§ | prefer toBeChecked over checking attributes | | prefer-empty | πŸ‘ | πŸ”§ | Prefer toBeEmpty over checking innerHTML | | prefer-enabled-disabled | πŸ‘ | πŸ”§ | prefer toBeDisabled or toBeEnabled over checking attributes | | prefer-focus | πŸ‘ | πŸ”§ | prefer toHaveFocus over checking document.activeElement | | prefer-in-document | πŸ‘ | πŸ”§ | Prefer .toBeInTheDocument() for asserting the existence of a DOM node | | prefer-required | πŸ‘ | πŸ”§ | prefer toBeRequired over checking properties | | prefer-to-have-attribute | πŸ‘ | πŸ”§ | prefer toHaveAttribute over checking getAttribute/hasAttribute | | prefer-to-have-class | πŸ‘ | πŸ”§ | prefer toHaveClass over checking element className | | prefer-to-have-style | πŸ‘ | πŸ”§ | prefer toHaveStyle over checking element style | | prefer-to-have-text-content | πŸ‘ | πŸ”§ | Prefer toHaveTextContent over checking element.textContent | | prefer-to-have-value | πŸ‘ | πŸ”§ | prefer toHaveValue over checking element.value |

Issues

Looking to contribute? Look for the Good First Issue label.

πŸ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

πŸ’‘ Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize what to work on.

See Feature Requests

Contributors ✨

Thanks goes to these people (emoji key):


Ben Monro

πŸ“– πŸ’» πŸ’‘ ⚠️

Nick McCurdy

πŸ’» πŸ“– ⚠️

Ernesto GarcΓ­a

πŸ“–

Chris Colborne

πŸ’» ⚠️

MichaΓ«l De Boey

πŸ’»

Gerrit Alex

πŸ’» ⚠️ πŸ“– πŸ›

Andrey Los

πŸ›

Spencer Miskoviak

πŸ’» ⚠️

Aleksei Tsikov

πŸ›

Mario BeltrΓ‘n AlarcΓ³n

πŸ“–

Ari PerkkiΓΆ

πŸ› πŸ’» ⚠️

Anton Niklasson

πŸ’» ⚠️ πŸ“–

Juzer Zarif

πŸ’» ⚠️ πŸ›

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

LICENSE

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.