no-debugging-utils.md

Disallow the use of debugging utilities (testing-library/no-debugging-utils)

Just like console.log statements pollutes the browser's output, debug statements also pollutes the tests if one of your teammates forgot to remove it. debug statements should be used when you actually want to debug your tests but should not be pushed to the codebase.

Rule Details

This rule supports disallowing the following debugging utilities:

• debug
• logTestingPlaygroundURL
• prettyDOM
• logRoles
• logDOM
• prettyFormat

By default, only debug and logTestingPlaygroundURL are disallowed.

Examples of incorrect code for this rule:

const { debug } = render(<Hello />);
debug();

const utils = render(<Hello />);
utils.debug();

import { screen } from '@testing-library/dom';
screen.debug();

const { screen } = require('@testing-library/react');
screen.debug();

You can control which debugging utils are checked for with the utilsToCheckFor option:

{
	"testing-library/no-debugging-utils": [
		"error",
		{
			"utilsToCheckFor": {
				"debug": false,
				"logRoles": true,
				"logDOM": true
			}
		}
	]
}

Further Reading

• debug API in React Testing Library
• screen.debug in Dom Testing Library