chore(utils): create isDescribeEach guard

jest-community · Oct 31, 2019 · 2224c95 · 2224c95
1 parent d620388
commit 2224c95
Showing 1 changed file with 29 additions and 4 deletions.
diff --git a/src/rules/utils.ts b/src/rules/utils.ts
@@ -550,22 +550,32 @@ export enum TestCaseProperty {
 }
 
 export type JestFunctionName = DescribeAlias | TestCaseName | HookName;
+export type JestPropertyName = DescribeProperty | TestCaseProperty;
 
 export interface JestFunctionIdentifier<FunctionName extends JestFunctionName>
   extends TSESTree.Identifier {
   name: FunctionName;
 }
 
 export interface JestFunctionMemberExpression<
-  FunctionName extends JestFunctionName
-> extends TSESTree.MemberExpression {
+  FunctionName extends JestFunctionName,
+  PropertyName extends JestPropertyName = JestPropertyName
+> extends KnownMemberExpression<PropertyName> {
+  object: JestFunctionIdentifier<FunctionName>;
+}
+
+export interface JestFunctionMemberExpression<
+  FunctionName extends JestFunctionName,
+  PropertyName extends JestPropertyName = JestPropertyName
+> extends KnownMemberExpression<PropertyName> {
   object: JestFunctionIdentifier<FunctionName>;
 }
 
 export interface JestFunctionCallExpressionWithMemberExpressionCallee<
-  FunctionName extends JestFunctionName
+  FunctionName extends JestFunctionName,
+  PropertyName extends JestPropertyName = JestPropertyName
 > extends TSESTree.CallExpression {
-  callee: JestFunctionMemberExpression<FunctionName>;
+  callee: JestFunctionMemberExpression<FunctionName, PropertyName>;
 }
 
 export interface JestFunctionCallExpressionWithIdentifierCallee<
@@ -651,6 +661,21 @@ export const isDescribe = (
   );
 };
 
+/**
+ * Checks if the given `describe` is a call to `describe.each`.
+ *
+ * @param {JestFunctionCallExpression<DescribeAlias>} node
+ * @return {node is JestFunctionCallExpression<DescribeAlias, DescribeProperty.each>}
+ */
+export const isDescribeEach = (
+  node: JestFunctionCallExpression<DescribeAlias>,
+): node is JestFunctionCallExpressionWithMemberExpressionCallee<
+  DescribeAlias,
+  DescribeProperty.each
+> =>
+  node.callee.type === AST_NODE_TYPES.MemberExpression &&
+  isSupportedAccessor(node.callee.property, DescribeProperty.each);
+
 /**
  * Gets the arguments of the given `JestFunctionCallExpression`.
  *