eslint-plugin-jest 26.8.7 → 27.1.5

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

@@ -4,58 +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 => {
-  const firstArg = (0, _utils2.getFirstMatcherArg)(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: {
@@ -76,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;

package/lib/rules/prefer-todo.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");
-
 function isEmptyFunction(node) {
   if (!(0, _utils2.isFunction)(node)) {
     return false;
   }
-
   return node.body.type === _utils.AST_NODE_TYPES.BlockStatement && !node.body.body.length;
 }
-
 function createTodoFixer(jestFnCall, fixer) {
   if (jestFnCall.members.length) {
     return (0, _utils2.replaceAccessorFixer)(fixer, jestFnCall.members[0], 'todo');
   }
-
   return fixer.replaceText(jestFnCall.head.node, `${jestFnCall.head.local}.todo`);
 }
-
 const isTargetedTestCase = jestFnCall => {
   if (jestFnCall.members.some(s => (0, _utils2.getAccessorValue)(s) !== 'skip')) {
     return false;
-  } // todo: we should support this too (needs custom fixer)
-
+  }
 
+  // todo: we should support this too (needs custom fixer)
   if (jestFnCall.name.startsWith('x')) {
     return false;
   }
-
   return !jestFnCall.name.startsWith('f');
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -55,17 +46,14 @@ var _default = (0, _utils2.createRule)({
     type: 'layout'
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         const [title, callback] = node.arguments;
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if (!title || (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test' || !isTargetedTestCase(jestFnCall) || !(0, _utils2.isStringNode)(title)) {
           return;
         }
-
         if (callback && isEmptyFunction(callback)) {
           context.report({
             messageId: 'emptyTest',
@@ -73,7 +61,6 @@ var _default = (0, _utils2.createRule)({
             fix: fixer => [fixer.removeRange([title.range[1], callback.range[1]]), createTodoFixer(jestFnCall, fixer)]
           });
         }
-
         if ((0, _utils2.hasOnlyOneArgument)(node)) {
           context.report({
             messageId: 'unimplementedTest',
@@ -82,10 +69,7 @@ var _default = (0, _utils2.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/require-hook.js

@@ -4,49 +4,37 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const isJestFnCall = (node, context) => {
   var _getNodeName;
-
   if ((0, _utils2.parseJestFnCall)(node, context)) {
     return true;
   }
-
   return !!((_getNodeName = (0, _utils2.getNodeName)(node)) !== null && _getNodeName !== void 0 && _getNodeName.startsWith('jest.'));
 };
-
 const isNullOrUndefined = node => {
   return node.type === _utils.AST_NODE_TYPES.Literal && node.value === null || (0, _utils2.isIdentifier)(node, 'undefined');
 };
-
 const shouldBeInHook = (node, context, allowedFunctionCalls = []) => {
   switch (node.type) {
     case _utils.AST_NODE_TYPES.ExpressionStatement:
       return shouldBeInHook(node.expression, context, allowedFunctionCalls);
-
     case _utils.AST_NODE_TYPES.CallExpression:
       return !(isJestFnCall(node, context) || allowedFunctionCalls.includes((0, _utils2.getNodeName)(node)));
-
     case _utils.AST_NODE_TYPES.VariableDeclaration:
       {
         if (node.kind === 'const') {
           return false;
         }
-
         return node.declarations.some(({
           init
         }) => init !== null && !isNullOrUndefined(init));
       }
-
     default:
       return false;
   }
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -75,14 +63,10 @@ var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     allowedFunctionCalls: []
   }],
-
   create(context) {
-    var _context$options$;
-
     const {
       allowedFunctionCalls
-    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
-
+    } = context.options[0] ?? {};
     const checkBlockBody = body => {
       for (const statement of body) {
         if (shouldBeInHook(statement, context, allowedFunctionCalls)) {
@@ -93,29 +77,21 @@ var _default = (0, _utils2.createRule)({
         }
       }
     };
-
     return {
       Program(program) {
         checkBlockBody(program.body);
       },
-
       CallExpression(node) {
         if (!(0, _utils2.isTypeOfJestFnCall)(node, context, ['describe']) || node.arguments.length < 2) {
           return;
         }
-
         const [, testFn] = node.arguments;
-
         if (!(0, _utils2.isFunction)(testFn) || testFn.body.type !== _utils.AST_NODE_TYPES.BlockStatement) {
           return;
         }
-
         checkBlockBody(testFn.body.body);
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/require-to-throw-message.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,21 +20,17 @@ var _default = (0, _utils.createRule)({
     schema: []
   },
   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;
         const matcherName = (0, _utils.getAccessorValue)(matcher);
-
         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({
@@ -48,10 +42,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/require-top-level-describe.js

@@ -4,15 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 const messages = {
   tooManyDescribes: 'There should not be more than {{ max }} describe{{ s }} at the top level',
   unexpectedTestCase: 'All test cases must be wrapped in a describe block.',
   unexpectedHook: 'All hooks must be wrapped in a describe block.'
 };
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -35,29 +32,22 @@ var _default = (0, _utils.createRule)({
     }]
   },
   defaultOptions: [{}],
-
   create(context) {
-    var _context$options$;
-
     const {
       maxNumberOfTopLevelDescribes = Infinity
-    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
+    } = context.options[0] ?? {};
     let numberOfTopLevelDescribeBlocks = 0;
     let numberOfDescribeBlocks = 0;
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if (!jestFnCall) {
           return;
         }
-
         if (jestFnCall.type === 'describe') {
           numberOfDescribeBlocks++;
-
           if (numberOfDescribeBlocks === 1) {
             numberOfTopLevelDescribeBlocks++;
-
             if (numberOfTopLevelDescribeBlocks > maxNumberOfTopLevelDescribes) {
               context.report({
                 node,
@@ -69,10 +59,8 @@ var _default = (0, _utils.createRule)({
               });
             }
           }
-
           return;
         }
-
         if (numberOfDescribeBlocks === 0) {
           if (jestFnCall.type === 'test') {
             context.report({
@@ -81,7 +69,6 @@ var _default = (0, _utils.createRule)({
             });
             return;
           }
-
           if (jestFnCall.type === 'hook') {
             context.report({
               node,
@@ -91,16 +78,12 @@ var _default = (0, _utils.createRule)({
           }
         }
       },
-
       'CallExpression:exit'(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['describe'])) {
           numberOfDescribeBlocks--;
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/unbound-method.js

@@ -4,40 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const toThrowMatchers = ['toThrow', 'toThrowError', 'toThrowErrorMatchingSnapshot', 'toThrowErrorMatchingInlineSnapshot'];
-
 const baseRule = (() => {
   try {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     const TSESLintPlugin = require('@typescript-eslint/eslint-plugin');
-
     return TSESLintPlugin.rules['unbound-method'];
   } catch (e) {
     const error = e;
-
     if (error.code === 'MODULE_NOT_FOUND') {
       return null;
     }
-
     throw error;
   }
 })();
-
-const tryCreateBaseRule = context => {
-  try {
-    return baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
-  } catch {
-    return null;
-  }
-};
-
 const DEFAULT_MESSAGE = 'This rule requires `@typescript-eslint/eslint-plugin`';
-
 var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     ignoreStatic: false
@@ -60,39 +43,29 @@ var _default = (0, _utils2.createRule)({
       recommended: false
     }
   },
-
   create(context) {
-    const baseSelectors = tryCreateBaseRule(context);
-
+    const baseSelectors = baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
     if (!baseSelectors) {
       return {};
     }
-
-    return { ...baseSelectors,
-
+    return {
+      ...baseSelectors,
       MemberExpression(node) {
         var _node$parent, _baseSelectors$Member;
-
         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);
-
           if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'expect') {
             const {
               matcher
             } = jestFnCall;
-
             if (!toThrowMatchers.includes((0, _utils2.getAccessorValue)(matcher))) {
               return;
             }
           }
         }
-
         (_baseSelectors$Member = baseSelectors.MemberExpression) === null || _baseSelectors$Member === void 0 ? void 0 : _baseSelectors$Member.call(baseSelectors, node);
       }
-
     };
   }
-
 });
-
 exports.default = _default;