eslint-plugin-jest 27.1.5 → 27.1.7

package/README.md

@@ -273,7 +273,7 @@ set to warn in.\
 
 In order to use the rules powered by TypeScript type-checking, you must be using
 `@typescript-eslint/parser` & adjust your eslint config as outlined
-[here](https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/TYPED_LINTING.md).
+[here](https://typescript-eslint.io/docs/linting/typed-linting).
 
 Note that unlike the type-checking rules in `@typescript-eslint/eslint-plugin`,
 the rules here will fallback to doing nothing if type information is not

package/docs/rules/no-if.md

@@ -1,7 +1,7 @@
 # Disallow conditional logic (`no-if`)
 
 ❌ This rule is deprecated. It was replaced by
-[`no-conditional-in-test`](no-conditional-in-test.md).
+[`jest/no-conditional-in-test`](../../docs/rules/no-conditional-in-test.md).
 
 <!-- end auto-generated rule header -->
 

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

@@ -78,28 +78,31 @@ var _default = (0, _utils2.createRule)({
               callback: argument.name
             },
             fix(fixer) {
+              var _tokenAfterLastParam;
               const {
-                body
+                body,
+                params
               } = callback;
               const sourceCode = context.getSourceCode();
               const firstBodyToken = sourceCode.getFirstToken(body);
               const lastBodyToken = sourceCode.getLastToken(body);
-              const tokenBeforeArgument = sourceCode.getTokenBefore(argument);
-              const tokenAfterArgument = sourceCode.getTokenAfter(argument);
+              const [firstParam] = params;
+              const lastParam = params[params.length - 1];
+              const tokenBeforeFirstParam = sourceCode.getTokenBefore(firstParam);
+              let tokenAfterLastParam = sourceCode.getTokenAfter(lastParam);
+              if (((_tokenAfterLastParam = tokenAfterLastParam) === null || _tokenAfterLastParam === void 0 ? void 0 : _tokenAfterLastParam.value) === ',') {
+                tokenAfterLastParam = sourceCode.getTokenAfter(tokenAfterLastParam);
+              }
 
               /* istanbul ignore if */
-              if (!firstBodyToken || !lastBodyToken || !tokenBeforeArgument || !tokenAfterArgument) {
+              if (!firstBodyToken || !lastBodyToken || !tokenBeforeFirstParam || !tokenAfterLastParam) {
                 throw new Error(`Unexpected null when attempting to fix ${context.getFilename()} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
               }
-              const argumentInParens = tokenBeforeArgument.value === '(' && tokenAfterArgument.value === ')';
-              let argumentFix = fixer.replaceText(argument, '()');
-              if (argumentInParens) {
-                argumentFix = fixer.remove(argument);
-              }
-              let newCallback = argument.name;
-              if (argumentInParens) {
-                newCallback = `(${newCallback})`;
+              let argumentFix = fixer.replaceText(firstParam, '()');
+              if (tokenBeforeFirstParam.value === '(' && tokenAfterLastParam.value === ')') {
+                argumentFix = fixer.removeRange([tokenBeforeFirstParam.range[1], tokenAfterLastParam.range[0]]);
               }
+              const newCallback = argument.name;
               let beforeReplacement = `new Promise(${newCallback} => `;
               let afterReplacement = ')';
               let replaceBefore = true;

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

@@ -25,9 +25,9 @@ const isFirstStatement = node => {
   /* istanbul ignore next */
   throw new Error(`Could not find BlockStatement - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
 };
-const suggestRemovingExtraArguments = (args, extraArgsStartAt) => ({
+const suggestRemovingExtraArguments = (context, func, from) => ({
   messageId: 'suggestRemovingExtraArguments',
-  fix: fixer => fixer.removeRange([args[extraArgsStartAt].range[0] - Math.sign(extraArgsStartAt), args[args.length - 1].range[1]])
+  fix: fixer => (0, _utils2.removeExtraArgumentsFixer)(fixer, context, func, from)
 });
 var _default = (0, _utils2.createRule)({
   name: __filename,
@@ -97,13 +97,13 @@ var _default = (0, _utils2.createRule)({
       }
       return false;
     };
-    const checkExpectHasAssertions = expectFnCall => {
+    const checkExpectHasAssertions = (expectFnCall, func) => {
       if ((0, _utils2.getAccessorValue)(expectFnCall.members[0]) === 'hasAssertions') {
         if (expectFnCall.args.length) {
           context.report({
             messageId: 'hasAssertionsTakesNoArguments',
             node: expectFnCall.matcher,
-            suggest: [suggestRemovingExtraArguments(expectFnCall.args, 0)]
+            suggest: [suggestRemovingExtraArguments(context, func, 0)]
           });
         }
         return;
@@ -115,7 +115,7 @@ var _default = (0, _utils2.createRule)({
         const suggest = [];
         if (expectFnCall.args.length) {
           loc = expectFnCall.args[1].loc;
-          suggest.push(suggestRemovingExtraArguments(expectFnCall.args, 1));
+          suggest.push(suggestRemovingExtraArguments(context, func, 1));
         }
         context.report({
           messageId: 'assertionsRequiresOneArgument',
@@ -157,7 +157,7 @@ var _default = (0, _utils2.createRule)({
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'expect' && inTestCaseCall) {
           var _jestFnCall$head$node;
           if (expressionDepth === 1 && isFirstStatement(node) && ((_jestFnCall$head$node = jestFnCall.head.node.parent) === null || _jestFnCall$head$node === void 0 ? void 0 : _jestFnCall$head$node.type) === _utils.AST_NODE_TYPES.MemberExpression && jestFnCall.members.length === 1 && ['assertions', 'hasAssertions'].includes((0, _utils2.getAccessorValue)(jestFnCall.members[0]))) {
-            checkExpectHasAssertions(jestFnCall);
+            checkExpectHasAssertions(jestFnCall, node);
             hasExpectAssertionsAsFirstStatement = true;
           }
           if (inForLoop) {

package/lib/rules/prefer-spy-on.js

@@ -28,6 +28,16 @@ const getJestFnCall = node => {
   }
   return getJestFnCall(obj);
 };
+const getAutoFixMockImplementation = (jestFnCall, context) => {
+  var _jestFnCall$parent;
+  const hasMockImplementationAlready = ((_jestFnCall$parent = jestFnCall.parent) === null || _jestFnCall$parent === void 0 ? void 0 : _jestFnCall$parent.type) === _utils.AST_NODE_TYPES.MemberExpression && jestFnCall.parent.property.type === _utils.AST_NODE_TYPES.Identifier && jestFnCall.parent.property.name === 'mockImplementation';
+  if (hasMockImplementationAlready) {
+    return '';
+  }
+  const [arg] = jestFnCall.arguments;
+  const argSource = arg && context.getSourceCode().getText(arg);
+  return argSource ? `.mockImplementation(${argSource})` : '.mockImplementation()';
+};
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -58,10 +68,8 @@ var _default = (0, _utils2.createRule)({
           node,
           messageId: 'useJestSpyOn',
           fix(fixer) {
-            const leftPropQuote = left.property.type === _utils.AST_NODE_TYPES.Identifier ? "'" : '';
-            const [arg] = jestFnCall.arguments;
-            const argSource = arg && context.getSourceCode().getText(arg);
-            const mockImplementation = argSource ? `.mockImplementation(${argSource})` : '.mockImplementation()';
+            const leftPropQuote = left.property.type === _utils.AST_NODE_TYPES.Identifier && !left.computed ? "'" : '';
+            const mockImplementation = getAutoFixMockImplementation(jestFnCall, context);
             return [fixer.insertTextBefore(left, `jest.spyOn(`), fixer.replaceTextRange([left.object.range[1], left.property.range[0]], `, ${leftPropQuote}`), fixer.replaceTextRange([left.property.range[1], jestFnCall.range[1]], `${leftPropQuote})${mockImplementation}`)];
           }
         });

package/lib/rules/prefer-to-be.js

@@ -26,14 +26,14 @@ const shouldUseToBe = expectFnCall => {
   }
   return firstArg.type === _utils.AST_NODE_TYPES.TemplateLiteral;
 };
-const reportPreferToBe = (context, whatToBe, expectFnCall, modifierNode) => {
+const reportPreferToBe = (context, whatToBe, expectFnCall, func, modifierNode) => {
   context.report({
     messageId: `useToBe${whatToBe}`,
     fix(fixer) {
       var _expectFnCall$args;
       const fixes = [(0, _utils2.replaceAccessorFixer)(fixer, expectFnCall.matcher, `toBe${whatToBe}`)];
       if ((_expectFnCall$args = expectFnCall.args) !== null && _expectFnCall$args !== void 0 && _expectFnCall$args.length && whatToBe !== '') {
-        fixes.push(fixer.remove(expectFnCall.args[0]));
+        fixes.push((0, _utils2.removeExtraArgumentsFixer)(fixer, context, func, 0));
       }
       if (modifierNode) {
         fixes.push(fixer.removeRange([modifierNode.range[0] - 1, modifierNode.range[1]]));
@@ -73,27 +73,27 @@ var _default = (0, _utils2.createRule)({
         const matcherName = (0, _utils2.getAccessorValue)(jestFnCall.matcher);
         const notModifier = jestFnCall.modifiers.find(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
         if (notModifier && ['toBeUndefined', 'toBeDefined'].includes(matcherName)) {
-          reportPreferToBe(context, matcherName === 'toBeDefined' ? 'Undefined' : 'Defined', jestFnCall, notModifier);
+          reportPreferToBe(context, matcherName === 'toBeDefined' ? 'Undefined' : 'Defined', jestFnCall, node, notModifier);
           return;
         }
         if (!_utils2.EqualityMatcher.hasOwnProperty(matcherName) || jestFnCall.args.length === 0) {
           return;
         }
         if (isNullEqualityMatcher(jestFnCall)) {
-          reportPreferToBe(context, 'Null', jestFnCall);
+          reportPreferToBe(context, 'Null', jestFnCall, node);
           return;
         }
         if (isFirstArgumentIdentifier(jestFnCall, 'undefined')) {
           const name = notModifier ? 'Defined' : 'Undefined';
-          reportPreferToBe(context, name, jestFnCall, notModifier);
+          reportPreferToBe(context, name, jestFnCall, node, notModifier);
           return;
         }
         if (isFirstArgumentIdentifier(jestFnCall, 'NaN')) {
-          reportPreferToBe(context, 'NaN', jestFnCall);
+          reportPreferToBe(context, 'NaN', jestFnCall, node);
           return;
         }
         if (shouldUseToBe(jestFnCall) && matcherName !== _utils2.EqualityMatcher.toBe) {
-          reportPreferToBe(context, '', jestFnCall);
+          reportPreferToBe(context, '', jestFnCall, node);
         }
       }
     };

package/lib/rules/utils/misc.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getFirstMatcherArg = exports.findTopMostCallExpression = exports.createRule = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeAlias = void 0;
 exports.getNodeName = getNodeName;
-exports.replaceAccessorFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
+exports.replaceAccessorFixer = exports.removeExtraArgumentsFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
 var _path = require("path");
 var _utils = require("@typescript-eslint/utils");
 var _package = require("../../../package.json");
@@ -106,6 +106,17 @@ const replaceAccessorFixer = (fixer, node, text) => {
   return fixer.replaceText(node, node.type === _utils.AST_NODE_TYPES.Identifier ? text : `'${text}'`);
 };
 exports.replaceAccessorFixer = replaceAccessorFixer;
+const removeExtraArgumentsFixer = (fixer, context, func, from) => {
+  const firstArg = func.arguments[from];
+  const lastArg = func.arguments[func.arguments.length - 1];
+  const sourceCode = context.getSourceCode();
+  let tokenAfterLastParam = sourceCode.getTokenAfter(lastArg);
+  if (tokenAfterLastParam.value === ',') {
+    tokenAfterLastParam = sourceCode.getTokenAfter(tokenAfterLastParam);
+  }
+  return fixer.removeRange([firstArg.range[0], tokenAfterLastParam.range[0]]);
+};
+exports.removeExtraArgumentsFixer = removeExtraArgumentsFixer;
 const findTopMostCallExpression = node => {
   let topMostCallExpression = node;
   let {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.1.5",
+  "version": "27.1.7",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -29,7 +29,7 @@
     "prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
     "postpublish": "pinst --enable",
     "test": "jest",
-    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator --ignore-config all --rule-doc-title-format desc-parens-name --rule-doc-section-include \"Rule details\" --rule-list-columns name,description,configsError,configsWarn,configsOff,fixable,hasSuggestions,deprecated --split-by meta.docs.requiresTypeChecking --url-configs \"https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations\" && yarn prettier:write",
+    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator",
     "typecheck": "tsc -p ."
   },
   "commitlint": {
@@ -121,7 +121,7 @@
     "dedent": "^0.7.0",
     "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-doc-generator": "^0.19.0",
+    "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",
@@ -155,7 +155,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.2.4",
+  "packageManager": "yarn@3.3.0",
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   }