eslint-plugin-jest 26.2.2 → 26.4.1

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;
         }
 

package/lib/rules/prefer-hooks-in-order.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("./utils");
+
+const HooksOrder = ['beforeAll', 'beforeEach', 'afterEach', 'afterAll'];
+
+var _default = (0, _utils.createRule)({
+  name: __filename,
+  meta: {
+    docs: {
+      category: 'Best Practices',
+      description: 'Prefer having hooks in a consistent order',
+      recommended: false
+    },
+    messages: {
+      reorderHooks: `\`{{ currentHook }}\` hooks should be before any \`{{ previousHook }}\` hooks`
+    },
+    schema: [],
+    type: 'suggestion'
+  },
+  defaultOptions: [],
+
+  create(context) {
+    let previousHookIndex = -1;
+    let inHook = false;
+    return {
+      CallExpression(node) {
+        if (inHook) {
+          // Ignore everything that is passed into a hook
+          return;
+        }
+
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, context.getScope());
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'hook') {
+          // Reset the previousHookIndex when encountering something different from a hook
+          previousHookIndex = -1;
+          return;
+        }
+
+        inHook = true;
+        const currentHook = jestFnCall.name;
+        const currentHookIndex = HooksOrder.indexOf(currentHook);
+
+        if (currentHookIndex < previousHookIndex) {
+          context.report({
+            messageId: 'reorderHooks',
+            node,
+            data: {
+              previousHook: HooksOrder[previousHookIndex],
+              currentHook
+            }
+          });
+          return;
+        }
+
+        previousHookIndex = currentHookIndex;
+      },
+
+      'CallExpression:exit'(node) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['hook'])) {
+          inHook = false;
+          return;
+        }
+
+        if (inHook) {
+          return;
+        } // Reset the previousHookIndex when encountering something different from a hook
+
+
+        previousHookIndex = -1;
+      }
+
+    };
+  }
+
+});
+
+exports.default = _default;

package/lib/rules/prefer-hooks-on-top.js

