eslint-plugin-jest 26.2.1 → 26.4.0

package/README.md

@@ -209,6 +209,7 @@ installations requiring long-term consistency.
 | [prefer-equality-matcher](docs/rules/prefer-equality-matcher.md)             | Suggest using the built-in equality matchers                        |                  | ![suggest][] |
 | [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md)           | Suggest using `expect.assertions()` OR `expect.hasAssertions()`     |                  | ![suggest][] |
 | [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md)               | Prefer `await expect(...).resolves` over `expect(await ...)` syntax |                  | ![fixable][] |
+| [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md)                 | Prefer having hooks in a consistent order                           |                  |              |
 | [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)                     | Suggest having hooks before any test cases                          |                  |              |
 | [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md)               | Enforce lowercase test names                                        |                  | ![fixable][] |
 | [prefer-snapshot-hint](docs/rules/prefer-snapshot-hint.md)                   | Prefer including a hint with external snapshots                     |                  |              |

package/docs/rules/prefer-hooks-in-order.md

@@ -0,0 +1,133 @@
+# Prefer having hooks in a consistent order (`prefer-hooks-in-order`)
+
+While hooks can be setup in any order, they're always called by `jest` in this
+specific order:
+
+1. `beforeAll`
+1. `beforeEach`
+1. `afterEach`
+1. `afterAll`
+
+This rule aims to make that more obvious by enforcing grouped hooks be setup in
+that order within tests.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule
+
+```js
+/* eslint jest/prefer-hooks-in-order: "error" */
+
+describe('foo', () => {
+  beforeEach(() => {
+    seedMyDatabase();
+  });
+
+  beforeAll(() => {
+    createMyDatabase();
+  });
+
+  it('accepts this input', () => {
+    // ...
+  });
+
+  it('returns that value', () => {
+    // ...
+  });
+
+  describe('when the database has specific values', () => {
+    const specificValue = '...';
+
+    beforeEach(() => {
+      seedMyDatabase(specificValue);
+    });
+
+    it('accepts that input', () => {
+      // ...
+    });
+
+    it('throws an error', () => {
+      // ...
+    });
+
+    afterEach(() => {
+      clearLogger();
+    });
+    beforeEach(() => {
+      mockLogger();
+    });
+
+    it('logs a message', () => {
+      // ...
+    });
+  });
+
+  afterAll(() => {
+    removeMyDatabase();
+  });
+});
+```
+
+Examples of **correct** code for this rule
+
+```js
+/* eslint jest/prefer-hooks-in-order: "error" */
+
+describe('foo', () => {
+  beforeAll(() => {
+    createMyDatabase();
+  });
+
+  beforeEach(() => {
+    seedMyDatabase();
+  });
+
+  it('accepts this input', () => {
+    // ...
+  });
+
+  it('returns that value', () => {
+    // ...
+  });
+
+  describe('when the database has specific values', () => {
+    const specificValue = '...';
+
+    beforeEach(() => {
+      seedMyDatabase(specificValue);
+    });
+
+    it('accepts that input', () => {
+      // ...
+    });
+
+    it('throws an error', () => {
+      // ...
+    });
+
+    beforeEach(() => {
+      mockLogger();
+    });
+
+    afterEach(() => {
+      clearLogger();
+    });
+
+    it('logs a message', () => {
+      // ...
+    });
+  });
+
+  afterAll(() => {
+    removeMyDatabase();
+  });
+});
+```
+
+## Also See
+
+- [`prefer-hooks-on-top`](prefer-hooks-on-top.md)
+
+## Further Reading
+
+- [Order of execution of describe and test blocks](https://jestjs.io/docs/setup-teardown#order-of-execution-of-describe-and-test-blocks)

package/lib/rules/consistent-test-it.js

@@ -51,19 +51,20 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const scope = context.getScope();
-        const nodeName = (0, _utils2.getNodeName)(node.callee);
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, scope);
 
