eslint-plugin-jest 27.1.2 → 27.1.4

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;

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

@@ -4,39 +4,34 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 const snapshotMatchers = ['toMatchSnapshot', 'toThrowErrorMatchingSnapshot'];
 const snapshotMatcherNames = snapshotMatchers;
-
 const isSnapshotMatcherWithoutHint = expectFnCall => {
   if (expectFnCall.args.length === 0) {
     return true;
-  } // this matcher only supports one argument which is the hint
-
+  }
 
+  // this matcher only supports one argument which is the hint
   if (!(0, _utils.isSupportedAccessor)(expectFnCall.matcher, 'toMatchSnapshot')) {
     return expectFnCall.args.length !== 1;
-  } // if we're being passed two arguments,
-  // the second one should be the hint
-
+  }
 
+  // if we're being passed two arguments,
+  // the second one should be the hint
   if (expectFnCall.args.length === 2) {
     return false;
   }
+  const [arg] = expectFnCall.args;
 
-  const [arg] = expectFnCall.args; // the first argument to `toMatchSnapshot` can be _either_ a snapshot hint or
+  // the first argument to `toMatchSnapshot` can be _either_ a snapshot hint or
   // an object with asymmetric matchers, so we can't just assume that the first
   // argument is a hint when it's by itself.
-
   return !(0, _utils.isStringNode)(arg);
 };
-
 const messages = {
   missingHint: 'You should provide a hint for this snapshot'
 };
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -53,12 +48,10 @@ var _default = (0, _utils.createRule)({
     }]
   },
   defaultOptions: ['multi'],
