eslint-plugin-jest 27.1.1 → 27.1.3

package/lib/rules/prefer-comparison-matcher.js

@@ -4,57 +4,41 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const isString = node => {
   return (0, _utils2.isStringNode)(node) || node.type === _utils.AST_NODE_TYPES.TemplateLiteral;
 };
-
 const isComparingToString = expression => {
   return isString(expression.left) || isString(expression.right);
 };
-
 const invertOperator = operator => {
   switch (operator) {
     case '>':
       return '<=';
-
     case '<':
       return '>=';
-
     case '>=':
       return '<';
-
     case '<=':
       return '>';
   }
-
   return null;
 };
-
 const determineMatcher = (operator, negated) => {
   const op = negated ? invertOperator(operator) : operator;
-
   switch (op) {
     case '>':
       return 'toBeGreaterThan';
-
     case '<':
       return 'toBeLessThan';
-
     case '>=':
       return 'toBeGreaterThanOrEqual';
-
     case '<=':
       return 'toBeLessThanOrEqual';
   }
-
   return null;
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -71,24 +55,19 @@ var _default = (0, _utils2.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect' || jestFnCall.args.length === 0) {
           return;
         }
-
         const {
           parent: expect
         } = jestFnCall.head.node;
-
         if ((expect === null || expect === void 0 ? void 0 : expect.type) !== _utils.AST_NODE_TYPES.CallExpression) {
           return;
         }
-
         const {
           arguments: [comparison],
           range: [, expectCallEnd]
@@ -97,30 +76,29 @@ var _default = (0, _utils2.createRule)({
           matcher
         } = jestFnCall;
         const matcherArg = (0, _utils2.getFirstMatcherArg)(jestFnCall);
-
         if ((comparison === null || comparison === void 0 ? void 0 : comparison.type) !== _utils.AST_NODE_TYPES.BinaryExpression || isComparingToString(comparison) || !_utils2.EqualityMatcher.hasOwnProperty((0, _utils2.getAccessorValue)(matcher)) || !(0, _utils2.isBooleanLiteral)(matcherArg)) {
           return;
         }
-
         const [modifier] = jestFnCall.modifiers;
         const hasNot = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
         const preferredMatcher = determineMatcher(comparison.operator, matcherArg.value === hasNot);
-
         if (!preferredMatcher) {
           return;
         }
-
         context.report({
           fix(fixer) {
-            const sourceCode = context.getSourceCode(); // preserve the existing modifier if it's not a negation
+            const sourceCode = context.getSourceCode();
 
+            // preserve the existing modifier if it's not a negation
             const modifierText = modifier && (0, _utils2.getAccessorValue)(modifier) !== 'not' ? `.${(0, _utils2.getAccessorValue)(modifier)}` : '';
-            return [// replace the comparison argument with the left-hand side of the comparison
-            fixer.replaceText(comparison, sourceCode.getText(comparison.left)), // replace the current matcher & modifier with the preferred matcher
-            fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], `${modifierText}.${preferredMatcher}`), // replace the matcher argument with the right-hand side of the comparison
+            return [
+            // replace the comparison argument with the left-hand side of the comparison
+            fixer.replaceText(comparison, sourceCode.getText(comparison.left)),
+            // replace the current matcher & modifier with the preferred matcher
+            fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], `${modifierText}.${preferredMatcher}`),
+            // replace the matcher argument with the right-hand side of the comparison
             fixer.replaceText(matcherArg, sourceCode.getText(comparison.right))];
           },
-
           messageId: 'useToBeComparison',
           data: {
             preferredMatcher
@@ -128,10 +106,7 @@ var _default = (0, _utils2.createRule)({
           node: matcher
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-each.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,32 +20,25 @@ var _default = (0, _utils.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     const jestFnCalls = [];
     let inTestCaseCall = false;
-
     const recommendFn = () => {
       if (jestFnCalls.length === 1 && jestFnCalls[0] === 'test') {
         return 'it';
       }
-
       return 'describe';
     };
-
     const enterForLoop = () => {
       if (jestFnCalls.length === 0 || inTestCaseCall) {
         return;
       }
-
       jestFnCalls.length = 0;
     };
-
     const exitForLoop = node => {
       if (jestFnCalls.length === 0 || inTestCaseCall) {
         return;
       }
-
       context.report({
         node,
         messageId: 'preferEach',
@@ -57,7 +48,6 @@ var _default = (0, _utils.createRule)({
       });
       jestFnCalls.length = 0;
     };
-
     return {
       ForStatement: enterForLoop,
       'ForStatement:exit': exitForLoop,
@@ -65,34 +55,26 @@ var _default = (0, _utils.createRule)({
       'ForInStatement:exit': exitForLoop,
       ForOfStatement: enterForLoop,
       'ForOfStatement:exit': exitForLoop,
-
       CallExpression(node) {
         const {
           type: jestFnCallType
         } = (0, _utils.parseJestFnCall)(node, context) ?? {};
-
         if (jestFnCallType === 'hook' || jestFnCallType === 'describe' || jestFnCallType === 'test') {
           jestFnCalls.push(jestFnCallType);
         }
-
         if (jestFnCallType === 'test') {
           inTestCaseCall = true;
         }
       },
-
       'CallExpression:exit'(node) {
         const {
           type: jestFnCallType
         } = (0, _utils.parseJestFnCall)(node, context) ?? {};
-
         if (jestFnCallType === 'test') {
           inTestCaseCall = false;
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-equality-matcher.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: {
@@ -26,24 +23,19 @@ var _default = (0, _utils2.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect' || jestFnCall.args.length === 0) {
           return;
         }
-
         const {
           parent: expect
         } = jestFnCall.head.node;
-
         if ((expect === null || expect === void 0 ? void 0 : expect.type) !== _utils.AST_NODE_TYPES.CallExpression) {
           return;
         }
-
         const {
           arguments: [comparison],
           range: [, expectCallEnd]
@@ -52,33 +44,32 @@ var _default = (0, _utils2.createRule)({
           matcher
         } = jestFnCall;
         const matcherArg = (0, _utils2.getFirstMatcherArg)(jestFnCall);
-
         if ((comparison === null || comparison === void 0 ? void 0 : comparison.type) !== _utils.AST_NODE_TYPES.BinaryExpression || comparison.operator !== '===' && comparison.operator !== '!==' || !_utils2.EqualityMatcher.hasOwnProperty((0, _utils2.getAccessorValue)(matcher)) || !(0, _utils2.isBooleanLiteral)(matcherArg)) {
           return;
         }
-
         const matcherValue = matcherArg.value;
         const [modifier] = jestFnCall.modifiers;
-        const hasNot = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) === 'not'); // we need to negate the expectation if the current expected
-        // value is itself negated by the "not" modifier
+        const hasNot = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
 
+        // we need to negate the expectation if the current expected
+        // value is itself negated by the "not" modifier
         const addNotModifier = (comparison.operator === '!==' ? !matcherValue : matcherValue) === hasNot;
-
         const buildFixer = equalityMatcher => fixer => {
-          const sourceCode = context.getSourceCode(); // preserve the existing modifier if it's not a negation
+          const sourceCode = context.getSourceCode();
 
+          // preserve the existing modifier if it's not a negation
           let modifierText = modifier && (0, _utils2.getAccessorValue)(modifier) !== 'not' ? `.${(0, _utils2.getAccessorValue)(modifier)}` : '';
-
           if (addNotModifier) {
             modifierText += `.${_utils2.ModifierName.not}`;
           }
-
-          return [// replace the comparison argument with the left-hand side of the comparison
-          fixer.replaceText(comparison, sourceCode.getText(comparison.left)), // replace the current matcher & modifier with the preferred matcher
-          fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], `${modifierText}.${equalityMatcher}`), // replace the matcher argument with the right-hand side of the comparison
+          return [
+          // replace the comparison argument with the left-hand side of the comparison
+          fixer.replaceText(comparison, sourceCode.getText(comparison.left)),
+          // replace the current matcher & modifier with the preferred matcher
+          fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], `${modifierText}.${equalityMatcher}`),
+          // replace the matcher argument with the right-hand side of the comparison
           fixer.replaceText(matcherArg, sourceCode.getText(comparison.right))];
         };
-
         context.report({
           messageId: 'useEqualityMatcher',
           suggest: ['toBe', 'toEqual', 'toStrictEqual'].map(equalityMatcher => ({
@@ -91,10 +82,7 @@ var _default = (0, _utils2.createRule)({
           node: matcher
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,40 +4,31 @@ 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, _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 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) => ({
   messageId: 'suggestRemovingExtraArguments',
   fix: fixer => fixer.removeRange([args[extraArgsStartAt].range[0] - Math.sign(extraArgsStartAt), args[args.length - 1].range[1]])
 });
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -78,7 +69,6 @@ var _default = (0, _utils2.createRule)({
     onlyFunctionsWithExpectInLoop: false,
     onlyFunctionsWithExpectInCallback: false
   }],
-
   create(context, [options]) {
     let expressionDepth = 0;
     let hasExpectInCallback = false;
@@ -86,33 +76,27 @@ 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 => {
       if ((0, _utils2.getAccessorValue)(expectFnCall.members[0]) === 'hasAssertions') {
         if (expectFnCall.args.length) {
@@ -122,21 +106,17 @@ var _default = (0, _utils2.createRule)({
             suggest: [suggestRemovingExtraArguments(expectFnCall.args, 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));
         }
-
         context.report({
           messageId: 'assertionsRequiresOneArgument',
           suggest,
@@ -144,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,
@@ -176,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);
             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,
@@ -243,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;