webhook/node_modules/eslint-plugin-jest/docs/rules/no-test-prefixes.md
2022-11-10 20:43:16 +10:00

1.2 KiB

Require using .only and .skip over f and x (no-test-prefixes)

💼 This rule is enabled in the recommended config.

🔧 This rule is automatically fixable by the --fix CLI option.

Jest allows you to choose how you want to define focused and skipped tests, with multiple permutations for each:

  • only & skip: it.only, test.only, describe.only, it.skip, test.skip, describe.skip.
  • 'f' & 'x': fit, fdescribe, xit, xtest, xdescribe.

This rule enforces usages from the only & skip list.

Rule details

This rule triggers a warning if you use one of the keywords from the 'f' & 'x' list to focus/skip a test.

/*eslint jest/no-test-prefixes: "error"*/

it.only('foo'); // valid
test.only('foo'); // valid
describe.only('foo'); // valid
it.skip('foo'); // valid
test.skip('foo'); // valid
describe.skip('foo'); // valid

fit('foo'); // invalid
fdescribe('foo'); // invalid
xit('foo'); // invalid
xtest('foo'); // invalid
xdescribe('foo'); // invalid