eslint-plugin-jest 24.4.2 → 26.1.0

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

@@ -7,6 +7,12 @@ 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: {
@@ -15,21 +21,49 @@ var _default = (0, _utils.createRule)({
       description: 'Require test cases and hooks to be inside a `describe` block',
       recommended: false
     },
-    messages: {
-      unexpectedTestCase: 'All test cases must be wrapped in a describe block.',
-      unexpectedHook: 'All hooks must be wrapped in a describe block.'
-    },
+    messages,
     type: 'suggestion',
-    schema: []
+    schema: [{
+      type: 'object',
+      properties: {
+        maxNumberOfTopLevelDescribes: {
+          type: 'number',
+          minimum: 1
+        }
+      },
+      additionalProperties: false
+    }]
   },
-  defaultOptions: [],
+  defaultOptions: [{}],
 
   create(context) {
+    var _context$options$;
+
+    const {
+      maxNumberOfTopLevelDescribes = Infinity
+    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
+    let numberOfTopLevelDescribeBlocks = 0;
     let numberOfDescribeBlocks = 0;
     return {
       CallExpression(node) {
         if ((0, _utils.isDescribeCall)(node)) {
           numberOfDescribeBlocks++;
+
+          if (numberOfDescribeBlocks === 1) {
+            numberOfTopLevelDescribeBlocks++;
+
+            if (numberOfTopLevelDescribeBlocks > maxNumberOfTopLevelDescribes) {
+              context.report({
+                node,
+                messageId: 'tooManyDescribes',
+                data: {
+                  max: maxNumberOfTopLevelDescribes,
+                  s: maxNumberOfTopLevelDescribes === 1 ? '' : 's'
+                }
+              });
+            }
+          }
+
           return;
         }
 

package/lib/rules/utils.js

@@ -3,25 +3,26 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getAccessorValue = exports.followTypeAssertionChain = exports.createRule = exports.TestCaseProperty = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeProperty = exports.DescribeAlias = void 0;
 exports.getNodeName = getNodeName;
-exports.scopeHasLocalReference = exports.isDescribeCall = exports.isTestCaseCall = exports.getTestCallExpressionsFromDeclaredVariables = exports.isHook = exports.isFunction = exports.TestCaseProperty = exports.DescribeProperty = exports.HookName = exports.TestCaseName = exports.DescribeAlias = exports.parseExpectCall = exports.isParsedEqualityMatcherCall = exports.EqualityMatcher = exports.ModifierName = exports.isExpectMember = exports.isExpectCall = exports.getAccessorValue = exports.isSupportedAccessor = exports.hasOnlyOneArgument = exports.getStringValue = exports.isStringNode = exports.followTypeAssertionChain = exports.createRule = void 0;
+exports.scopeHasLocalReference = exports.parseExpectCall = exports.isTestCaseCall = exports.isSupportedAccessor = exports.isStringNode = exports.isParsedEqualityMatcherCall = exports.isIdentifier = exports.isHook = exports.isFunction = exports.isExpectMember = exports.isExpectCall = exports.isDescribeCall = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = exports.getStringValue = void 0;
 
 var _path = require("path");
 
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
+var _utils = require("@typescript-eslint/utils");
 
 var _package = require("../../package.json");
 
 const REPO_URL = 'https://github.com/jest-community/eslint-plugin-jest';
 
-const createRule = _experimentalUtils.ESLintUtils.RuleCreator(name => {
+const createRule = _utils.ESLintUtils.RuleCreator(name => {
   const ruleName = (0, _path.parse)(name).name;
   return `${REPO_URL}/blob/v${_package.version}/docs/rules/${ruleName}.md`;
 });
 
 exports.createRule = createRule;
 
-const isTypeCastExpression = node => node.type === _experimentalUtils.AST_NODE_TYPES.TSAsExpression || node.type === _experimentalUtils.AST_NODE_TYPES.TSTypeAssertion;
+const isTypeCastExpression = node => node.type === _utils.AST_NODE_TYPES.TSAsExpression || node.type === _utils.AST_NODE_TYPES.TSTypeAssertion;
 
 const followTypeAssertionChain = expression => isTypeCastExpression(expression) ? followTypeAssertionChain(expression.expression) : expression;
 /**
@@ -44,7 +45,7 @@ exports.followTypeAssertionChain = followTypeAssertionChain;
  *
  * @template V
  */
-const isStringLiteral = (node, value) => node.type === _experimentalUtils.AST_NODE_TYPES.Literal && typeof node.value === 'string' && (value === undefined || node.value === value);
+const isStringLiteral = (node, value) => node.type === _utils.AST_NODE_TYPES.Literal && typeof node.value === 'string' && (value === undefined || node.value === value);
 
 /**
  * Checks if the given `node` is a `TemplateLiteral`.
@@ -61,7 +62,8 @@ const isStringLiteral = (node, value) => node.type === _experimentalUtils.AST_NO
  *
  * @template V
  */
-const isTemplateLiteral = (node, value) => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1 && (value === undefined || node.quasis[0].value.raw === value);
+const isTemplateLiteral = (node, value) => node.type === _utils.AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1 && ( // bail out if not simple
+value === undefined || node.quasis[0].value.raw === value);
 
 /**
  * Checks if the given `node` is a {@link StringNode}.
@@ -126,7 +128,7 @@ exports.hasOnlyOneArgument = hasOnlyOneArgument;
  *
  * @template V
  */
-const isIdentifier = (node, name) => node.type === _experimentalUtils.AST_NODE_TYPES.Identifier && (name === undefined || node.name === name);
+const isIdentifier = (node, name) => node.type === _utils.AST_NODE_TYPES.Identifier && (name === undefined || node.name === name);
 /**
  * Checks if the given `node` is a "supported accessor".
  *
@@ -151,6 +153,8 @@ const isIdentifier = (node, name) => node.type === _experimentalUtils.AST_NODE_T
  */
 
 
+exports.isIdentifier = isIdentifier;
+
 const isSupportedAccessor = (node, value) => isIdentifier(node, value) || isStringNode(node, value);
 /**
  * Gets the value of the given `AccessorNode`,
@@ -166,7 +170,7 @@ const isSupportedAccessor = (node, value) => isIdentifier(node, value) || isStri
 
 exports.isSupportedAccessor = isSupportedAccessor;
 
-const getAccessorValue = accessor => accessor.type === _experimentalUtils.AST_NODE_TYPES.Identifier ? accessor.name : getStringValue(accessor);
+const getAccessorValue = accessor => accessor.type === _utils.AST_NODE_TYPES.Identifier ? accessor.name : getStringValue(accessor);
 
 exports.getAccessorValue = getAccessorValue;
 
@@ -182,11 +186,11 @@ exports.getAccessorValue = getAccessorValue;
  *
  * @return {node is ExpectCall}
  */
-const isExpectCall = node => node.type === _experimentalUtils.AST_NODE_TYPES.CallExpression && isSupportedAccessor(node.callee, 'expect') && node.parent !== undefined;
+const isExpectCall = node => node.type === _utils.AST_NODE_TYPES.CallExpression && isSupportedAccessor(node.callee, 'expect') && node.parent !== undefined;
 
 exports.isExpectCall = isExpectCall;
 
-const isExpectMember = (node, name) => node.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.property, name);
+const isExpectMember = (node, name) => node.type === _utils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(node.property, name);
 /**
  * Represents all the jest matchers.
  */
@@ -231,7 +235,7 @@ const reparseAsMatcher = parsedMember => ({ ...parsedMember,
    *
    * If this matcher isn't called, this will be `null`.
    */
-  arguments: parsedMember.node.parent && parsedMember.node.parent.type === _experimentalUtils.AST_NODE_TYPES.CallExpression ? parsedMember.node.parent.arguments : null
+  arguments: parsedMember.node.parent.type === _utils.AST_NODE_TYPES.CallExpression ? parsedMember.node.parent.arguments : null
 });
 /**
  * Re-parses the given `parsedMember` as a `ParsedExpectModifier`.
@@ -258,7 +262,7 @@ const reparseMemberAsModifier = parsedMember => {
     throw new Error(`modifier name must be either "${ModifierName.resolves}" or "${ModifierName.rejects}" (got "${parsedMember.name}")`);
   }
 
-  const negation = parsedMember.node.parent && isExpectMember(parsedMember.node.parent, ModifierName.not) ? parsedMember.node.parent : undefined;
+  const negation = isExpectMember(parsedMember.node.parent, ModifierName.not) ? parsedMember.node.parent : undefined;
   return { ...parsedMember,
     negation
   };
@@ -295,7 +299,7 @@ const parseExpectCall = expect => {
   const modifier = expectation.modifier = reparseMemberAsModifier(parsedMember);
   const memberNode = modifier.negation || modifier.node;
 
-  if (!memberNode.parent || !isExpectMember(memberNode.parent)) {
+  if (!isExpectMember(memberNode.parent)) {
     return expectation;
   }
 
@@ -362,25 +366,25 @@ function getNodeName(node) {
   }
 
   switch (node.type) {
-    case _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression:
+    case _utils.AST_NODE_TYPES.TaggedTemplateExpression:
       return getNodeName(node.tag);
 
-    case _experimentalUtils.AST_NODE_TYPES.MemberExpression:
+    case _utils.AST_NODE_TYPES.MemberExpression:
       return joinNames(getNodeName(node.object), getNodeName(node.property));
 
-    case _experimentalUtils.AST_NODE_TYPES.NewExpression:
-    case _experimentalUtils.AST_NODE_TYPES.CallExpression:
+    case _utils.AST_NODE_TYPES.NewExpression:
+    case _utils.AST_NODE_TYPES.CallExpression:
       return getNodeName(node.callee);
   }
 
   return null;
 }
 
-const isFunction = node => node.type === _experimentalUtils.AST_NODE_TYPES.FunctionExpression || node.type === _experimentalUtils.AST_NODE_TYPES.ArrowFunctionExpression;
+const isFunction = node => node.type === _utils.AST_NODE_TYPES.FunctionExpression || node.type === _utils.AST_NODE_TYPES.ArrowFunctionExpression;
 
 exports.isFunction = isFunction;
 
-const isHook = node => node.callee.type === _experimentalUtils.AST_NODE_TYPES.Identifier && HookName.hasOwnProperty(node.callee.name);
+const isHook = node => node.callee.type === _utils.AST_NODE_TYPES.Identifier && HookName.hasOwnProperty(node.callee.name);
 
 exports.isHook = isHook;
 
@@ -389,12 +393,12 @@ const getTestCallExpressionsFromDeclaredVariables = declaredVariables => {
     references
   }) => acc.concat(references.map(({
     identifier
-  }) => identifier.parent).filter(node => !!node && node.type === _experimentalUtils.AST_NODE_TYPES.CallExpression && isTestCaseCall(node))), []);
+  }) => identifier.parent).filter(node => !!node && node.type === _utils.AST_NODE_TYPES.CallExpression && isTestCaseCall(node))), []);
 };
 
 exports.getTestCallExpressionsFromDeclaredVariables = getTestCallExpressionsFromDeclaredVariables;
 
-const isTestCaseName = node => node.type === _experimentalUtils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.name);
+const isTestCaseName = node => node.type === _utils.AST_NODE_TYPES.Identifier && TestCaseName.hasOwnProperty(node.name);
 
 const isTestCaseProperty = node => isSupportedAccessor(node) && TestCaseProperty.hasOwnProperty(getAccessorValue(node));
 /**
@@ -415,15 +419,15 @@ const isTestCaseCall = node => {
     return true;
   }
 
-  const callee = node.callee.type === _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _experimentalUtils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
+  const callee = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
 
-  if (callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isTestCaseProperty(callee.property)) {
+  if (callee.type === _utils.AST_NODE_TYPES.MemberExpression && isTestCaseProperty(callee.property)) {
     // if we're an `each()`, ensure we're the outer CallExpression (i.e `.each()()`)
-    if (getAccessorValue(callee.property) === 'each' && node.callee.type !== _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression && node.callee.type !== _experimentalUtils.AST_NODE_TYPES.CallExpression) {
+    if (getAccessorValue(callee.property) === 'each' && node.callee.type !== _utils.AST_NODE_TYPES.TaggedTemplateExpression && node.callee.type !== _utils.AST_NODE_TYPES.CallExpression) {
       return false;
     }
 
-    return callee.object.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression ? isTestCaseName(callee.object.object) : isTestCaseName(callee.object);
+    return callee.object.type === _utils.AST_NODE_TYPES.MemberExpression ? isTestCaseName(callee.object.object) : isTestCaseName(callee.object);
   }
 
   return false;
@@ -431,7 +435,7 @@ const isTestCaseCall = node => {
 
 exports.isTestCaseCall = isTestCaseCall;
 
-const isDescribeAlias = node => node.type === _experimentalUtils.AST_NODE_TYPES.Identifier && DescribeAlias.hasOwnProperty(node.name);
+const isDescribeAlias = node => node.type === _utils.AST_NODE_TYPES.Identifier && DescribeAlias.hasOwnProperty(node.name);
 
 const isDescribeProperty = node => isSupportedAccessor(node) && DescribeProperty.hasOwnProperty(getAccessorValue(node));
 /**
@@ -452,15 +456,15 @@ const isDescribeCall = node => {
     return true;
   }
 
-  const callee = node.callee.type === _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _experimentalUtils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
+  const callee = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
 
-  if (callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && isDescribeProperty(callee.property)) {
+  if (callee.type === _utils.AST_NODE_TYPES.MemberExpression && isDescribeProperty(callee.property)) {
     // if we're an `each()`, ensure we're the outer CallExpression (i.e `.each()()`)
-    if (getAccessorValue(callee.property) === 'each' && node.callee.type !== _experimentalUtils.AST_NODE_TYPES.TaggedTemplateExpression && node.callee.type !== _experimentalUtils.AST_NODE_TYPES.CallExpression) {
+    if (getAccessorValue(callee.property) === 'each' && node.callee.type !== _utils.AST_NODE_TYPES.TaggedTemplateExpression && node.callee.type !== _utils.AST_NODE_TYPES.CallExpression) {
       return false;
     }
 
-    return callee.object.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression ? isDescribeAlias(callee.object.object) : isDescribeAlias(callee.object);
+    return callee.object.type === _utils.AST_NODE_TYPES.MemberExpression ? isDescribeAlias(callee.object.object) : isDescribeAlias(callee.object);
   }
 
   return false;

package/lib/rules/{valid-describe.js → valid-describe-callback.js}

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
+var _utils = require("@typescript-eslint/utils");
 
-var _utils = require("./utils");
+var _utils2 = require("./utils");
 
 const paramsLocation = params => {
   const [first] = params;
@@ -18,7 +18,7 @@ const paramsLocation = params => {
   };
 };
 
-var _default = (0, _utils.createRule)({
+var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     type: 'problem',
@@ -41,7 +41,7 @@ var _default = (0, _utils.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        if (!(0, _utils.isDescribeCall)(node)) {
+        if (!(0, _utils2.isDescribeCall)(node)) {
           return;
         }
 
@@ -62,7 +62,7 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        if (!(0, _utils.isFunction)(callback)) {
+        if (!(0, _utils2.isFunction)(callback)) {
           context.report({
             messageId: 'secondArgumentMustBeFunction',
             loc: paramsLocation(node.arguments)
@@ -77,23 +77,23 @@ var _default = (0, _utils.createRule)({
           });
         }
 
-        if (!(0, _utils.getNodeName)(node).endsWith('each') && callback.params.length) {
+        if (!(0, _utils2.getNodeName)(node).endsWith('each') && callback.params.length) {
           context.report({
             messageId: 'unexpectedDescribeArgument',
             loc: paramsLocation(callback.params)
           });
         }
 
-        if (callback.body.type === _experimentalUtils.AST_NODE_TYPES.CallExpression) {
+        if (callback.body.type === _utils.AST_NODE_TYPES.CallExpression) {
           context.report({
             messageId: 'unexpectedReturnInDescribe',
             node: callback
           });
         }
 
-        if (callback.body.type === _experimentalUtils.AST_NODE_TYPES.BlockStatement) {
+        if (callback.body.type === _utils.AST_NODE_TYPES.BlockStatement) {
           callback.body.body.forEach(node => {
-            if (node.type === _experimentalUtils.AST_NODE_TYPES.ReturnStatement) {
+            if (node.type === _utils.AST_NODE_TYPES.ReturnStatement) {
               context.report({
                 messageId: 'unexpectedReturnInDescribe',
                 node