eslint-plugin-jest 27.1.2 → 27.1.4

package/lib/rules/no-large-snapshots.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _path = require("path");
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const reportOnViolation = (context, node, {
   maxSize: lineLimit = 50,
   allowedSnapshots = {}
@@ -19,29 +15,23 @@ const reportOnViolation = (context, node, {
   const endLine = node.loc.end.line;
   const lineCount = endLine - startLine;
   const allPathsAreAbsolute = Object.keys(allowedSnapshots).every(_path.isAbsolute);
-
   if (!allPathsAreAbsolute) {
     throw new Error('All paths for allowedSnapshots must be absolute. You can use JS config and `path.resolve`');
   }
-
   let isAllowed = false;
-
   if (node.type === _utils.AST_NODE_TYPES.ExpressionStatement && 'left' in node.expression && node.expression.left.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.expression.left.property)) {
     const fileName = context.getFilename();
     const allowedSnapshotsInFile = allowedSnapshots[fileName];
-
     if (allowedSnapshotsInFile) {
       const snapshotName = (0, _utils2.getAccessorValue)(node.expression.left.property);
       isAllowed = allowedSnapshotsInFile.some(name => {
         if (name instanceof RegExp) {
           return name.test(snapshotName);
         }
-
         return snapshotName === name;
       });
     }
   }
-
   if (!isAllowed && lineCount > lineLimit) {
     context.report({
       messageId: lineLimit === 0 ? 'noSnapshot' : 'tooLongSnapshots',
@@ -53,13 +43,12 @@ const reportOnViolation = (context, node, {
     });
   }
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'disallow large snapshots',
+      description: 'Disallow large snapshots',
       recommended: false
     },
     messages: {
@@ -87,35 +76,28 @@ var _default = (0, _utils2.createRule)({
     }]
   },
   defaultOptions: [{}],
-
   create(context, [options]) {
     if (context.getFilename().endsWith('.snap')) {
       return {
         ExpressionStatement(node) {
           reportOnViolation(context, node, options);
         }
-
       };
     }
-
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
-
         if (['toMatchInlineSnapshot', 'toThrowErrorMatchingInlineSnapshot'].includes((0, _utils2.getAccessorValue)(jestFnCall.matcher)) && jestFnCall.args.length) {
-          reportOnViolation(context, jestFnCall.args[0], { ...options,
+          reportOnViolation(context, jestFnCall.args[0], {
+            ...options,
             maxSize: options.inlineMaxSize ?? options.maxSize
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-mocks-import.js

@@ -4,17 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _path = require("path");
-
 var _utils = require("./utils");
-
 const mocksDirName = '__mocks__';
-
 const isMockPath = path => path.split(_path.posix.sep).includes(mocksDirName);
-
 const isMockImportLiteral = expression => (0, _utils.isStringNode)(expression) && isMockPath((0, _utils.getStringValue)(expression));
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -30,7 +24,6 @@ var _default = (0, _utils.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     return {
       ImportDeclaration(node) {
@@ -41,10 +34,8 @@ var _default = (0, _utils.createRule)({
           });
         }
       },
-
       'CallExpression[callee.name="require"]'(node) {
         const [arg] = node.arguments;
-
         if (arg && isMockImportLiteral(arg)) {
           context.report({
             node: arg,
@@ -52,10 +43,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-restricted-jest-methods.js

@@ -4,14 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 const messages = {
   restrictedJestMethod: 'Use of `{{ restriction }}` is disallowed',
   restrictedJestMethodWithMessage: '{{ message }}'
 };
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -30,18 +27,14 @@ var _default = (0, _utils.createRule)({
     messages
   },
   defaultOptions: [{}],
-
   create(context, [restrictedMethods]) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
-        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'jest') {
+        if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'jest' || jestFnCall.members.length === 0) {
           return;
         }
-
         const method = (0, _utils.getAccessorValue)(jestFnCall.members[0]);
-
         if (method in restrictedMethods) {
           const message = restrictedMethods[method];
           context.report({
@@ -57,10 +50,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-restricted-matchers.js

@@ -4,17 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 const isChainRestricted = (chain, restriction) => {
   if (_utils.ModifierName.hasOwnProperty(restriction) || restriction.endsWith('.not')) {
     return chain.startsWith(restriction);
   }
-
   return chain === restriction;
 };
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -36,18 +32,14 @@ var _default = (0, _utils.createRule)({
     }
   },
   defaultOptions: [{}],
-
   create(context, [restrictedChains]) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
-
         const chain = jestFnCall.members.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
-
         for (const [restriction, message] of Object.entries(restrictedChains)) {
           if (isChainRestricted(chain, restriction)) {
             context.report({
@@ -65,10 +57,7 @@ var _default = (0, _utils.createRule)({
           }
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-standalone-expect.js

@@ -4,40 +4,35 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const getBlockType = (statement, context) => {
   const func = statement.parent;
-  /* istanbul ignore if */
 
+  /* istanbul ignore if */
   if (!func) {
     throw new Error(`Unexpected BlockStatement. No parent defined. - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
-  } // functionDeclaration: function func() {}
-
+  }
 
+  // functionDeclaration: function func() {}
   if (func.type === _utils.AST_NODE_TYPES.FunctionDeclaration) {
     return 'function';
   }
-
   if ((0, _utils2.isFunction)(func) && func.parent) {
-    const expr = func.parent; // arrow function or function expr
+    const expr = func.parent;
 
+    // arrow function or function expr
     if (expr.type === _utils.AST_NODE_TYPES.VariableDeclarator) {
       return 'function';
-    } // if it's not a variable, it will be callExpr, we only care about describe
-
+    }
 
+    // if it's not a variable, it will be callExpr, we only care about describe
     if (expr.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isTypeOfJestFnCall)(expr, context, ['describe'])) {
       return 'describe';
     }
   }
-
   return null;
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -65,85 +60,64 @@ var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     additionalTestBlockFunctions: []
   }],
-
   create(context, [{
     additionalTestBlockFunctions = []
   }]) {
     const callStack = [];
-
     const isCustomTestBlockFunction = node => additionalTestBlockFunctions.includes((0, _utils2.getNodeName)(node) || '');
-
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'expect') {
           var _jestFnCall$head$node;
-
           if (((_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]))) {
             return;
           }
-
           const parent = callStack[callStack.length - 1];
-
           if (!parent || parent === _utils2.DescribeAlias.describe) {
             context.report({
               node,
               messageId: 'unexpectedExpect'
             });
           }
-
           return;
         }
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test' || isCustomTestBlockFunction(node)) {
           callStack.push('test');
         }
-
         if (node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
           callStack.push('template');
         }
       },
-
       'CallExpression:exit'(node) {
         const top = callStack[callStack.length - 1];
-
         if (top === 'test' && ((0, _utils2.isTypeOfJestFnCall)(node, context, ['test']) || isCustomTestBlockFunction(node)) && node.callee.type !== _utils.AST_NODE_TYPES.MemberExpression || top === 'template' && node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
           callStack.pop();
         }
       },
-
       BlockStatement(statement) {
         const blockType = getBlockType(statement, context);
-
         if (blockType) {
           callStack.push(blockType);
         }
       },
-
       'BlockStatement:exit'(statement) {
         if (callStack[callStack.length - 1] === getBlockType(statement, context)) {
           callStack.pop();
         }
       },
-
       ArrowFunctionExpression(node) {
         var _node$parent;
-
         if (((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) !== _utils.AST_NODE_TYPES.CallExpression) {
           callStack.push('arrow');
         }
       },
-
       'ArrowFunctionExpression:exit'() {
         if (callStack[callStack.length - 1] === 'arrow') {
           callStack.pop();
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-test-prefixes.js

@@ -4,17 +4,14 @@ 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: {
     docs: {
       category: 'Best Practices',
-      description: 'Use `.only` and `.skip` over `f` and `x`',
+      description: 'Require using `.only` and `.skip` over `f` and `x`',
       recommended: 'error'
     },
     messages: {
@@ -25,20 +22,16 @@ var _default = (0, _utils2.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'describe' && (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test') {
           return;
         }
-
         if (jestFnCall.name[0] !== 'f' && jestFnCall.name[0] !== 'x') {
           return;
         }
-
         const preferredNodeName = [jestFnCall.name.slice(1), jestFnCall.name[0] === 'f' ? 'only' : 'skip', ...jestFnCall.members.map(s => (0, _utils2.getAccessorValue)(s))].join('.');
         const funcNode = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
         context.report({
@@ -47,17 +40,12 @@ var _default = (0, _utils2.createRule)({
           data: {
             preferredNodeName
           },
-
           fix(fixer) {
             return [fixer.replaceText(funcNode, preferredNodeName)];
           }
-
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-test-return-statement.js

@@ -4,21 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const getBody = args => {
   const [, secondArg] = args;
-
   if (secondArg && (0, _utils2.isFunction)(secondArg) && secondArg.body.type === _utils.AST_NODE_TYPES.BlockStatement) {
     return secondArg.body.body;
   }
-
   return [];
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -34,14 +28,12 @@ var _default = (0, _utils2.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
         if (!(0, _utils2.isTypeOfJestFnCall)(node, context, ['test'])) {
           return;
         }
-
         const body = getBody(node.arguments);
         const returnStmt = body.find(t => t.type === _utils.AST_NODE_TYPES.ReturnStatement);
         if (!returnStmt) return;
@@ -50,7 +42,6 @@ var _default = (0, _utils2.createRule)({
           node: returnStmt
         });
       },
-
       FunctionDeclaration(node) {
         const declaredVariables = context.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
@@ -62,10 +53,7 @@ var _default = (0, _utils2.createRule)({
           node: returnStmt
         });
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/prefer-called-with.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,25 +20,20 @@ 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;
         }
-
         if (jestFnCall.modifiers.some(nod => (0, _utils.getAccessorValue)(nod) === 'not')) {
           return;
         }
-
         const {
           matcher
         } = jestFnCall;
         const matcherName = (0, _utils.getAccessorValue)(matcher);
-
         if (['toBeCalled', 'toHaveBeenCalled'].includes(matcherName)) {
           context.report({
             data: {
@@ -51,10 +44,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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;