eslint-plugin-jest 26.7.0 → 26.8.0

package/lib/rules/prefer-strict-equal.js

@@ -29,21 +29,23 @@ var _default = (0, _utils.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils.isExpectCall)(node)) {
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
 
         const {
           matcher
-        } = (0, _utils.parseExpectCall)(node);
+        } = jestFnCall;
 
-        if (matcher && (0, _utils.isParsedEqualityMatcherCall)(matcher, _utils.EqualityMatcher.toEqual)) {
+        if ((0, _utils.isSupportedAccessor)(matcher, 'toEqual')) {
           context.report({
             messageId: 'useToStrictEqual',
-            node: matcher.node.property,
+            node: matcher,
             suggest: [{
               messageId: 'suggestReplaceWithStrictEqual',
-              fix: fixer => [(0, _utils.replaceAccessorFixer)(fixer, matcher.node.property, _utils.EqualityMatcher.toStrictEqual)]
+              fix: fixer => [(0, _utils.replaceAccessorFixer)(fixer, matcher, _utils.EqualityMatcher.toStrictEqual)]
             }]
           });
         }

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

@@ -16,12 +16,12 @@ const isNullLiteral = node => node.type === _utils.AST_NODE_TYPES.Literal && nod
  */
 
 
-const isNullEqualityMatcher = matcher => isNullLiteral(getFirstArgument(matcher));
+const isNullEqualityMatcher = expectFnCall => isNullLiteral((0, _utils2.getFirstMatcherArg)(expectFnCall));
 
-const isFirstArgumentIdentifier = (matcher, name) => (0, _utils2.isIdentifier)(getFirstArgument(matcher), name);
+const isFirstArgumentIdentifier = (expectFnCall, name) => (0, _utils2.isIdentifier)((0, _utils2.getFirstMatcherArg)(expectFnCall), name);
 
-const shouldUseToBe = matcher => {
-  const firstArg = getFirstArgument(matcher);
+const shouldUseToBe = expectFnCall => {
+  const firstArg = (0, _utils2.getFirstMatcherArg)(expectFnCall);
 
   if (firstArg.type === _utils.AST_NODE_TYPES.Literal) {
     // regex literals are classed as literals, but they're actually objects
@@ -32,32 +32,27 @@ const shouldUseToBe = matcher => {
   return firstArg.type === _utils.AST_NODE_TYPES.TemplateLiteral;
 };
 
-const getFirstArgument = matcher => {
-  return (0, _utils2.followTypeAssertionChain)(matcher.arguments[0]);
-};
-
-const reportPreferToBe = (context, whatToBe, matcher, modifier) => {
-  const modifierNode = (modifier === null || modifier === void 0 ? void 0 : modifier.negation) || (modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils2.ModifierName.not && (modifier === null || modifier === void 0 ? void 0 : modifier.node);
+const reportPreferToBe = (context, whatToBe, expectFnCall, modifierNode) => {
   context.report({
     messageId: `useToBe${whatToBe}`,
 
     fix(fixer) {
-      var _matcher$arguments;
+      var _expectFnCall$args;
 
-      const fixes = [(0, _utils2.replaceAccessorFixer)(fixer, matcher.node.property, `toBe${whatToBe}`)];
+      const fixes = [(0, _utils2.replaceAccessorFixer)(fixer, expectFnCall.matcher, `toBe${whatToBe}`)];
 
-      if ((_matcher$arguments = matcher.arguments) !== null && _matcher$arguments !== void 0 && _matcher$arguments.length && whatToBe !== '') {
-        fixes.push(fixer.remove(matcher.arguments[0]));
+      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.property.range[0] - 1, modifierNode.property.range[1]]));
+        fixes.push(fixer.removeRange([modifierNode.range[0] - 1, modifierNode.range[1]]));
       }
 
       return fixes;
     },
 
-    node: matcher.node.property
+    node: expectFnCall.matcher
   });
 };
 
@@ -85,46 +80,42 @@ var _default = (0, _utils2.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils2.isExpectCall)(node)) {
-          return;
-        }
-
-        const {
-          matcher,
-          modifier
-        } = (0, _utils2.parseExpectCall)(node);
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
 
-        if (!matcher) {
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
 
-        if (((modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils2.ModifierName.not || modifier !== null && modifier !== void 0 && modifier.negation) && ['toBeUndefined', 'toBeDefined'].includes(matcher.name)) {
-          reportPreferToBe(context, matcher.name === 'toBeDefined' ? 'Undefined' : 'Defined', matcher, modifier);
+        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 (!(0, _utils2.isParsedEqualityMatcherCall)(matcher)) {
+        if (!_utils2.EqualityMatcher.hasOwnProperty(matcherName) || jestFnCall.args.length === 0) {
           return;
         }
 
-        if (isNullEqualityMatcher(matcher)) {
-          reportPreferToBe(context, 'Null', matcher);
+        if (isNullEqualityMatcher(jestFnCall)) {
+          reportPreferToBe(context, 'Null', jestFnCall);
           return;
         }
 
-        if (isFirstArgumentIdentifier(matcher, 'undefined')) {
-          const name = (modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils2.ModifierName.not || modifier !== null && modifier !== void 0 && modifier.negation ? 'Defined' : 'Undefined';
-          reportPreferToBe(context, name, matcher, modifier);
+        if (isFirstArgumentIdentifier(jestFnCall, 'undefined')) {
+          const name = notModifier ? 'Defined' : 'Undefined';
+          reportPreferToBe(context, name, jestFnCall, notModifier);
           return;
         }
 
-        if (isFirstArgumentIdentifier(matcher, 'NaN')) {
-          reportPreferToBe(context, 'NaN', matcher);
+        if (isFirstArgumentIdentifier(jestFnCall, 'NaN')) {
+          reportPreferToBe(context, 'NaN', jestFnCall);
           return;
         }
 
-        if (shouldUseToBe(matcher) && matcher.name !== _utils2.EqualityMatcher.toBe) {
-          reportPreferToBe(context, '', matcher);
+        if (shouldUseToBe(jestFnCall) && matcherName !== _utils2.EqualityMatcher.toBe) {
+          reportPreferToBe(context, '', jestFnCall);
         }
       }
 

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

@@ -9,22 +9,6 @@ var _utils = require("@typescript-eslint/utils");
 
 var _utils2 = require("./utils");
 
-const isBooleanLiteral = node => node.type === _utils.AST_NODE_TYPES.Literal && typeof node.value === 'boolean';
-
-/**
- * Checks if the given `ParsedExpectMatcher` is a call to one of the equality matchers,
- * with a boolean literal as the sole argument.
- *
- * @example javascript
- * toBe(true);
- * toEqual(false);
- *
- * @param {ParsedExpectMatcher} matcher
- *
- * @return {matcher is ParsedBooleanEqualityMatcher}
- */
-const isBooleanEqualityMatcher = matcher => (0, _utils2.isParsedEqualityMatcherCall)(matcher) && isBooleanLiteral((0, _utils2.followTypeAssertionChain)(matcher.arguments[0]));
-
 /**
  * Checks if the given `node` is a `CallExpression` representing the calling
  * of an `includes`-like method that can be 'fixed' (using `toContain`).
@@ -33,7 +17,7 @@ const isBooleanEqualityMatcher = matcher => (0, _utils2.isParsedEqualityMatcherC
  *
  * @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); // 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)({
@@ -56,37 +40,48 @@ var _default = (0, _utils2.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils2.isExpectCall)(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 {
-          expect: {
-            arguments: [includesCall],
-            range: [, expectCallEnd]
-          },
-          matcher,
-          modifier
-        } = (0, _utils2.parseExpectCall)(node);
+          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]
+        } = expect;
+        const {
+          matcher
+        } = jestFnCall;
+        const matcherArg = (0, _utils2.getFirstMatcherArg)(jestFnCall);
 
-        if (!matcher || !includesCall || modifier && modifier.name !== _utils2.ModifierName.not || !isBooleanEqualityMatcher(matcher) || !isFixableIncludesCallExpression(includesCall)) {
+        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 addNotModifier = (0, _utils2.followTypeAssertionChain)(matcher.arguments[0]).value === !!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.node.range[1]], addNotModifier ? `.${_utils2.ModifierName.not}.toContain` : '.toContain'), // replace the matcher argument with the value from the "includes"
-            fixer.replaceText(matcher.arguments[0], sourceCode.getText(includesCall.arguments[0]))];
+            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.node.property
+          node: matcher
         });
       }
 

package/lib/rules/prefer-to-have-length.js

@@ -29,18 +29,26 @@ var _default = (0, _utils2.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils2.isExpectCall)(node)) {
+        const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
+
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
 
         const {
-          expect: {
-            arguments: [argument]
-          },
+          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
-        } = (0, _utils2.parseExpectCall)(node);
+        } = jestFnCall;
 
-        if (!matcher || !(0, _utils2.isParsedEqualityMatcherCall)(matcher) || (argument === null || argument === void 0 ? void 0 : argument.type) !== _utils.AST_NODE_TYPES.MemberExpression || !(0, _utils2.isSupportedAccessor)(argument.property, 'length')) {
+        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;
         }
 
@@ -48,11 +56,11 @@ var _default = (0, _utils2.createRule)({
           fix(fixer) {
             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.node.object.range[1], matcher.node.range[1]], '.toHaveLength')];
+            fixer.replaceTextRange([matcher.parent.object.range[1], matcher.parent.range[1]], '.toHaveLength')];
           },
 
           messageId: 'useToHaveLength',
-          node: matcher.node.property
+          node: matcher
         });
       }
 

package/lib/rules/require-to-throw-message.js

@@ -26,25 +26,25 @@ var _default = (0, _utils.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        var _matcher$arguments;
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
 
-        if (!(0, _utils.isExpectCall)(node)) {
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
 
         const {
-          matcher,
-          modifier
-        } = (0, _utils.parseExpectCall)(node);
+          matcher
+        } = jestFnCall;
+        const matcherName = (0, _utils.getAccessorValue)(matcher);
 
-        if ((matcher === null || matcher === void 0 ? void 0 : (_matcher$arguments = matcher.arguments) === null || _matcher$arguments === void 0 ? void 0 : _matcher$arguments.length) === 0 && ['toThrow', 'toThrowError'].includes(matcher.name) && (!modifier || !(modifier.name === _utils.ModifierName.not || modifier.negation))) {
+        if (jestFnCall.args.length === 0 && ['toThrow', 'toThrowError'].includes(matcherName) && !jestFnCall.modifiers.some(nod => (0, _utils.getAccessorValue)(nod) === 'not')) {
           // Look for `toThrow` calls with no arguments.
           context.report({
             messageId: 'addErrorMessage',
             data: {
-              matcherName: matcher.name
+              matcherName
             },
-            node: matcher.node.property
+            node: matcher
           });
         }
       }

package/lib/rules/unbound-method.js

@@ -5,25 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _utils = require("./utils");
+var _utils = require("@typescript-eslint/utils");
 
-const toThrowMatchers = ['toThrow', 'toThrowError', 'toThrowErrorMatchingSnapshot', 'toThrowErrorMatchingInlineSnapshot'];
-
-const isJestExpectToThrowCall = node => {
-  if (!(0, _utils.isExpectCall)(node)) {
-    return false;
-  }
-
-  const {
-    matcher
-  } = (0, _utils.parseExpectCall)(node);
-
-  if (!matcher) {
-    return false;
-  }
+var _utils2 = require("./utils");
 
-  return !toThrowMatchers.includes(matcher.name);
-};
+const toThrowMatchers = ['toThrow', 'toThrowError', 'toThrowErrorMatchingSnapshot', 'toThrowErrorMatchingInlineSnapshot'];
 
 const baseRule = (() => {
   try {
@@ -52,7 +38,7 @@ const tryCreateBaseRule = context => {
 
 const DEFAULT_MESSAGE = 'This rule requires `@typescript-eslint/eslint-plugin`';
 
-var _default = (0, _utils.createRule)({
+var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     ignoreStatic: false
   }],
@@ -84,24 +70,23 @@ var _default = (0, _utils.createRule)({
       return {};
     }
 
-    let inExpectToThrowCall = false;
     return { ...baseSelectors,
 
-      CallExpression(node) {
-        inExpectToThrowCall = isJestExpectToThrowCall(node);
-      },
+      MemberExpression(node) {
+        var _node$parent, _baseSelectors$Member;
 
-      'CallExpression:exit'(node) {
-        if (inExpectToThrowCall && isJestExpectToThrowCall(node)) {
-          inExpectToThrowCall = false;
-        }
-      },
+        if (((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) === _utils.AST_NODE_TYPES.CallExpression) {
+          const jestFnCall = (0, _utils2.parseJestFnCall)((0, _utils2.findTopMostCallExpression)(node.parent), context);
 
-      MemberExpression(node) {
-        var _baseSelectors$Member;
+          if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'expect') {
+            const {
+              matcher
+            } = jestFnCall;
 
-        if (inExpectToThrowCall) {
-          return;
+            if (!toThrowMatchers.includes((0, _utils2.getAccessorValue)(matcher))) {
+              return;
+            }
+          }
         }
 
         (_baseSelectors$Member = baseSelectors.MemberExpression) === null || _baseSelectors$Member === void 0 ? void 0 : _baseSelectors$Member.call(baseSelectors, node);

package/lib/rules/utils/index.js

@@ -67,17 +67,4 @@ Object.keys(_parseJestFnCall).forEach(function (key) {
       return _parseJestFnCall[key];
     }
   });
-});
-
-var _parseExpectCall = require("./parseExpectCall");
-
-Object.keys(_parseExpectCall).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _parseExpectCall[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _parseExpectCall[key];
-    }
-  });
 });

package/lib/rules/utils/misc.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createRule = exports.TestCaseName = exports.HookName = exports.DescribeAlias = void 0;
+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.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
+exports.replaceAccessorFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
 
 var _path = require("path");
 
@@ -15,6 +15,8 @@ var _package = require("../../../package.json");
 
 var _accessors = require("./accessors");
 
+var _followTypeAssertionChain = require("./followTypeAssertionChain");
+
 var _parseJestFnCall = require("./parseJestFnCall");
 
 const REPO_URL = 'https://github.com/jest-community/eslint-plugin-jest';
@@ -70,6 +72,24 @@ exports.HookName = HookName;
   HookName["afterEach"] = "afterEach";
 })(HookName || (exports.HookName = HookName = {}));
 
+let ModifierName;
+exports.ModifierName = ModifierName;
+
+(function (ModifierName) {
+  ModifierName["not"] = "not";
+  ModifierName["rejects"] = "rejects";
+  ModifierName["resolves"] = "resolves";
+})(ModifierName || (exports.ModifierName = ModifierName = {}));
+
+let EqualityMatcher;
+exports.EqualityMatcher = EqualityMatcher;
+
+(function (EqualityMatcher) {
+  EqualityMatcher["toBe"] = "toBe";
+  EqualityMatcher["toEqual"] = "toEqual";
+  EqualityMatcher["toStrictEqual"] = "toStrictEqual";
+})(EqualityMatcher || (exports.EqualityMatcher = EqualityMatcher = {}));
+
 const joinNames = (a, b) => a && b ? `${a}.${b}` : null;
 
 function getNodeName(node) {
@@ -117,4 +137,45 @@ const replaceAccessorFixer = (fixer, node, text) => {
   return fixer.replaceText(node, node.type === _utils.AST_NODE_TYPES.Identifier ? text : `'${text}'`);
 };
 
-exports.replaceAccessorFixer = replaceAccessorFixer;
+exports.replaceAccessorFixer = replaceAccessorFixer;
+
+const findTopMostCallExpression = node => {
+  let topMostCallExpression = node;
+  let {
+    parent
+  } = node;
+
+  while (parent) {
+    if (parent.type === _utils.AST_NODE_TYPES.CallExpression) {
+      topMostCallExpression = parent;
+      parent = parent.parent;
+      continue;
+    }
+
+    if (parent.type !== _utils.AST_NODE_TYPES.MemberExpression) {
+      break;
+    }
+
+    parent = parent.parent;
+  }
+
+  return topMostCallExpression;
+};
+
+exports.findTopMostCallExpression = findTopMostCallExpression;
+
+const isBooleanLiteral = node => node.type === _utils.AST_NODE_TYPES.Literal && typeof node.value === 'boolean';
+
+exports.isBooleanLiteral = isBooleanLiteral;
+
+const getFirstMatcherArg = expectFnCall => {
+  const [firstArg] = expectFnCall.args;
+
+  if (firstArg.type === _utils.AST_NODE_TYPES.SpreadElement) {
+    return firstArg;
+  }
+
+  return (0, _followTypeAssertionChain.followTypeAssertionChain)(firstArg);
+};
+
+exports.getFirstMatcherArg = getFirstMatcherArg;