eslint-plugin-jest 26.8.7 → 27.1.6

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

@@ -4,46 +4,38 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const isFirstStatement = node => {
   let parent = node;
-
   while (parent) {
-    var _parent$parent;
-
+    var _parent$parent, _parent$parent2;
     if (((_parent$parent = parent.parent) === null || _parent$parent === void 0 ? void 0 : _parent$parent.type) === _utils.AST_NODE_TYPES.BlockStatement) {
       return parent.parent.body[0] === parent;
     }
 
+    // if we've hit an arrow function, then it must have a single expression
+    // as its body, as otherwise we would have hit the block statement already
+    if (((_parent$parent2 = parent.parent) === null || _parent$parent2 === void 0 ? void 0 : _parent$parent2.type) === _utils.AST_NODE_TYPES.ArrowFunctionExpression) {
+      return true;
+    }
     parent = parent.parent;
   }
-  /* istanbul ignore next */
-
 
+  /* 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)
 });
-
-// const suggestions: Array<[MessageIds, string]> = [
-//   ['suggestAddingHasAssertions', 'expect.hasAssertions();'],
-//   ['suggestAddingAssertions', 'expect.assertions();'],
-// ];
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
       category: 'Best Practices',
       description: 'Suggest using `expect.assertions()` OR `expect.hasAssertions()`',
-      recommended: false,
-      suggestion: true
+      recommended: false
     },
     messages: {
       hasAssertionsTakesNoArguments: '`expect.hasAssertions` expects no arguments',
@@ -77,7 +69,6 @@ var _default = (0, _utils2.createRule)({
     onlyFunctionsWithExpectInLoop: false,
     onlyFunctionsWithExpectInCallback: false
   }],
-
   create(context, [options]) {
     let expressionDepth = 0;
     let hasExpectInCallback = false;
@@ -85,57 +76,47 @@ var _default = (0, _utils2.createRule)({
     let hasExpectAssertionsAsFirstStatement = false;
     let inTestCaseCall = false;
     let inForLoop = false;
-
     const shouldCheckFunction = testFunction => {
       if (!options.onlyFunctionsWithAsyncKeyword && !options.onlyFunctionsWithExpectInLoop && !options.onlyFunctionsWithExpectInCallback) {
         return true;
       }
-
       if (options.onlyFunctionsWithAsyncKeyword) {
         if (testFunction.async) {
           return true;
         }
       }
-
       if (options.onlyFunctionsWithExpectInLoop) {
         if (hasExpectInLoop) {
           return true;
         }
       }
-
       if (options.onlyFunctionsWithExpectInCallback) {
         if (hasExpectInCallback) {
           return true;
         }
       }
-
       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;
       }
-
       if (expectFnCall.args.length !== 1) {
         let {
           loc
         } = expectFnCall.matcher;
         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',
           suggest,
@@ -143,27 +124,19 @@ var _default = (0, _utils2.createRule)({
         });
         return;
       }
-
       const [arg] = expectFnCall.args;
-
       if (arg.type === _utils.AST_NODE_TYPES.Literal && typeof arg.value === 'number' && Number.isInteger(arg.value)) {
         return;
       }
-
       context.report({
         messageId: 'assertionsRequiresNumberArgument',
         node: arg
       });
     };
-
     const enterExpression = () => inTestCaseCall && expressionDepth++;
-
     const exitExpression = () => inTestCaseCall && expressionDepth--;
-
     const enterForLoop = () => inForLoop = true;
-
     const exitForLoop = () => inForLoop = false;
-
     return {
       FunctionExpression: enterExpression,
       'FunctionExpression:exit': exitExpression,
@@ -175,64 +148,48 @@ var _default = (0, _utils2.createRule)({
       'ForInStatement:exit': exitForLoop,
       ForOfStatement: enterForLoop,
       'ForOfStatement:exit': exitForLoop,
-
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test') {
           inTestCaseCall = true;
           return;
         }
-
         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) {
             hasExpectInLoop = true;
           }
-
           if (expressionDepth > 1) {
             hasExpectInCallback = true;
           }
         }
       },
-
       'CallExpression:exit'(node) {
         if (!(0, _utils2.isTypeOfJestFnCall)(node, context, ['test'])) {
           return;
         }
-
         inTestCaseCall = false;
-
         if (node.arguments.length < 2) {
           return;
         }
-
         const [, testFn] = node.arguments;
-
         if (!(0, _utils2.isFunction)(testFn) || !shouldCheckFunction(testFn)) {
           return;
         }
-
         hasExpectInLoop = false;
         hasExpectInCallback = false;
-
         if (hasExpectAssertionsAsFirstStatement) {
           hasExpectAssertionsAsFirstStatement = false;
           return;
         }
-
         const suggestions = [];
-
         if (testFn.body.type === _utils.AST_NODE_TYPES.BlockStatement) {
           suggestions.push(['suggestAddingHasAssertions', 'expect.hasAssertions();'], ['suggestAddingAssertions', 'expect.assertions();']);
         }
-
         context.report({
           messageId: 'haveExpectAssertions',
           node,
@@ -242,10 +199,7 @@ var _default = (0, _utils2.createRule)({
           }))
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -28,35 +25,26 @@ var _default = (0, _utils2.createRule)({
   create: context => ({
     CallExpression(node) {
       const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
       if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
         return;
       }
-
       const {
         parent
       } = jestFnCall.head.node;
-
       if ((parent === null || parent === void 0 ? void 0 : parent.type) !== _utils.AST_NODE_TYPES.CallExpression) {
         return;
       }
-
       const [awaitNode] = parent.arguments;
-
       if ((awaitNode === null || awaitNode === void 0 ? void 0 : awaitNode.type) === _utils.AST_NODE_TYPES.AwaitExpression) {
         context.report({
           node: awaitNode,
           messageId: 'expectResolves',
-
           fix(fixer) {
             return [fixer.insertTextBefore(parent, 'await '), fixer.removeRange([awaitNode.range[0], awaitNode.argument.range[0]]), fixer.insertTextAfter(parent, '.resolves')];
           }
-
         });
       }
     }
-
   })
 });
-
 exports.default = _default;

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

@@ -4,11 +4,8 @@ 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: {
@@ -24,7 +21,6 @@ var _default = (0, _utils.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     let previousHookIndex = -1;
     let inHook = false;
@@ -34,19 +30,15 @@ var _default = (0, _utils.createRule)({
           // Ignore everything that is passed into a hook
           return;
         }
-
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         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',
@@ -58,27 +50,21 @@ var _default = (0, _utils.createRule)({
           });
           return;
         }
-
         previousHookIndex = currentHookIndex;
       },
-
       'CallExpression:exit'(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['hook'])) {
           inHook = false;
           return;
         }
-
         if (inHook) {
           return;
-        } // Reset the previousHookIndex when encountering something different from a hook
-
+        }
 
+        // Reset the previousHookIndex when encountering something different from a hook
         previousHookIndex = -1;
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,9 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -22,7 +20,6 @@ var _default = (0, _utils.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     const hooksContext = [false];
     return {
@@ -30,24 +27,18 @@ var _default = (0, _utils.createRule)({
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['test'])) {
           hooksContext[hooksContext.length - 1] = true;
         }
-
         if (hooksContext[hooksContext.length - 1] && (0, _utils.isTypeOfJestFnCall)(node, context, ['hook'])) {
           context.report({
             messageId: 'noHookOnTop',
             node
           });
         }
-
         hooksContext.push(false);
       },
-
       'CallExpression:exit'() {
         hooksContext.pop();
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,29 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 const hasStringAsFirstArgument = node => node.arguments[0] && (0, _utils.isStringNode)(node.arguments[0]);
-
 const populateIgnores = ignore => {
   const ignores = [];
-
   if (ignore.includes(_utils.DescribeAlias.describe)) {
     ignores.push(...Object.keys(_utils.DescribeAlias));
   }
-
   if (ignore.includes(_utils.TestCaseName.test)) {
     ignores.push(...Object.keys(_utils.TestCaseName).filter(k => k.endsWith(_utils.TestCaseName.test)));
   }
-
   if (ignore.includes(_utils.TestCaseName.it)) {
     ignores.push(...Object.keys(_utils.TestCaseName).filter(k => k.endsWith(_utils.TestCaseName.it)));
   }
-
   return ignores;
 };
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -70,7 +62,6 @@ var _default = (0, _utils.createRule)({
     allowedPrefixes: [],
     ignoreTopLevelDescribe: false
   }],
-
   create(context, [{
     ignore = [],
     allowedPrefixes = [],
@@ -81,60 +72,46 @@ var _default = (0, _utils.createRule)({
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if (!jestFnCall || !hasStringAsFirstArgument(node)) {
           return;
         }
-
         if (jestFnCall.type === 'describe') {
           numberOfDescribeBlocks++;
-
           if (ignoreTopLevelDescribe && numberOfDescribeBlocks === 1) {
             return;
           }
         } else if (jestFnCall.type !== 'test') {
           return;
         }
-
         const [firstArg] = node.arguments;
         const description = (0, _utils.getStringValue)(firstArg);
-
         if (allowedPrefixes.some(name => description.startsWith(name))) {
           return;
         }
-
         const firstCharacter = description.charAt(0);
-
         if (!firstCharacter || firstCharacter === firstCharacter.toLowerCase() || ignores.includes(jestFnCall.name)) {
           return;
         }
-
         context.report({
           messageId: 'unexpectedLowercase',
           node: node.arguments[0],
           data: {
             method: jestFnCall.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) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['describe'])) {
           numberOfDescribeBlocks--;
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-mock-promise-shorthand.js

@@ -4,29 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const withOnce = (name, addOnce) => {
   return `${name}${addOnce ? 'Once' : ''}`;
 };
-
 const findSingleReturnArgumentNode = fnNode => {
   var _fnNode$body$body$;
-
   if (fnNode.body.type !== _utils.AST_NODE_TYPES.BlockStatement) {
     return fnNode.body;
   }
-
   if (((_fnNode$body$body$ = fnNode.body.body[0]) === null || _fnNode$body$body$ === void 0 ? void 0 : _fnNode$body$body$.type) === _utils.AST_NODE_TYPES.ReturnStatement) {
     return fnNode.body.body[0].argument;
   }
-
   return null;
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -43,19 +35,15 @@ var _default = (0, _utils2.createRule)({
     fixable: 'code'
   },
   defaultOptions: [],
-
   create(context) {
     const report = (property, isOnce, outerArgNode, innerArgNode = outerArgNode) => {
       if ((innerArgNode === null || innerArgNode === void 0 ? void 0 : innerArgNode.type) !== _utils.AST_NODE_TYPES.CallExpression) {
         return;
       }
-
       const argName = (0, _utils2.getNodeName)(innerArgNode);
-
       if (argName !== 'Promise.resolve' && argName !== 'Promise.reject') {
         return;
       }
-
       const replacement = withOnce(argName.endsWith('reject') ? 'mockRejectedValue' : 'mockResolvedValue', isOnce);
       context.report({
         node: property,
@@ -63,49 +51,40 @@ var _default = (0, _utils2.createRule)({
         data: {
           replacement
         },
-
         fix(fixer) {
-          const sourceCode = context.getSourceCode(); // there shouldn't be more than one argument, but if there is don't try
-          // fixing since we have no idea what to do with the extra arguments
+          const sourceCode = context.getSourceCode();
 
+          // there shouldn't be more than one argument, but if there is don't try
+          // fixing since we have no idea what to do with the extra arguments
           if (innerArgNode.arguments.length > 1) {
             return null;
           }
-
-          return [fixer.replaceText(property, replacement), fixer.replaceText(outerArgNode, // the value argument for both Promise methods is optional,
+          return [fixer.replaceText(property, replacement), fixer.replaceText(outerArgNode,
+          // the value argument for both Promise methods is optional,
           // whereas for Jest they're required so use an explicit undefined
           // if no argument is being passed to the call we're replacing
           innerArgNode.arguments.length === 1 ? sourceCode.getText(innerArgNode.arguments[0]) : 'undefined')];
         }
-
       });
     };
-
     return {
       CallExpression(node) {
         if (node.callee.type !== _utils.AST_NODE_TYPES.MemberExpression || !(0, _utils2.isSupportedAccessor)(node.callee.property) || node.arguments.length === 0) {
           return;
         }
-
         const mockFnName = (0, _utils2.getAccessorValue)(node.callee.property);
         const isOnce = mockFnName.endsWith('Once');
-
         if (mockFnName === withOnce('mockReturnValue', isOnce)) {
           report(node.callee.property, isOnce, node.arguments[0]);
         } else if (mockFnName === withOnce('mockImplementation', isOnce)) {
           const [arg] = node.arguments;
-
           if (!(0, _utils2.isFunction)(arg) || arg.params.length !== 0) {
             return;
           }
-
           report(node.callee.property, isOnce, arg, findSingleReturnArgumentNode(arg));
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;