@@ -29,11 +29,11 @@ var _default = (0, _utils.createRule)({
       CallExpression(node) {
         const scope = context.getScope();
 
-        if (!(0, _utils.isHookCall)(node, scope) && (0, _utils.isTestCaseCall)(node, scope)) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, scope, ['test'])) {
           hooksContext[hooksContext.length - 1] = true;
         }
 
-        if (hooksContext[hooksContext.length - 1] && (0, _utils.isHookCall)(node, scope)) {
+        if (hooksContext[hooksContext.length - 1] && (0, _utils.isTypeOfJestFnCall)(node, scope, ['hook'])) {
           context.report({
             messageId: 'noHookOnTop',
             node

package/lib/rules/prefer-lowercase-title.js

@@ -9,18 +9,6 @@ var _utils = require("./utils");
 
 const hasStringAsFirstArgument = node => node.arguments[0] && (0, _utils.isStringNode)(node.arguments[0]);
 
-const findNodeNameAndArgument = (node, scope) => {
-  if (!((0, _utils.isTestCaseCall)(node, scope) || (0, _utils.isDescribeCall)(node, scope))) {
-    return null;
-  }
-
-  if (!hasStringAsFirstArgument(node)) {
-    return null;
-  }
-
-  return [(0, _utils.getNodeName)(node).split('.')[0], node.arguments[0]];
-};
-
 const populateIgnores = ignore => {
   const ignores = [];
 
@@ -93,22 +81,23 @@ var _default = (0, _utils.createRule)({
     return {
       CallExpression(node) {
         const scope = context.getScope();
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, scope);
 
-        if ((0, _utils.isDescribeCall)(node, scope)) {
+        if (!jestFnCall || !hasStringAsFirstArgument(node)) {
+          return;
+        }
+
+        if (jestFnCall.type === 'describe') {
           numberOfDescribeBlocks++;
 
           if (ignoreTopLevelDescribe && numberOfDescribeBlocks === 1) {
             return;
           }
-        }
-
-        const results = findNodeNameAndArgument(node, scope);
-
-        if (!results) {
+        } else if (jestFnCall.type !== 'test') {
           return;
         }
 
-        const [name, firstArg] = results;
+        const [firstArg] = node.arguments;
         const description = (0, _utils.getStringValue)(firstArg);
 
         if (allowedPrefixes.some(name => description.startsWith(name))) {
@@ -117,7 +106,7 @@ var _default = (0, _utils.createRule)({
 
         const firstCharacter = description.charAt(0);
 
-        if (!firstCharacter || firstCharacter === firstCharacter.toLowerCase() || ignores.includes(name)) {
+        if (!firstCharacter || firstCharacter === firstCharacter.toLowerCase() || ignores.includes(jestFnCall.name)) {
           return;
         }
 
@@ -125,7 +114,7 @@ var _default = (0, _utils.createRule)({
           messageId: 'unexpectedLowercase',
           node: node.arguments[0],
           data: {
-            method: name
+            method: jestFnCall.name
           },
 
           fix(fixer) {
@@ -139,7 +128,7 @@ var _default = (0, _utils.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isDescribeCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['describe'])) {
           numberOfDescribeBlocks--;
         }
       }

package/lib/rules/prefer-snapshot-hint.js

@@ -108,7 +108,7 @@ var _default = (0, _utils.createRule)({
       'CallExpression:exit'(node) {
         const scope = context.getScope();
 
-        if ((0, _utils.isDescribeCall)(node, scope) || (0, _utils.isTestCaseCall)(node, scope)) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, scope, ['describe', 'test'])) {
           var _depths$pop;
 
           /* istanbul ignore next */
@@ -119,7 +119,7 @@ var _default = (0, _utils.createRule)({
       CallExpression(node) {
         const scope = context.getScope();
 
-        if ((0, _utils.isDescribeCall)(node, scope) || (0, _utils.isTestCaseCall)(node, scope)) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, scope, ['describe', 'test'])) {
           depths.push(expressionDepth);
           expressionDepth = 0;
         }

package/lib/rules/prefer-todo.js

@@ -17,12 +17,28 @@ function isEmptyFunction(node) {
   return node.body.type === _utils.AST_NODE_TYPES.BlockStatement && !node.body.body.length;
 }
 
-function createTodoFixer(node, fixer) {
-  const testName = (0, _utils2.getNodeName)(node).split('.').shift();
-  return fixer.replaceText(node.callee, `${testName}.todo`);
+function createTodoFixer(jestFnCall, fixer) {
+  const fixes = [fixer.replaceText(jestFnCall.head.node, `${jestFnCall.head.local}.todo`)];
+
+  if (jestFnCall.members.length) {
+    fixes.unshift(fixer.removeRange([jestFnCall.head.node.range[1], jestFnCall.members[0].range[1]]));
+  }
+
+  return fixes;
 }
 
-const isTargetedTestCase = (node, scope) => (0, _utils2.isTestCaseCall)(node, scope) && [_utils2.TestCaseName.it, _utils2.TestCaseName.test, 'it.skip', 'test.skip'].includes((0, _utils2.getNodeName)(node));
+const isTargetedTestCase = jestFnCall => {
+  if (jestFnCall.members.some(s => (0, _utils2.getAccessorValue)(s) !== 'skip')) {
+    return false;
+  } // todo: we should support this too (needs custom fixer)
+
+
+  if (jestFnCall.name.startsWith('x')) {
+    return false;
+  }
+
+  return !jestFnCall.name.startsWith('f');
+};
 
 var _default = (0, _utils2.createRule)({
   name: __filename,
@@ -46,8 +62,9 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const [title, callback] = node.arguments;
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, context.getScope());
 
-        if (!title || !isTargetedTestCase(node, context.getScope()) || !(0, _utils2.isStringNode)(title)) {
+        if (!title || (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test' || !isTargetedTestCase(jestFnCall) || !(0, _utils2.isStringNode)(title)) {
           return;
         }
 
@@ -55,7 +72,7 @@ var _default = (0, _utils2.createRule)({
           context.report({
             messageId: 'emptyTest',
             node,
-            fix: fixer => [fixer.removeRange([title.range[1], callback.range[1]]), createTodoFixer(node, fixer)]
+            fix: fixer => [fixer.removeRange([title.range[1], callback.range[1]]), ...createTodoFixer(jestFnCall, fixer)]
           });
         }
 
@@ -63,7 +80,7 @@ var _default = (0, _utils2.createRule)({
           context.report({
             messageId: 'unimplementedTest',
             node,
-            fix: fixer => [createTodoFixer(node, fixer)]
+            fix: fixer => createTodoFixer(jestFnCall, fixer)
           });
         }
       }

package/lib/rules/require-hook.js

@@ -12,7 +12,7 @@ var _utils2 = require("./utils");
 const isJestFnCall = (node, scope) => {
   var _getNodeName;
 
-  if ((0, _utils2.isDescribeCall)(node, scope) || (0, _utils2.isTestCaseCall)(node, scope) || (0, _utils2.isHookCall)(node, scope)) {
+  if ((0, _utils2.parseJestFnCall)(node, scope)) {
     return true;
   }
 
@@ -100,7 +100,7 @@ var _default = (0, _utils2.createRule)({
       },
 
       CallExpression(node) {
-        if (!(0, _utils2.isDescribeCall)(node, context.getScope()) || node.arguments.length < 2) {
+        if (!(0, _utils2.isTypeOfJestFnCall)(node, context.getScope(), ['describe']) || node.arguments.length < 2) {
           return;
         }
 

package/lib/rules/require-top-level-describe.js

@@ -47,8 +47,13 @@ var _default = (0, _utils.createRule)({
     return {
       CallExpression(node) {
         const scope = context.getScope();
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, scope);
 
-        if ((0, _utils.isDescribeCall)(node, scope)) {
+        if (!jestFnCall) {
+          return;
+        }
+
+        if (jestFnCall.type === 'describe') {
           numberOfDescribeBlocks++;
 
           if (numberOfDescribeBlocks === 1) {
@@ -70,7 +75,7 @@ var _default = (0, _utils.createRule)({
         }
 
         if (numberOfDescribeBlocks === 0) {
-          if ((0, _utils.isTestCaseCall)(node, scope)) {
+          if (jestFnCall.type === 'test') {
             context.report({
               node,
               messageId: 'unexpectedTestCase'
@@ -78,7 +83,7 @@ var _default = (0, _utils.createRule)({
             return;
           }
 
-          if ((0, _utils.isHookCall)(node, scope)) {
+          if (jestFnCall.type === 'hook') {
             context.report({
               node,
               messageId: 'unexpectedHook'
@@ -89,7 +94,7 @@ var _default = (0, _utils.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isDescribeCall)(node, context.getScope())) {
+        if ((0, _utils.isTypeOfJestFnCall)(node, context.getScope(), ['describe'])) {
           numberOfDescribeBlocks--;
         }
       }