-
   create(context, [mode]) {
     const snapshotMatchers = [];
     const depths = [];
     let expressionDepth = 0;
-
     const reportSnapshotMatchersWithoutHints = () => {
       for (const snapshotMatcher of snapshotMatchers) {
         if (isSnapshotMatcherWithoutHint(snapshotMatcher)) {
@@ -69,70 +62,53 @@ var _default = (0, _utils.createRule)({
         }
       }
     };
-
     const enterExpression = () => {
       expressionDepth++;
     };
-
     const exitExpression = () => {
       expressionDepth--;
-
       if (mode === 'always') {
         reportSnapshotMatchersWithoutHints();
         snapshotMatchers.length = 0;
       }
-
       if (mode === 'multi' && expressionDepth === 0) {
         if (snapshotMatchers.length > 1) {
           reportSnapshotMatchersWithoutHints();
         }
-
         snapshotMatchers.length = 0;
       }
     };
-
     return {
       'Program:exit'() {
         enterExpression();
         exitExpression();
       },
-
       FunctionExpression: enterExpression,
       'FunctionExpression:exit': exitExpression,
       ArrowFunctionExpression: enterExpression,
       'ArrowFunctionExpression:exit': exitExpression,
-
       'CallExpression:exit'(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['describe', 'test'])) {
           /* istanbul ignore next */
           expressionDepth = depths.pop() ?? 0;
         }
       },
-
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'describe' || (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test') {
             depths.push(expressionDepth);
             expressionDepth = 0;
           }
-
           return;
         }
-
         const matcherName = (0, _utils.getAccessorValue)(jestFnCall.matcher);
-
         if (!snapshotMatcherNames.includes(matcherName)) {
           return;
         }
-
         snapshotMatchers.push(jestFnCall);
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,41 +4,30 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const findNodeObject = node => {
   if ('object' in node) {
     return node.object;
   }
-
   if (node.callee.type === _utils.AST_NODE_TYPES.MemberExpression) {
     return node.callee.object;
   }
-
   return null;
 };
-
 const getJestFnCall = node => {
   if (node.type !== _utils.AST_NODE_TYPES.CallExpression && node.type !== _utils.AST_NODE_TYPES.MemberExpression) {
     return null;
   }
-
   const obj = findNodeObject(node);
-
   if (!obj) {
     return null;
   }
-
   if (obj.type === _utils.AST_NODE_TYPES.Identifier) {
     return node.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.getNodeName)(node.callee) === 'jest.fn' ? node : null;
   }
-
   return getJestFnCall(obj);
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -55,7 +44,6 @@ var _default = (0, _utils2.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     return {
       AssignmentExpression(node) {
@@ -69,7 +57,6 @@ var _default = (0, _utils2.createRule)({
         context.report({
           node,
           messageId: 'useJestSpyOn',
-
           fix(fixer) {
             const leftPropQuote = left.property.type === _utils.AST_NODE_TYPES.Identifier ? "'" : '';
             const [arg] = jestFnCall.arguments;
@@ -77,13 +64,9 @@ var _default = (0, _utils2.createRule)({
             const mockImplementation = argSource ? `.mockImplementation(${argSource})` : '.mockImplementation()';
             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}`)];
           }
-
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-strict-equal.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: {
@@ -24,20 +22,16 @@ var _default = (0, _utils.createRule)({
     hasSuggestions: true
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
-
         const {
           matcher
         } = jestFnCall;
-
         if ((0, _utils.isSupportedAccessor)(matcher, 'toEqual')) {
           context.report({
             messageId: 'useToStrictEqual',
@@ -49,10 +43,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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

@@ -4,62 +4,45 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const isNullLiteral = node => node.type === _utils.AST_NODE_TYPES.Literal && node.value === null;
+
 /**
  * Checks if the given `ParsedEqualityMatcherCall` is a call to one of the equality matchers,
  * with a `null` literal as the sole argument.
  */
-
-
 const isNullEqualityMatcher = expectFnCall => isNullLiteral((0, _utils2.getFirstMatcherArg)(expectFnCall));
-
 const isFirstArgumentIdentifier = (expectFnCall, name) => (0, _utils2.isIdentifier)((0, _utils2.getFirstMatcherArg)(expectFnCall), name);
-
 const shouldUseToBe = expectFnCall => {
   let firstArg = (0, _utils2.getFirstMatcherArg)(expectFnCall);
-
   if (firstArg.type === _utils.AST_NODE_TYPES.UnaryExpression && firstArg.operator === '-') {
     firstArg = firstArg.argument;
   }
-
   if (firstArg.type === _utils.AST_NODE_TYPES.Literal) {
     // regex literals are classed as literals, but they're actually objects
     // which means "toBe" will give different results than other matchers
     return !('regex' in firstArg);
   }
-
   return firstArg.type === _utils.AST_NODE_TYPES.TemplateLiteral;
 };
-
 const reportPreferToBe = (context, whatToBe, expectFnCall, 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]));
       }
-
       if (modifierNode) {
         fixes.push(fixer.removeRange([modifierNode.range[0] - 1, modifierNode.range[1]]));
       }
-
       return fixes;
     },
-
     node: expectFnCall.matcher
   });
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -80,52 +63,40 @@ 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') {
           return;
         }
-
         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);
           return;
         }
-
         if (!_utils2.EqualityMatcher.hasOwnProperty(matcherName) || jestFnCall.args.length === 0) {
           return;
         }
-
         if (isNullEqualityMatcher(jestFnCall)) {
           reportPreferToBe(context, 'Null', jestFnCall);
           return;
         }
-
         if (isFirstArgumentIdentifier(jestFnCall, 'undefined')) {
           const name = notModifier ? 'Defined' : 'Undefined';
           reportPreferToBe(context, name, jestFnCall, notModifier);
           return;
         }
-
         if (isFirstArgumentIdentifier(jestFnCall, 'NaN')) {
           reportPreferToBe(context, 'NaN', jestFnCall);
           return;
         }
-
         if (shouldUseToBe(jestFnCall) && matcherName !== _utils2.EqualityMatcher.toBe) {
           reportPreferToBe(context, '', jestFnCall);
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-to-contain.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");
-
 /**
  * Checks if the given `node` is a `CallExpression` representing the calling
  * of an `includes`-like method that can be 'fixed' (using `toContain`).
@@ -17,9 +14,9 @@ var _utils2 = require("./utils");
  *
  * @return {node is FixableIncludesCallExpression}
  */
-const isFixableIncludesCallExpression = node => node.type === _utils.AST_NODE_TYPES.CallExpression && node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'includes') && (0, _utils2.hasOnlyOneArgument)(node) && node.arguments[0].type !== _utils.AST_NODE_TYPES.SpreadElement; // expect(array.includes(<value>)[not.]{toBe,toEqual}(<boolean>)
-
+const isFixableIncludesCallExpression = node => node.type === _utils.AST_NODE_TYPES.CallExpression && node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'includes') && (0, _utils2.hasOnlyOneArgument)(node) && node.arguments[0].type !== _utils.AST_NODE_TYPES.SpreadElement;
 
+// expect(array.includes(<value>)[not.]{toBe,toEqual}(<boolean>)
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -36,24 +33,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: [includesCall],
           range: [, expectCallEnd]
@@ -62,32 +54,30 @@ var _default = (0, _utils2.createRule)({
           matcher
         } = jestFnCall;
         const matcherArg = (0, _utils2.getFirstMatcherArg)(jestFnCall);
-
         if (!includesCall || matcherArg.type === _utils.AST_NODE_TYPES.SpreadElement || !_utils2.EqualityMatcher.hasOwnProperty((0, _utils2.getAccessorValue)(matcher)) || !(0, _utils2.isBooleanLiteral)(matcherArg) || !isFixableIncludesCallExpression(includesCall)) {
           return;
         }
-
         const hasNot = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
         context.report({
           fix(fixer) {
-            const sourceCode = context.getSourceCode(); // we need to negate the expectation if the current expected
-            // value is itself negated by the "not" modifier
+            const sourceCode = context.getSourceCode();
 
+            // we need to negate the expectation if the current expected
+            // value is itself negated by the "not" modifier
             const addNotModifier = matcherArg.value === hasNot;
-            return [// remove the "includes" call entirely
-            fixer.removeRange([includesCall.callee.property.range[0] - 1, includesCall.range[1]]), // replace the current matcher with "toContain", adding "not" if needed
-            fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], addNotModifier ? `.${_utils2.ModifierName.not}.toContain` : '.toContain'), // replace the matcher argument with the value from the "includes"
+            return [
+            // remove the "includes" call entirely
+            fixer.removeRange([includesCall.callee.property.range[0] - 1, includesCall.range[1]]),
+            // replace the current matcher with "toContain", adding "not" if needed
+            fixer.replaceTextRange([expectCallEnd, matcher.parent.range[1]], addNotModifier ? `.${_utils2.ModifierName.not}.toContain` : '.toContain'),
+            // replace the matcher argument with the value from the "includes"
             fixer.replaceText(jestFnCall.args[0], sourceCode.getText(includesCall.arguments[0]))];
           },
-
           messageId: 'useToContain',
           node: matcher
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-to-have-length.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: {
@@ -25,48 +22,39 @@ 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') {
           return;
         }
-
         const {
           parent: expect
         } = jestFnCall.head.node;
-
         if ((expect === null || expect === void 0 ? void 0 : expect.type) !== _utils.AST_NODE_TYPES.CallExpression) {
           return;
         }
-
         const [argument] = expect.arguments;
         const {
           matcher
         } = jestFnCall;
-
         if (!_utils2.EqualityMatcher.hasOwnProperty((0, _utils2.getAccessorValue)(matcher)) || (argument === null || argument === void 0 ? void 0 : argument.type) !== _utils.AST_NODE_TYPES.MemberExpression || !(0, _utils2.isSupportedAccessor)(argument.property, 'length')) {
           return;
         }
-
         context.report({
           fix(fixer) {
-            return [// remove the "length" property accessor
-            fixer.removeRange([argument.property.range[0] - 1, argument.range[1]]), // replace the current matcher with "toHaveLength"
+            return [
+            // remove the "length" property accessor
+            fixer.removeRange([argument.property.range[0] - 1, argument.range[1]]),
+            // replace the current matcher with "toHaveLength"
             fixer.replaceTextRange([matcher.parent.object.range[1], matcher.parent.range[1]], '.toHaveLength')];
           },
-
           messageId: 'useToHaveLength',
           node: matcher
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;