lint rules for use with jest-dom.
You'll first need to install ESLint:
$ npm i eslint --save-dev
Next, install eslint-plugin-jest-dom
:
$ npm install eslint-plugin-jest-dom --save-dev
Note: If you installed ESLint globally (using the -g
flag) then you must also install eslint-plugin-jest-dom
globally.
Add jest-dom
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["jest-dom"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"jest-dom/prefer-required": "error",
"jest-dom/prefer-enabled-disabled": "error",
"jest-dom/prefer-checked": "error",
"jest-dom/prefer-to-have-attribute": "error",
}
}
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
config file:
{
"extends": ["plugin:jest-dom/recommended"]
}
βοΈ 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-required | βοΈ | π | prefer toBeRequired over checking properties |
prefer-to-have-attribute | βοΈ | π | prefer toHaveAttribute over checking getAttribute/hasAttribute |
Thanks goes to these wonderful people (emoji key):
Ben Monro π π» π‘ |
Nick McCurdy π» π |
Ernesto GarcΓa π |
Chris Colborne π» |
This project follows the all-contributors specification. Contributions of any kind welcome!