Skip to content

feat(no-disabled-tests): improve error message and simplify rule #1739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 29, 2025
Merged

feat(no-disabled-tests): improve error message and simplify rule #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions src/rules/__tests__/no-disabled-tests.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,83 +73,83 @@ ruleTester.run('no-disabled-tests', rule, {
invalid: [
{
code: 'describe.skip("foo", function () {})',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'describe.skip.each([1, 2, 3])("%s", (a, b) => {});',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xdescribe.each([1, 2, 3])("%s", (a, b) => {});',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'describe[`skip`]("foo", function () {})',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'describe["skip"]("foo", function () {})',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it.skip("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it["skip"]("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.skip("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it.skip.each``("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.skip.each``("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it.skip.each([])("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.skip.each([])("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test["skip"]("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xdescribe("foo", function () {})',
errors: [{ messageId: 'disabledSuite', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xit("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xtest("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xit.each``("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xtest.each``("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xit.each([])("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xtest.each([])("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it("has title but no callback")',
Expand All @@ -161,15 +161,15 @@ ruleTester.run('no-disabled-tests', rule, {
},
{
code: 'it("contains a call to pending", function () { pending() })',
errors: [{ messageId: 'pendingTest', column: 48, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 48, line: 1 }],
},
{
code: 'pending();',
errors: [{ messageId: 'pending', column: 1, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'describe("contains a call to pending", function () { pending() })',
errors: [{ messageId: 'pendingSuite', column: 54, line: 1 }],
errors: [{ messageId: 'skippedTest', column: 54, line: 1 }],
},
{
code: dedent`
Expand Down
41 changes: 3 additions & 38 deletions src/rules/no-disabled-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,13 @@ export default createRule({
},
messages: {
missingFunction: 'Test is missing function argument',
pending: 'Call to pending()',
pendingSuite: 'Call to pending() within test suite',
pendingTest: 'Call to pending() within test',
disabledSuite: 'Disabled test suite',
disabledTest: 'Disabled test',
skippedTest: 'Tests should not be skipped',
},
schema: [],
type: 'suggestion',
},
defaultOptions: [],
create(context) {
let suiteDepth = 0;
let testDepth = 0;

return {
CallExpression(node) {
const jestFnCall = parseJestFnCall(node, context);
Expand All @@ -36,13 +29,7 @@ export default createRule({
return;
}

if (jestFnCall.type === 'describe') {
suiteDepth++;
}

if (jestFnCall.type === 'test') {
testDepth++;

if (
node.arguments.length < 2 &&
jestFnCall.members.every(s => getAccessorValue(s) !== 'todo')
Expand All @@ -57,39 +44,17 @@ export default createRule({
jestFnCall.members.some(s => getAccessorValue(s) === 'skip')
) {
context.report({
messageId:
jestFnCall.type === 'describe' ? 'disabledSuite' : 'disabledTest',
messageId: 'skippedTest',
node,
});
}
},
'CallExpression:exit'(node) {
const jestFnCall = parseJestFnCall(node, context);

if (!jestFnCall) {
return;
}

if (jestFnCall.type === 'describe') {
suiteDepth--;
}

if (jestFnCall.type === 'test') {
testDepth--;
}
},
'CallExpression[callee.name="pending"]'(node) {
if (resolveScope(getScope(context, node), 'pending')) {
return;
}

if (testDepth > 0) {
context.report({ messageId: 'pendingTest', node });
} else if (suiteDepth > 0) {
context.report({ messageId: 'pendingSuite', node });
} else {
context.report({ messageId: 'pending', node });
}
context.report({ messageId: 'skippedTest', node });
},
};
},
Expand Down