-        if (!nodeName) {
+        if (!jestFnCall) {
           return;
         }
 
-        if ((0, _utils2.isDescribeCall)(node, scope)) {
+        if (jestFnCall.type === 'describe') {
           describeNestingLevel++;
+          return;
         }
 
         const funcNode = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
 
-        if ((0, _utils2.isTestCaseCall)(node, scope) && describeNestingLevel === 0 && !nodeName.includes(testKeyword)) {
+        if (jestFnCall.type === 'test' && describeNestingLevel === 0 && !jestFnCall.name.endsWith(testKeyword)) {
           const oppositeTestKeyword = getOppositeTestKeyword(testKeyword);
           context.report({
             messageId: 'consistentMethod',
@@ -72,11 +73,11 @@ var _default = (0, _utils2.createRule)({
               testKeyword,
               oppositeTestKeyword
             },
-            fix: buildFixer(funcNode, nodeName, testKeyword)
+            fix: buildFixer(funcNode, jestFnCall.name, testKeyword)
           });
         }
 
-        if ((0, _utils2.isTestCaseCall)(node, scope) && describeNestingLevel > 0 && !nodeName.includes(testKeywordWithinDescribe)) {
+        if (jestFnCall.type === 'test' && describeNestingLevel > 0 && !jestFnCall.name.endsWith(testKeywordWithinDescribe)) {
           const oppositeTestKeyword = getOppositeTestKeyword(testKeywordWithinDescribe);
           context.report({
             messageId: 'consistentMethodWithinDescribe',
@@ -85,13 +86,13 @@ var _default = (0, _utils2.createRule)({
               testKeywordWithinDescribe,
               oppositeTestKeyword
             },
-            fix: buildFixer(funcNode, nodeName, testKeywordWithinDescribe)
+            fix: buildFixer(funcNode, jestFnCall.name, testKeywordWithinDescribe)
           });
         }
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils2.isDescribeCall)(node, context.getScope())) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['describe'])) {
           describeNestingLevel--;
         }
       }

package/lib/rules/expect-expect.js

@@ -93,7 +93,7 @@ var _default = (0, _utils2.createRule)({
 
         const name = (_getNodeName = (0, _utils2.getNodeName)(node.callee)) !== null && _getNodeName !== void 0 ? _getNodeName : '';
 
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope()) || additionalTestBlockFunctions.includes(name)) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test']) || additionalTestBlockFunctions.includes(name)) {
           if (node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'todo')) {
             return;
           }

package/lib/rules/max-nested-describe.js

