Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: jest-community/eslint-plugin-jest
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v24.1.10
Choose a base ref
...
head repository: jest-community/eslint-plugin-jest
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v24.2.0
Choose a head ref
  • 2 commits
  • 5 files changed
  • 2 contributors

Commits on Mar 9, 2021

  1. feat(no-focused-tests): make fixable (#787)

    @alagane
    alagane authored Mar 9, 2021
    Copy the full SHA
    040871a View commit details

  2. chore(release): 24.2.0 [skip ci] 

    # [24.2.0](v24.1.10...v24.2.0) (2021-03-09)

### Features

* **no-focused-tests:** make fixable ([#787](#787)) ([040871a](040871a))
    @semantic-release-bot
    semantic-release-bot committed Mar 9, 2021

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    GPG key ID: B5690EEEBB952194
    Verified
    Learn about vigilant mode
    Copy the full SHA
    d51e93b View commit details
Showing with 331 additions and 30 deletions.
  1. +7 −0 CHANGELOG.md
  2. +1 −1 README.md
  3. +1 −1 package.json
  4. +247 −19 src/rules/__tests__/no-focused-tests.test.ts
  5. +75 −9 src/rules/no-focused-tests.ts
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# [24.2.0](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.10...v24.2.0) (2021-03-09)


### Features

* **no-focused-tests:** make fixable ([#787](https://github.com/jest-community/eslint-plugin-jest/issues/787)) ([040871a](https://github.com/jest-community/eslint-plugin-jest/commit/040871a866b7803e5c48b40715d48437d3906b0f))

## [24.1.10](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.9...v24.1.10) (2021-03-09)


2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -143,7 +143,7 @@ installations requiring long-term consistency.
| [no-done-callback](docs/rules/no-done-callback.md) | Avoid using a callback in asynchronous tests and hooks | ![recommended][] | ![suggest][] |
| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | Disallow duplicate setup and teardown hooks | | |
| [no-export](docs/rules/no-export.md) | Disallow using `exports` in files containing tests | ![recommended][] | |
| [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | ![recommended][] | ![fixable][] |
| [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | ![recommended][] | ![suggest][] |
| [no-hooks](docs/rules/no-hooks.md) | Disallow setup and teardown hooks | | |
| [no-identical-title](docs/rules/no-identical-title.md) | Disallow identical titles | ![recommended][] | |
| [no-if](docs/rules/no-if.md) | Disallow conditional logic | | |
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-plugin-jest",
"version": "24.1.10",
"version": "24.2.0",
"description": "Eslint rules for Jest",
"keywords": [
"eslint",
266 changes: 247 additions & 19 deletions src/rules/__tests__/no-focused-tests.test.ts
View file
Original file line number Diff line number Diff line change
@@ -31,79 +31,307 @@ ruleTester.run('no-focused-tests', rule, {
invalid: [
{
code: 'describe.only()',
errors: [{ messageId: 'focusedTest', column: 10, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 10,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'describe()',
},
],
},
],
},
{
code: 'describe.only.each()',
errors: [{ messageId: 'focusedTest', column: 10, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 10,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'describe.each()',
},
],
},
],
},
{
code: 'describe.only.each`table`()',
errors: [{ messageId: 'focusedTest', column: 10, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 10,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'describe.each`table`()',
},
],
},
],
},
{
code: 'describe["only"]()',
errors: [{ messageId: 'focusedTest', column: 10, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 10,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'describe()',
},
],
},
],
},
{
code: 'it.only()',
errors: [{ messageId: 'focusedTest', column: 4, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 4,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it()',
},
],
},
],
},
{
code: 'it.concurrent.only()',
errors: [{ messageId: 'focusedTest', column: 4, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 4,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it.concurrent()',
},
],
},
],
},
{
code: 'it.only.each()',
errors: [{ messageId: 'focusedTest', column: 4, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 4,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it.each()',
},
],
},
],
},
{
code: 'it.only.each`table`()',
errors: [{ messageId: 'focusedTest', column: 4, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 4,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it.each`table`()',
},
],
},
],
},
{
code: 'it["only"]()',
errors: [{ messageId: 'focusedTest', column: 4, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 4,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it()',
},
],
},
],
},
{
code: 'test.only()',
errors: [{ messageId: 'focusedTest', column: 6, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 6,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test()',
},
],
},
],
},
{
code: 'test.concurrent.only()',
errors: [{ messageId: 'focusedTest', column: 6, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 6,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test.concurrent()',
},
],
},
],
},
{
code: 'test.only.each()',
errors: [{ messageId: 'focusedTest', column: 6, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 6,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test.each()',
},
],
},
],
},
{
code: 'test.only.each`table`()',
errors: [{ messageId: 'focusedTest', column: 6, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 6,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test.each`table`()',
},
],
},
],
},
{
code: 'test["only"]()',
errors: [{ messageId: 'focusedTest', column: 6, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 6,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test()',
},
],
},
],
},
{
code: 'fdescribe()',
errors: [{ messageId: 'focusedTest', column: 1, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 1,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'describe()',
},
],
},
],
},
{
code: 'fit()',
errors: [{ messageId: 'focusedTest', column: 1, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 1,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it()',
},
],
},
],
},
{
code: 'fit.each()',
errors: [{ messageId: 'focusedTest', column: 1, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 1,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it.each()',
},
],
},
],
},
{
code: 'fit.each`table`()',
errors: [{ messageId: 'focusedTest', column: 1, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 1,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'it.each`table`()',
},
],
},
],
},
{
code: 'ftest.each`table`()',
errors: [{ messageId: 'focusedTest', column: 1, line: 1 }],
errors: [
{
messageId: 'focusedTest',
column: 1,
line: 1,
suggestions: [
{
messageId: 'suggestRemoveFocus',
output: 'test.each`table`()',
},
],
},
],
},
],
});
84 changes: 75 additions & 9 deletions src/rules/no-focused-tests.ts
View file
Original file line number Diff line number Diff line change
@@ -50,11 +50,12 @@ export default createRule({
category: 'Best Practices',
description: 'Disallow focused tests',
recommended: 'error',
suggestion: true,
},
messages: {
focusedTest: 'Unexpected focused test.',
suggestRemoveFocus: 'Remove focus from test.',
},
fixable: 'code',
schema: [],
type: 'suggestion',
},
@@ -67,29 +68,80 @@ export default createRule({
: node.callee;

if (callee.type === AST_NODE_TYPES.MemberExpression) {
const calleeObject = callee.object;

if (
callee.object.type === AST_NODE_TYPES.Identifier &&
isCallToFocusedTestFunction(callee.object)
calleeObject.type === AST_NODE_TYPES.Identifier &&
isCallToFocusedTestFunction(calleeObject)
) {
context.report({ messageId: 'focusedTest', node: callee.object });
context.report({
messageId: 'focusedTest',
node: calleeObject,
suggest: [
{
messageId: 'suggestRemoveFocus',
fix(fixer) {
return fixer.removeRange([
calleeObject.range[0],
calleeObject.range[0] + 1,
]);
},
},
],
});

return;
}

if (
callee.object.type === AST_NODE_TYPES.MemberExpression &&
isCallToTestOnlyFunction(callee.object)
calleeObject.type === AST_NODE_TYPES.MemberExpression &&
isCallToTestOnlyFunction(calleeObject)
) {
context.report({
messageId: 'focusedTest',
node: callee.object.property,
node: calleeObject.property,
suggest: [
{
messageId: 'suggestRemoveFocus',
fix(fixer) {
if (
calleeObject.property.type === AST_NODE_TYPES.Identifier &&
calleeObject.property.name === 'only'
) {
return fixer.removeRange([
calleeObject.object.range[1],
calleeObject.range[1],
]);
}

return fixer.removeRange([
calleeObject.range[1],
callee.range[1],
]);
},
},
],
});

return;
}

if (isCallToTestOnlyFunction(callee)) {
context.report({ messageId: 'focusedTest', node: callee.property });
context.report({
messageId: 'focusedTest',
node: callee.property,
suggest: [
{
messageId: 'suggestRemoveFocus',
fix(fixer) {
return fixer.removeRange([
calleeObject.range[1],
callee.range[1],
]);
},
},
],
});

return;
}
@@ -99,7 +151,21 @@ export default createRule({
callee.type === AST_NODE_TYPES.Identifier &&
isCallToFocusedTestFunction(callee)
) {
context.report({ messageId: 'focusedTest', node: callee });
context.report({
messageId: 'focusedTest',
node: callee,
suggest: [
{
messageId: 'suggestRemoveFocus',
fix(fixer) {
return fixer.removeRange([
callee.range[0],
callee.range[0] + 1,
]);
},
},
],
});
}
},
}),