eslint-plugin-jest 24.1.1 → 24.1.5

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [24.1.5](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.4...v24.1.5) (2021-02-17)
+
+
+### Bug Fixes
+
+* **require-top-level-describe:** import function that actually exists ([#763](https://github.com/jest-community/eslint-plugin-jest/issues/763)) ([d10dc07](https://github.com/jest-community/eslint-plugin-jest/commit/d10dc07d9dc933fe9584b3e13704001527896859))
+
+## [24.1.4](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.3...v24.1.4) (2021-02-16)
+
+
+### Bug Fixes
+
+* **lowercase-name:** support `.each` methods ([#746](https://github.com/jest-community/eslint-plugin-jest/issues/746)) ([3d847b2](https://github.com/jest-community/eslint-plugin-jest/commit/3d847b2164425a2afb754569dbfff52411c95610))
+* **require-top-level-describe:** handle `describe.each` properly ([#745](https://github.com/jest-community/eslint-plugin-jest/issues/745)) ([677be45](https://github.com/jest-community/eslint-plugin-jest/commit/677be4558a3954e364b0c4150678a4d3fd832337))
+
+## [24.1.3](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.2...v24.1.3) (2020-11-12)
+
+
+### Bug Fixes
+
+* revert change causing regressions for test.each ([#713](https://github.com/jest-community/eslint-plugin-jest/issues/713)) ([7c8d75a](https://github.com/jest-community/eslint-plugin-jest/commit/7c8d75a4fcbd2c6ce005cf4f57d676c7c44ce0b2)), closes [#710](https://github.com/jest-community/eslint-plugin-jest/issues/710) [#711](https://github.com/jest-community/eslint-plugin-jest/issues/711)
+
+## [24.1.2](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.1...v24.1.2) (2020-11-12)
+
+
+### Bug Fixes
+
+* **no-done-callback:** fix regression with it.each ([#708](https://github.com/jest-community/eslint-plugin-jest/issues/708)) ([2f032f8](https://github.com/jest-community/eslint-plugin-jest/commit/2f032f8d890e3717359d099b1e93e0cc6b52996a))
+
 ## [24.1.1](https://github.com/jest-community/eslint-plugin-jest/compare/v24.1.0...v24.1.1) (2020-11-12)
 
 

package/README.md

@@ -10,7 +10,6 @@
 </div>
 
 [![Actions Status](https://github.com/jest-community/eslint-plugin-jest/workflows/Unit%20tests/badge.svg?branch=master)](https://github.com/jest-community/eslint-plugin-jest/actions)
-[![Renovate badge](https://badges.renovateapi.com/github/jest-community/eslint-plugin-jest)](https://renovatebot.com/)
 
 ## Installation
 

package/docs/rules/expect-expect.md

@@ -74,7 +74,7 @@ test('returns sum', () => {
 });
 ```
 
-Since the string is compiled into aa regular expression, you'll need to escape
+Since the string is compiled into a regular expression, you'll need to escape
 special characters such as `$` with a double backslash:
 
 ```js

package/docs/rules/no-hooks.md

@@ -172,4 +172,3 @@ safely disable this rule.
 ## Further Reading
 
 - [Jest docs - Setup and Teardown](https://facebook.github.io/jest/docs/en/setup-teardown.html)
-- [@jamiebuilds Twitter thread](https://twitter.com/jamiebuilds/status/954906997169664000)

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

@@ -60,8 +60,6 @@ var _default = (0, _utils.createRule)({
           describeNestingLevel++;
         }
 
-        const funcNode = node.callee.type === _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee;
-
         if ((0, _utils.isTestCase)(node) && describeNestingLevel === 0 && !nodeName.includes(testKeyword)) {
           const oppositeTestKeyword = getOppositeTestKeyword(testKeyword);
           context.report({
@@ -71,7 +69,7 @@ var _default = (0, _utils.createRule)({
               testKeyword,
               oppositeTestKeyword
             },
-            fix: buildFixer(funcNode, nodeName, testKeyword)
+            fix: buildFixer(node.callee, nodeName, testKeyword)
           });
         }
 
@@ -84,7 +82,7 @@ var _default = (0, _utils.createRule)({
               testKeywordWithinDescribe,
               oppositeTestKeyword
             },
-            fix: buildFixer(funcNode, nodeName, testKeywordWithinDescribe)
+            fix: buildFixer(node.callee, nodeName, testKeywordWithinDescribe)
           });
         }
       },

package/lib/rules/lowercase-name.js

@@ -11,22 +11,26 @@ var _utils = require("./utils");
 
 const hasStringAsFirstArgument = node => node.arguments[0] && (0, _utils.isStringNode)(node.arguments[0]);
 
-const isJestFunctionWithLiteralArg = node => ((0, _utils.isTestCase)(node) || (0, _utils.isDescribe)(node)) && node.callee.type === _experimentalUtils.AST_NODE_TYPES.Identifier && hasStringAsFirstArgument(node);
+const findNodeNameAndArgument = node => {
+  if (!((0, _utils.isTestCase)(node) || (0, _utils.isDescribe)(node))) {
+    return null;
+  }
+
+  if ((0, _utils.isEachCall)(node)) {
+    var _node$parent;
 
-const jestFunctionName = (node, allowedPrefixes) => {
-  const description = (0, _utils.getStringValue)(node.arguments[0]);
+    if (((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) === _experimentalUtils.AST_NODE_TYPES.CallExpression && hasStringAsFirstArgument(node.parent)) {
+      return [node.callee.object.name, node.parent.arguments[0]];
+    }
 
-  if (allowedPrefixes.some(name => description.startsWith(name))) {
     return null;
   }
 
-  const firstCharacter = description.charAt(0);
-
-  if (!firstCharacter || firstCharacter === firstCharacter.toLowerCase()) {
+  if (node.callee.type !== _experimentalUtils.AST_NODE_TYPES.Identifier || !hasStringAsFirstArgument(node)) {
     return null;
   }
 
-  return node.callee.name;
+  return [node.callee.name, node.arguments[0]];
 };
 
 var _default = (0, _utils.createRule)({
@@ -81,10 +85,6 @@ var _default = (0, _utils.createRule)({
     let numberOfDescribeBlocks = 0;
     return {
       CallExpression(node) {
-        if (!isJestFunctionWithLiteralArg(node)) {
-          return;
-        }
-
         if ((0, _utils.isDescribe)(node)) {
           numberOfDescribeBlocks++;
 
@@ -93,26 +93,40 @@ var _default = (0, _utils.createRule)({
           }
         }
 
-        const erroneousMethod = jestFunctionName(node, allowedPrefixes);
-
-        if (erroneousMethod && !ignore.includes(node.callee.name)) {
-          context.report({
-            messageId: 'unexpectedLowercase',
-            node: node.arguments[0],
-            data: {
-              method: erroneousMethod
-            },
-
-            fix(fixer) {
-              const [firstArg] = node.arguments;
-              const description = (0, _utils.getStringValue)(firstArg);
-              const rangeIgnoringQuotes = [firstArg.range[0] + 1, firstArg.range[1] - 1];
-              const newDescription = description.substring(0, 1).toLowerCase() + description.substring(1);
-              return [fixer.replaceTextRange(rangeIgnoringQuotes, newDescription)];
-            }
-
-          });
+        const results = findNodeNameAndArgument(node);
+
+        if (!results) {
+          return;
+        }
+
+        const [name, firstArg] = results;
+        const description = (0, _utils.getStringValue)(firstArg);
+
+        if (allowedPrefixes.some(name => description.startsWith(name))) {
+          return;
+        }
+
+        const firstCharacter = description.charAt(0);
+
+        if (!firstCharacter || firstCharacter === firstCharacter.toLowerCase() || ignore.includes(name)) {
+          return;
         }
+
+        context.report({
+          messageId: 'unexpectedLowercase',
+          node: node.arguments[0],
+          data: {
+            method: name
+          },
+
+          fix(fixer) {
+            const description = (0, _utils.getStringValue)(firstArg);
+            const rangeIgnoringQuotes = [firstArg.range[0] + 1, firstArg.range[1] - 1];
+            const newDescription = description.substring(0, 1).toLowerCase() + description.substring(1);
+            return [fixer.replaceTextRange(rangeIgnoringQuotes, newDescription)];
+          }
+
+        });
       },
 
       'CallExpression:exit'(node) {

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

@@ -50,9 +50,7 @@ var _default = (0, _utils.createRule)({
       },
 
       CallExpression(node) {
-        const functionName = (0, _utils.getNodeName)(node.callee); // prevent duplicate warnings for it.each()()
-
-        if (node.callee.type === 'CallExpression') return;
+        const functionName = (0, _utils.getNodeName)(node.callee);
 
         switch (functionName) {
           case 'describe.skip':
@@ -66,10 +64,6 @@ var _default = (0, _utils.createRule)({
           case 'it.concurrent.skip':
           case 'test.skip':
           case 'test.concurrent.skip':
-          case 'it.skip.each':
-          case 'test.skip.each':
-          case 'xit.each':
-          case 'xtest.each':
             context.report({
               messageId: 'skippedTest',
               node

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

@@ -5,8 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
-
 var _utils = require("./utils");
 
 var _default = (0, _utils.createRule)({
@@ -33,7 +31,6 @@ var _default = (0, _utils.createRule)({
         if (!nodeName || !(0, _utils.isDescribe)(node) && !(0, _utils.isTestCase)(node)) return;
         const preferredNodeName = getPreferredNodeName(nodeName);
         if (!preferredNodeName) return;
-        const funcNode = node.callee.type === _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee;
         context.report({
           messageId: 'usePreferredName',
           node: node.callee,
@@ -42,7 +39,7 @@ var _default = (0, _utils.createRule)({
           },
 
           fix(fixer) {
-            return [fixer.replaceText(funcNode, preferredNodeName)];
+            return [fixer.replaceText(node.callee, preferredNodeName)];
           }
 
         });
@@ -57,14 +54,13 @@ 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}`;
+    return `${nodeName.slice(1)}.only`;
   }
 
   if (firstChar === 'x') {
-    return `${nodeName.slice(1).replace('.each', '')}.skip${suffix}`;
+    return `${nodeName.slice(1)}.skip`;
   }
 
   return null;

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

@@ -53,7 +53,7 @@ var _default = (0, _utils.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        if ((0, _utils.isDescribe)(node)) {
+        if ((0, _utils.isDescribe)(node) && !(0, _utils.isEachCall)(node)) {
           numberOfDescribeBlocks--;
         }
       }

package/lib/rules/utils.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getNodeName = getNodeName;
-exports.scopeHasLocalReference = exports.getJestFunctionArguments = exports.isDescribeEach = exports.isDescribe = exports.isTestCase = exports.getTestCallExpressionsFromDeclaredVariables = exports.isHook = exports.isFunction = exports.TestCaseProperty = exports.DescribeProperty = exports.HookName = exports.TestCaseName = exports.DescribeAlias = exports.parseExpectCall = exports.isParsedEqualityMatcherCall = exports.EqualityMatcher = exports.ModifierName = exports.isExpectMember = exports.isExpectCall = exports.getAccessorValue = exports.isSupportedAccessor = exports.hasOnlyOneArgument = exports.getStringValue = exports.isStringNode = exports.followTypeAssertionChain = exports.createRule = void 0;
+exports.scopeHasLocalReference = exports.getJestFunctionArguments = exports.isEachCall = exports.isDescribe = exports.isTestCase = exports.getTestCallExpressionsFromDeclaredVariables = exports.isHook = exports.isFunction = exports.TestCaseProperty = exports.DescribeProperty = exports.HookName = exports.TestCaseName = exports.DescribeAlias = exports.parseExpectCall = exports.isParsedEqualityMatcherCall = exports.EqualityMatcher = exports.ModifierName = exports.isExpectMember = exports.isExpectCall = exports.getAccessorValue = exports.isSupportedAccessor = exports.hasOnlyOneArgument = exports.getStringValue = exports.isStringNode = exports.followTypeAssertionChain = exports.createRule = void 0;
 
 var _path = require("path");
 
@@ -363,9 +363,6 @@ function getNodeName(node) {
   }
 
   switch (node.type) {
-    case _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression:
-      return getNodeName(node.tag);
-
     case _experimentalUtils.AST_NODE_TYPES.MemberExpression:
       return joinNames(getNodeName(node.object), getNodeName(node.property));
 
@@ -395,24 +392,24 @@ const getTestCallExpressionsFromDeclaredVariables = declaredVariables => {
 
 exports.getTestCallExpressionsFromDeclaredVariables = getTestCallExpressionsFromDeclaredVariables;
 
-const isTestCase = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.name) || // e.g. it.each``()
-node.callee.type === _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression && node.callee.tag.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.callee.tag.property, TestCaseProperty.each) || // e.g. it.concurrent.{skip,only}
-node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && node.callee.property.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseProperty.hasOwnProperty(node.callee.property.name) && (node.callee.object.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.object.name) || node.callee.object.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && node.callee.object.object.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.object.object.name));
+const isTestCase = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.name) || node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && node.callee.property.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseProperty.hasOwnProperty(node.callee.property.name) && (node.callee.object.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.object.name) || node.callee.object.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && node.callee.object.object.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.callee.object.object.name));
 
 exports.isTestCase = isTestCase;
 
 const isDescribe = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.Identifier && DescribeAlias.hasOwnProperty(node.callee.name) || node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && node.callee.object.type === _experimentalUtils.AST_NODE_TYPES.Identifier && DescribeAlias.hasOwnProperty(node.callee.object.name) && node.callee.property.type === _experimentalUtils.AST_NODE_TYPES.Identifier && DescribeProperty.hasOwnProperty(node.callee.property.name);
 /**
- * Checks if the given `describe` is a call to `describe.each`.
+ * Checks if the given node` is a call to `<describe|test|it>.each(...)`.
+ * If `true`, the code must look like `<method>.each(...)`.
+ *
+ * @param {JestFunctionCallExpression<DescribeAlias | TestCaseName>} node
  *
- * @param {JestFunctionCallExpression<DescribeAlias>} node
- * @return {node is JestFunctionCallExpression<DescribeAlias, DescribeProperty.each>}
+ * @return {node is JestFunctionCallExpressionWithMemberExpressionCallee<DescribeAlias | TestCaseName, DescribeProperty.each | TestCaseProperty.each>}
  */
 
 
 exports.isDescribe = isDescribe;
 
-const isDescribeEach = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.callee.property, DescribeProperty.each);
+const isEachCall = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.callee.property, DescribeProperty.each);
 /**
  * Gets the arguments of the given `JestFunctionCallExpression`.
  *
@@ -425,7 +422,7 @@ const isDescribeEach = node => node.callee.type === _experimentalUtils.AST_NODE_
  */
 
 
-exports.isDescribeEach = isDescribeEach;
+exports.isEachCall = isEachCall;
 
 const getJestFunctionArguments = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.callee.property, DescribeProperty.each) && node.parent && node.parent.type === _experimentalUtils.AST_NODE_TYPES.CallExpression ? node.parent.arguments : node.arguments;
 

package/lib/rules/valid-describe.js

@@ -79,7 +79,7 @@ var _default = (0, _utils.createRule)({
           });
         }
 
-        if (!(0, _utils.isDescribeEach)(node) && callback.params.length) {
+        if (!(0, _utils.isEachCall)(node) && callback.params.length) {
           context.report({
             messageId: 'unexpectedDescribeArgument',
             loc: paramsLocation(callback.params)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "24.1.1",
+  "version": "24.1.5",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -105,7 +105,7 @@
     "eslint": "^5.1.0 || ^6.0.0 || ^7.0.0",
     "eslint-config-prettier": "^6.5.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-eslint-config": "^1.0.2",
+    "eslint-plugin-eslint-config": "^2.0.0",
     "eslint-plugin-eslint-plugin": "^2.0.0",
     "eslint-plugin-import": "^2.20.2",
     "eslint-plugin-node": "^11.0.0",