• Stars
    star
    360
  • Rank 118,230 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 5 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

eslint rules for use with jest-dom

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 PRs Welcome Code of Conduct

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.

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

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

๐Ÿ’ผ Configurations enabled in.
โœ… Set in the recommended configuration.
๐Ÿ”ง Automatically fixable by the --fix CLI option.
๐Ÿ’ก Manually fixable by editor suggestions.

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

๐Ÿ’ป โš ๏ธ ๐Ÿ›

Julien Wajsberg

๐Ÿ’ป โš ๏ธ

Gareth Jones

โš ๏ธ ๐Ÿ’ป ๐Ÿ›

Huyen Nguyen

๐Ÿ“–

Matthew

๐Ÿ› ๐Ÿ’ป

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

LICENSE

MIT

More Repositories

1

react-testing-library

๐Ÿ Simple and complete React DOM testing utilities that encourage good testing practices.
JavaScript
18,952
star
2

react-hooks-testing-library

๐Ÿ Simple and complete React hooks testing utilities that encourage good testing practices.
TypeScript
5,083
star
3

jest-dom

๐Ÿฆ‰ Custom jest matchers to test the state of the DOM
JavaScript
4,422
star
4

dom-testing-library

๐Ÿ™ Simple and complete DOM testing utilities that encourage good testing practices.
JavaScript
3,271
star
5

user-event

๐Ÿ• Simulate user events
TypeScript
2,181
star
6

cypress-testing-library

๐Ÿ… Simple and complete custom Cypress commands and utilities that encourage good testing practices.
JavaScript
1,798
star
7

vue-testing-library

๐ŸฆŽ Simple and complete Vue.js testing utilities that encourage good testing practices.
JavaScript
1,071
star
8

eslint-plugin-testing-library

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

testing-playground

Simple and complete DOM testing playground that encourage good testing practices.
JavaScript
776
star
10

angular-testing-library

๐Ÿฆ” Simple and complete Angular testing utilities that encourage good testing practices
TypeScript
626
star
11

svelte-testing-library

๐Ÿฟ๏ธ Simple and complete Svelte DOM testing utilities that encourage good testing practices
JavaScript
615
star
12

native-testing-library

๐Ÿณ Simple and complete React Native testing utilities that encourage good testing practices.
JavaScript
515
star
13

testing-library-docs

docs site for @testing-library/*
JavaScript
449
star
14

jest-native

๐Ÿฆ… Custom jest matchers to test the state of React Native
TypeScript
436
star
15

pptr-testing-library

puppeteer + dom-testing-library = ๐Ÿ’–
TypeScript
283
star
16

playwright-testing-library

๐Ÿ” Find elements in Playwright with queries from Testing Library
TypeScript
248
star
17

testing-library-recorder-extension

Testing Library Extension for Chrome DevTools Recorder
TypeScript
144
star
18

preact-testing-library

Simple and complete Preact DOM testing utilities that encourage good testing practices.
JavaScript
139
star
19

which-query

๐Ÿฆฉ Which query should I use?
CSS
124
star
20

testcafe-testing-library

๐Ÿ‚ Simple and complete custom Selectors for Testcafe that encourage good testing practices.
TypeScript
71
star
21

preact-hooks-testing-library

Simple and complete Preact hooks testing utilities that encourage good testing practices.
TypeScript
56
star
22

jasmine-dom

๐Ÿฆฅ Custom Jasmine matchers to test the state of the DOM
JavaScript
45
star
23

nightwatch-testing-library

๐Ÿฆ‡Simple and complete custom queries for Nightwatch that encourage good testing practices.
JavaScript
31
star
24

dom-testing-library-template

Template repository for bug reports to @testing-library/dom, @testing-library/react, and @testing-library/jest-dom
JavaScript
17
star
25

webdriverio-testing-library

๐Ÿ•ท๏ธ Simple and complete WebdriverIO DOM testing utilities that encourage good testing practices.
TypeScript
16
star
26

native-testing-library-docs

๐Ÿณ Docs site for native-testing-library
JavaScript
16
star
27

react-testing-library-help

Fork this repo to reproduce your issue
HTML
12
star
28

web-testing-library

๐Ÿ™ Experimental Web testing utilities that encourage good testing practices.
JavaScript
3
star