@@ -46,7 +46,7 @@ var _default = (0, _utils2.createRule)({
         parent
       } = node;
 
-      if ((parent === null || parent === void 0 ? void 0 : parent.type) !== _utils.AST_NODE_TYPES.CallExpression || !(0, _utils2.isDescribeCall)(parent, context.getScope())) {
+      if ((parent === null || parent === void 0 ? void 0 : parent.type) !== _utils.AST_NODE_TYPES.CallExpression || !(0, _utils2.isTypeOfJestFnCall)(parent, context.getScope(), ['describe'])) {
         return;
       }
 
@@ -69,7 +69,7 @@ var _default = (0, _utils2.createRule)({
         parent
       } = node;
 
-      if ((parent === null || parent === void 0 ? void 0 : parent.type) === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isDescribeCall)(parent, context.getScope())) {
+      if ((parent === null || parent === void 0 ? void 0 : parent.type) === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isTypeOfJestFnCall)(parent, context.getScope(), ['describe'])) {
         describeCallbackStack.pop();
       }
     }

package/lib/rules/no-conditional-expect.js

@@ -47,7 +47,7 @@ var _default = (0, _utils2.createRule)({
       },
 
       CallExpression(node) {
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           inTestCase = true;
         }
 
@@ -71,7 +71,7 @@ var _default = (0, _utils2.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           inTestCase = false;
         }
 

package/lib/rules/no-conditional-in-test.js

@@ -37,13 +37,13 @@ var _default = (0, _utils.createRule)({
 
     return {
       CallExpression(node) {
-        if ((0, _utils.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           inTestCase = true;
         }
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           inTestCase = false;
         }
       },

package/lib/rules/no-done-callback.js

@@ -14,11 +14,13 @@ const findCallbackArg = (node, isJestEach, scope) => {
     return node.arguments[1];
   }
 
-  if ((0, _utils2.isHookCall)(node, scope) && node.arguments.length >= 1) {
+  const jestFnCall = (0, _utils2.parseJestFnCall)(node, scope);
+
+  if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'hook' && node.arguments.length >= 1) {
     return node.arguments[0];
   }
 
-  if ((0, _utils2.isTestCaseCall)(node, scope) && node.arguments.length >= 2) {
+  if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test' && node.arguments.length >= 2) {
     return node.arguments[1];
   }
 

package/lib/rules/no-duplicate-hooks.js

@@ -7,13 +7,6 @@ exports.default = void 0;
 
 var _utils = require("./utils");
 
-const newHookContext = () => ({
-  beforeAll: 0,
-  beforeEach: 0,
-  afterAll: 0,
-  afterEach: 0
-});
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -31,33 +24,39 @@ var _default = (0, _utils.createRule)({
   defaultOptions: [],
 
   create(context) {
-    const hookContexts = [newHookContext()];
+    const hookContexts = [{}];
     return {
       CallExpression(node) {
+        var _jestFnCall$name;
+
         const scope = context.getScope();
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, scope);
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'describe') {
+          hookContexts.push({});
+        }
 
-        if ((0, _utils.isDescribeCall)(node, scope)) {
-          hookContexts.push(newHookContext());
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'hook') {
+          return;
         }
 
-        if ((0, _utils.isHookCall)(node, scope)) {
-          const currentLayer = hookContexts[hookContexts.length - 1];
-          currentLayer[node.callee.name] += 1;
+        const currentLayer = hookContexts[hookContexts.length - 1];
+        currentLayer[_jestFnCall$name = jestFnCall.name] || (currentLayer[_jestFnCall$name] = 0);
+        currentLayer[jestFnCall.name] += 1;
 
-          if (currentLayer[node.callee.name] > 1) {
-            context.report({
-              messageId: 'noDuplicateHook',
-              data: {
-                hook: node.callee.name
-              },
-              node
-            });
-          }
+        if (currentLayer[jestFnCall.name] > 1) {
+          context.report({
+            messageId: 'noDuplicateHook',
+            data: {
+              hook: jestFnCall.name
+            },
+            node
+          });
         }
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isDescribeCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['describe'])) {
           hookContexts.pop();
         }
       }

package/lib/rules/no-export.js

@@ -41,7 +41,7 @@ var _default = (0, _utils2.createRule)({
       },
 
       CallExpression(node) {
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           hasTestCase = true;
         }
       },

package/lib/rules/no-focused-tests.js

@@ -9,24 +9,6 @@ var _utils = require("@typescript-eslint/utils");
 
 var _utils2 = require("./utils");
 
-const findOnlyNode = node => {
-  const callee = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
-
-  if (callee.type === _utils.AST_NODE_TYPES.MemberExpression) {
-    if (callee.object.type === _utils.AST_NODE_TYPES.MemberExpression) {
-      if ((0, _utils2.isSupportedAccessor)(callee.object.property, 'only')) {
-        return callee.object.property;
-      }
-    }
-
-    if ((0, _utils2.isSupportedAccessor)(callee.property, 'only')) {
-      return callee.property;
-    }
-  }
-
-  return null;
-};
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -50,24 +32,34 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const scope = context.getScope();
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, scope);
 
-        if (!(0, _utils2.isDescribeCall)(node, scope) && !(0, _utils2.isTestCaseCall)(node, scope)) {
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test' && (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'describe') {
           return;
         }
 
-        if ((0, _utils2.getNodeName)(node).startsWith('f')) {
+        if (jestFnCall.name.startsWith('f')) {
           context.report({
             messageId: 'focusedTest',
             node,
             suggest: [{
               messageId: 'suggestRemoveFocus',
-              fix: fixer => fixer.removeRange([node.range[0], node.range[0] + 1])
+
+              fix(fixer) {
+                // don't apply the fixer if we're an aliased import
+                if (jestFnCall.head.type === 'import' && jestFnCall.name !== jestFnCall.head.local) {
+                  return null;
+                }
+
+                return fixer.removeRange([node.range[0], node.range[0] + 1]);
+              }
+
             }]
           });
           return;
         }
 
-        const onlyNode = findOnlyNode(node);
+        const onlyNode = jestFnCall.members.find(s => (0, _utils2.getAccessorValue)(s) === 'only');
 
         if (!onlyNode) {
           return;

package/lib/rules/no-hooks.js

@@ -39,12 +39,14 @@ var _default = (0, _utils.createRule)({
   }]) {
     return {
       CallExpression(node) {
-        if ((0, _utils.isHookCall)(node, context.getScope()) && !allow.includes(node.callee.name)) {
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, context.getScope());
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'hook' && !allow.includes(jestFnCall.name)) {
           context.report({
             node,
             messageId: 'unexpectedHook',
             data: {
-              hookName: node.callee.name
+              hookName: jestFnCall.name
             }
           });
         }

package/lib/rules/no-identical-title.js

@@ -33,16 +33,19 @@ var _default = (0, _utils.createRule)({
     const contexts = [newDescribeContext()];
     return {
       CallExpression(node) {
-        var _getNodeName;
-
         const scope = context.getScope();
         const currentLayer = contexts[contexts.length - 1];
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, scope);
+
+        if (!jestFnCall) {
+          return;
+        }
 
-        if ((0, _utils.isDescribeCall)(node, scope)) {
+        if (jestFnCall.type === 'describe') {
           contexts.push(newDescribeContext());
         }
 
-        if ((_getNodeName = (0, _utils.getNodeName)(node.callee)) !== null && _getNodeName !== void 0 && _getNodeName.endsWith('.each')) {
+        if (jestFnCall.members.find(s => (0, _utils.isSupportedAccessor)(s, 'each'))) {
           return;
         }
 
@@ -54,7 +57,7 @@ var _default = (0, _utils.createRule)({
 
         const title = (0, _utils.getStringValue)(argument);
 
-        if ((0, _utils.isTestCaseCall)(node, scope)) {
+        if (jestFnCall.type === 'test') {
           if (currentLayer.testTitles.includes(title)) {
             context.report({
               messageId: 'multipleTestTitle',
@@ -65,7 +68,7 @@ var _default = (0, _utils.createRule)({
           currentLayer.testTitles.push(title);
         }
 
-        if (!(0, _utils.isDescribeCall)(node, scope)) {
+        if (jestFnCall.type !== 'describe') {
           return;
         }
 
@@ -80,7 +83,7 @@ var _default = (0, _utils.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isDescribeCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['describe'])) {
           contexts.pop();
         }
       }

package/lib/rules/no-if.js

@@ -58,10 +58,12 @@ var _default = (0, _utils2.createRule)({
 
     return {
       CallExpression(node) {
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, context.getScope());
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test') {
           stack.push(true);
 
-          if ((0, _utils2.getNodeName)(node).endsWith('each')) {
+          if (jestFnCall.members.some(s => (0, _utils2.getAccessorValue)(s) === 'each')) {
             stack.push(true);
           }
         }

package/lib/rules/no-standalone-expect.js

@@ -30,7 +30,7 @@ const getBlockType = (statement, scope) => {
     } // if it's not a variable, it will be callExpr, we only care about describe
 
 
-    if (expr.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isDescribeCall)(expr, scope)) {
+    if (expr.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isTypeOfJestFnCall)(expr, scope, ['describe'])) {
       return 'describe';
     }
   }
@@ -73,7 +73,7 @@ var _default = (0, _utils2.createRule)({
 
     const isCustomTestBlockFunction = node => additionalTestBlockFunctions.includes((0, _utils2.getNodeName)(node) || '');
 
-    const isTestBlock = node => (0, _utils2.isTestCaseCall)(node, context.getScope()) || isCustomTestBlockFunction(node);
+    const isTestBlock = node => (0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test']) || isCustomTestBlockFunction(node);
 
     return {
       CallExpression(node) {

package/lib/rules/no-test-prefixes.js

@@ -30,10 +30,17 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const scope = context.getScope();
-        const nodeName = (0, _utils2.getNodeName)(node.callee);
-        if (!nodeName || !(0, _utils2.isDescribeCall)(node, scope) && !(0, _utils2.isTestCaseCall)(node, scope)) return;
-        const preferredNodeName = getPreferredNodeName(nodeName);
-        if (!preferredNodeName) return;
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, scope);
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'describe' && (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test') {
+          return;
+        }
+
+        if (jestFnCall.name[0] !== 'f' && jestFnCall.name[0] !== 'x') {
+          return;
+        }
+
+        const preferredNodeName = [jestFnCall.name.slice(1), jestFnCall.name[0] === 'f' ? 'only' : 'skip', ...jestFnCall.members.map(s => (0, _utils2.getAccessorValue)(s))].join('.');
         const funcNode = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
         context.report({
           messageId: 'usePreferredName',
@@ -54,19 +61,4 @@ var _default = (0, _utils2.createRule)({
 
 });
 
-exports.default = _default;
-
-function getPreferredNodeName(nodeName) {
-  const firstChar = nodeName.charAt(0);
-  const suffix = nodeName.endsWith('.each') ? '.each' : '';
-
-  if (firstChar === 'f') {
-    return `${nodeName.slice(1).replace('.each', '')}.only${suffix}`;
-  }
-
-  if (firstChar === 'x') {
-    return `${nodeName.slice(1).replace('.each', '')}.skip${suffix}`;
-  }
-
-  return null;
-}
+exports.default = _default;

package/lib/rules/no-test-return-statement.js

@@ -38,7 +38,10 @@ var _default = (0, _utils2.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils2.isTestCaseCall)(node, context.getScope())) return;
+        if (!(0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
+          return;
+        }
+
         const body = getBody(node.arguments);
         const returnStmt = body.find(t => t.type === _utils.AST_NODE_TYPES.ReturnStatement);
         if (!returnStmt) return;

package/lib/rules/prefer-expect-assertions.js

@@ -116,7 +116,7 @@ var _default = (0, _utils2.createRule)({
       'ForOfStatement:exit': exitForLoop,
 
       CallExpression(node) {
-        if ((0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        if ((0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           inTestCaseCall = true;
           return;
         }
@@ -133,7 +133,7 @@ var _default = (0, _utils2.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if (!(0, _utils2.isTestCaseCall)(node, context.getScope())) {
+        if (!(0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['test'])) {
           return;
         }