eslint-plugin-jest 26.8.7 → 27.1.5

package/lib/rules/no-if.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 testCaseNames = new Set([...Object.keys(_utils2.TestCaseName), 'it.only', 'it.only', 'it.skip', 'it.skip', 'test.only', 'test.only', 'test.skip', 'test.skip', 'fit.concurrent']);
-
 const isTestFunctionExpression = node => node.parent !== undefined && node.parent.type === _utils.AST_NODE_TYPES.CallExpression && testCaseNames.has((0, _utils2.getNodeName)(node.parent.callee));
-
 const conditionName = {
   [_utils.AST_NODE_TYPES.ConditionalExpression]: 'conditional',
   [_utils.AST_NODE_TYPES.SwitchStatement]: 'switch',
   [_utils.AST_NODE_TYPES.IfStatement]: 'if'
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -36,17 +30,13 @@ var _default = (0, _utils2.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     const stack = [];
-
     function validate(node) {
       const lastElementInStack = stack[stack.length - 1];
-
       if (stack.length === 0 || !lastElementInStack) {
         return;
       }
-
       context.report({
         data: {
           condition: conditionName[node.type]
@@ -55,57 +45,43 @@ var _default = (0, _utils2.createRule)({
         node
       });
     }
-
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) === 'test') {
           stack.push(true);
-
           if (jestFnCall.members.some(s => (0, _utils2.getAccessorValue)(s) === 'each')) {
             stack.push(true);
           }
         }
       },
-
       FunctionExpression(node) {
         stack.push(isTestFunctionExpression(node));
       },
-
       FunctionDeclaration(node) {
         const declaredVariables = context.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
         stack.push(testCallExpressions.length > 0);
       },
-
       ArrowFunctionExpression(node) {
         stack.push(isTestFunctionExpression(node));
       },
-
       IfStatement: validate,
       SwitchStatement: validate,
       ConditionalExpression: validate,
-
       'CallExpression:exit'() {
         stack.pop();
       },
-
       'FunctionExpression:exit'() {
         stack.pop();
       },
-
       'FunctionDeclaration:exit'() {
         stack.pop();
       },
-
       'ArrowFunctionExpression:exit'() {
         stack.pop();
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-interpolation-in-snapshots.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: {
@@ -24,16 +21,13 @@ var _default = (0, _utils2.createRule)({
     type: 'problem'
   },
   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;
         }
-
         if (['toMatchInlineSnapshot', 'toThrowErrorMatchingInlineSnapshot'].includes((0, _utils2.getAccessorValue)(jestFnCall.matcher))) {
           // Check all since the optional 'propertyMatchers' argument might be present
           jestFnCall.args.forEach(argument => {
@@ -46,10 +40,7 @@ var _default = (0, _utils2.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-jasmine-globals.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: {
@@ -29,7 +26,6 @@ var _default = (0, _utils2.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     return {
       CallExpression(node) {
@@ -37,17 +33,14 @@ var _default = (0, _utils2.createRule)({
           callee
         } = node;
         const calleeName = (0, _utils2.getNodeName)(callee);
-
         if (!calleeName) {
           return;
         }
-
         if (calleeName === 'spyOn' || calleeName === 'spyOnProperty' || calleeName === 'fail' || calleeName === 'pending') {
-          if ((0, _utils2.scopeHasLocalReference)(context.getScope(), calleeName)) {
+          if ((0, _utils2.resolveScope)(context.getScope(), calleeName)) {
             // It's a local variable, not a jasmine global.
             return;
           }
-
           switch (calleeName) {
             case 'spyOn':
             case 'spyOnProperty':
@@ -60,14 +53,12 @@ var _default = (0, _utils2.createRule)({
                 }
               });
               break;
-
             case 'fail':
               context.report({
                 node,
                 messageId: 'illegalFail'
               });
               break;
-
             case 'pending':
               context.report({
                 node,
@@ -75,13 +66,10 @@ var _default = (0, _utils2.createRule)({
               });
               break;
           }
-
           return;
         }
-
         if (callee.type === _utils.AST_NODE_TYPES.MemberExpression && calleeName.startsWith('jasmine.')) {
           const functionName = calleeName.replace('jasmine.', '');
-
           if (functionName === 'any' || functionName === 'anything' || functionName === 'arrayContaining' || functionName === 'objectContaining' || functionName === 'stringMatching') {
             context.report({
               fix: fixer => [fixer.replaceText(callee.object, 'expect')],
@@ -94,7 +82,6 @@ var _default = (0, _utils2.createRule)({
             });
             return;
           }
-
           if (functionName === 'addMatchers') {
             context.report({
               node,
@@ -106,7 +93,6 @@ var _default = (0, _utils2.createRule)({
             });
             return;
           }
-
           if (functionName === 'createSpy') {
             context.report({
               node,
@@ -118,27 +104,23 @@ var _default = (0, _utils2.createRule)({
             });
             return;
           }
-
           context.report({
             node,
             messageId: 'illegalJasmine'
           });
         }
       },
-
       MemberExpression(node) {
         if ((0, _utils2.isSupportedAccessor)(node.object, 'jasmine')) {
           const {
             parent,
             property
           } = node;
-
           if (parent && parent.type === _utils.AST_NODE_TYPES.AssignmentExpression) {
             if ((0, _utils2.isSupportedAccessor)(property, 'DEFAULT_TIMEOUT_INTERVAL')) {
               const {
                 right
               } = parent;
-
               if (right.type === _utils.AST_NODE_TYPES.Literal) {
                 context.report({
                   fix: fixer => [fixer.replaceText(parent, `jest.setTimeout(${right.value})`)],
@@ -148,7 +130,6 @@ var _default = (0, _utils2.createRule)({
                 return;
               }
             }
-
             context.report({
               node,
               messageId: 'illegalJasmine'
@@ -156,10 +137,7 @@ var _default = (0, _utils2.createRule)({
           }
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

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,37 +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) {
-          var _options$inlineMaxSiz;
-
-          reportOnViolation(context, jestFnCall.args[0], { ...options,
-            maxSize: (_options$inlineMaxSiz = options.inlineMaxSize) !== null && _options$inlineMaxSiz !== void 0 ? _options$inlineMaxSiz : options.maxSize
+          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

@@ -0,0 +1,56 @@
+"use strict";
+
+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: {
+    docs: {
+      category: 'Best Practices',
+      description: 'Disallow specific `jest.` methods',
+      recommended: false
+    },
+    type: 'suggestion',
+    schema: [{
+      type: 'object',
+      additionalProperties: {
+        type: ['string', 'null']
+      }
+    }],
+    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' || jestFnCall.members.length === 0) {
+          return;
+        }
+        const method = (0, _utils.getAccessorValue)(jestFnCall.members[0]);
+        if (method in restrictedMethods) {
+          const message = restrictedMethods[method];
+          context.report({
+            messageId: message ? 'restrictedJestMethodWithMessage' : 'restrictedJestMethod',
+            data: {
+              message,
+              restriction: method
+            },
+            loc: {
+              start: jestFnCall.members[0].loc.start,
+              end: jestFnCall.members[jestFnCall.members.length - 1].loc.end
+            }
+          });
+        }
+      }
+    };
+  }
+});
+exports.default = _default;

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

@@ -4,9 +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: {
@@ -23,56 +27,37 @@ var _default = (0, _utils.createRule)({
       }
     }],
     messages: {
-      restrictedChain: 'Use of `{{ chain }}` is disallowed',
+      restrictedChain: 'Use of `{{ restriction }}` is disallowed',
       restrictedChainWithMessage: '{{ message }}'
     }
   },
   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 permutations = [jestFnCall.members];
-
-        if (jestFnCall.members.length > 2) {
-          permutations.push([jestFnCall.members[0], jestFnCall.members[1]]);
-          permutations.push([jestFnCall.members[1], jestFnCall.members[2]]);
-        }
-
-        if (jestFnCall.members.length > 1) {
-          permutations.push(...jestFnCall.members.map(nod => [nod]));
-        }
-
-        for (const permutation of permutations) {
-          const chain = permutation.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
-
-          if (chain in restrictedChains) {
-            const message = restrictedChains[chain];
+        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({
               messageId: message ? 'restrictedChainWithMessage' : 'restrictedChain',
               data: {
                 message,
-                chain
+                restriction
               },
               loc: {
-                start: permutation[0].loc.start,
-                end: permutation[permutation.length - 1].loc.end
+                start: jestFnCall.members[0].loc.start,
+                end: jestFnCall.members[jestFnCall.members.length - 1].loc.end
               }
             });
             break;
           }
         }
       }
-
     };
   }
-
 });
-
 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;