no-disabled-tests
)Jest has a feature that allows you to temporarily mark tests as disabled. This feature is often helpful while debugging or to create placeholders for future tests. Before committing changes we may want to check that all tests are running.
This rule raises a warning about disabled tests.
There are a number of ways to disable tests in Jest:
.skip
to the test-suite or test-casex
pending()
anywhere within the testThe following patterns are considered warnings:
describe.skip('foo', () => {});
it.skip('foo', () => {});
test.skip('foo', () => {});
describe['skip']('bar', () => {});
it['skip']('bar', () => {});
test['skip']('bar', () => {});
xdescribe('foo', () => {});
xit('foo', () => {});
xtest('foo', () => {});
it('bar');
test('bar');
it('foo', () => {
pending();
});
These patterns would not be considered warnings:
describe('foo', () => {});
it('foo', () => {});
test('foo', () => {});
describe.only('bar', () => {});
it.only('bar', () => {});
test.only('bar', () => {});
The plugin looks at the literal function names within test code, so will not catch more complex examples of disabled tests, such as:
const testSkip = test.skip;
testSkip('skipped test', () => {});
const myTest = test;
myTest('does not have function body');