feat(core): add 'COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR' and 'isComponentDisplayNameAssignment' function

Author: Rel1cx

packages/core/docs/README.md

@@ -29,6 +29,7 @@
 
 ## Variables
 
+- [COMPONENT\_DISPLAY\_NAME\_ASSIGNMENT\_SELECTOR](variables/COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR.md)
 - [DEFAULT\_COMPONENT\_HINT](variables/DEFAULT_COMPONENT_HINT.md)
 - [ERClassComponentFlag](variables/ERClassComponentFlag.md)
 - [ERComponentHint](variables/ERComponentHint.md)
@@ -60,6 +61,7 @@
 - [isCloneElementCall](functions/isCloneElementCall.md)
 - [isComponentDidCatch](functions/isComponentDidCatch.md)
 - [isComponentDidMount](functions/isComponentDidMount.md)
+- [isComponentDisplayNameAssignment](functions/isComponentDisplayNameAssignment.md)
 - [isComponentName](functions/isComponentName.md)
 - [isComponentWillUnmount](functions/isComponentWillUnmount.md)
 - [isCreateContext](functions/isCreateContext.md)

packages/core/docs/functions/isComponentDisplayNameAssignment.md

@@ -0,0 +1,25 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / isComponentDisplayNameAssignment
+
+# Function: isComponentDisplayNameAssignment()
+
+> **isComponentDisplayNameAssignment**(`node`): `node is AssignmentExpression`
+
+Check if the node is a component display name assignment expression
+
+## Parameters
+
+### node
+
+The AST node
+
+`undefined` | `Node`
+
+## Returns
+
+`node is AssignmentExpression`
+
+`true` if the node is a component display name assignment

packages/core/docs/functions/useComponentCollector.md

@@ -98,18 +98,6 @@ The component collector
 
 `void`
 
-#### listeners.AssignmentExpression\[type\]\[operator='='\]\[left.type='MemberExpression'\]\[left.property.name='displayName'\]()?
-
-##### Parameters
-
-###### node
-
-`AssignmentExpression` & `object`
-
-##### Returns
-
-`void`
-
 #### listeners.CallExpression\[type\]:exit()?
 
 ##### Parameters

packages/core/docs/variables/COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR.md

@@ -0,0 +1,11 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / COMPONENT\_DISPLAY\_NAME\_ASSIGNMENT\_SELECTOR
+
+# Variable: COMPONENT\_DISPLAY\_NAME\_ASSIGNMENT\_SELECTOR
+
+> `const` **COMPONENT\_DISPLAY\_NAME\_ASSIGNMENT\_SELECTOR**: `string`
+
+The ESQuery selector for a component display name assignment expression

packages/core/src/component/component-collector.ts

@@ -10,6 +10,7 @@ import type { ESLintUtils } from "@typescript-eslint/utils";
 import { isChildrenOfCreateElement } from "../element";
 import { isReactHookCall } from "../hook";
 import { DEFAULT_COMPONENT_HINT, ERComponentHint } from "./component-collector-hint";
+import { COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR } from "./component-display-name";
 import { ERFunctionComponentFlag } from "./component-flag";
 import { getFunctionComponentIdentifier } from "./component-id";
 import { isFunctionOfRenderMethod } from "./component-lifecycle";
@@ -61,9 +62,6 @@ export interface ComponentCollectorOptions {
   collectHookCalls?: boolean;
 }
 
-// dprint-ignore
-const displayNameAssignmentSelector = "AssignmentExpression[type][operator='='][left.type='MemberExpression'][left.property.name='displayName']";
-
 /**
  * Get a ctx and listeners for the rule to collect function components
  * @param context The ESLint rule context
@@ -157,8 +155,9 @@ export function useComponentCollector(
     },
     ...collectDisplayName
       ? {
-        [displayNameAssignmentSelector](node: TSESTree.AssignmentExpression & { left: TSESTree.MemberExpression }) {
+        [COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR](node: TSESTree.AssignmentExpression) {
           const { left, right } = node;
+          if (left.type !== T.MemberExpression) return;
           const componentName = left.object.type === T.Identifier
             ? left.object.name
             : _;

packages/core/src/component/component-display-name.ts

@@ -0,0 +1,27 @@
+import type { _ } from "@eslint-react/eff";
+import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
+
+/**
+ * The ESQuery selector for a component display name assignment expression
+ */
+export const COMPONENT_DISPLAY_NAME_ASSIGNMENT_SELECTOR = [
+  "AssignmentExpression",
+  "[type]",
+  "[operator='=']",
+  "[left.type='MemberExpression']",
+  "[left.property.name='displayName']",
+].join("");
+
+/**
+ * Check if the node is a component display name assignment expression
+ * @param node The AST node
+ * @returns `true` if the node is a component display name assignment
+ */
+export function isComponentDisplayNameAssignment(node: TSESTree.Node | _): node is TSESTree.AssignmentExpression {
+  if (node == null) return false;
+  return node.type === T.AssignmentExpression
+    && node.operator === "="
+    && node.left.type === T.MemberExpression
+    && node.left.property.type === T.Identifier
+    && node.left.property.name === "displayName";
+}

packages/core/src/component/index.ts

@@ -1,6 +1,7 @@
 export * from "./component-collector";
 export * from "./component-collector-hint";
 export * from "./component-collector-legacy";
+export * from "./component-display-name";
 export * from "./component-flag";
 export * from "./component-id";
 export type * from "./component-kind";

packages/utilities/ast/src/find-parent-node.ts

@@ -2,26 +2,20 @@ import { _ } from "@eslint-react/eff";
 import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
 
 /**
- * Find the parent node that satisfies the predicate function
+ * Find the parent node that satisfies the test function
  * @param node The AST node
- * @param predicate The predicate function
- * @returns The parent node that satisfies the predicate or `undefined` if not found
+ * @param test The test function
+ * @returns The parent node that satisfies the test function or `_` if not found
  */
-export function findParentNode<A extends TSESTree.Node>(
-  node: TSESTree.Node | _,
-  predicate: (n: TSESTree.Node) => n is A,
-): A | _;
+function findParentNode<A extends TSESTree.Node>(node: TSESTree.Node | _, test: (n: TSESTree.Node) => n is A): A | _;
 /**
- * Find the parent node that satisfies the test function
+ * Find the parent node that satisfies the test function or `_` if not found
  * @param node The AST node
  * @param test The test function
- * @returns The parent node that satisfies the test or `undefined` if not found
+ * @returns The parent node that satisfies the test function
  */
-export function findParentNode(
-  node: TSESTree.Node | _,
-  test: (node: TSESTree.Node) => boolean,
-): TSESTree.Node | _;
-export function findParentNode<A extends TSESTree.Node>(
+function findParentNode(node: TSESTree.Node | _, test: (node: TSESTree.Node) => boolean): TSESTree.Node | _;
+function findParentNode<A extends TSESTree.Node>(
   node: TSESTree.Node | _,
   test: ((node: TSESTree.Node) => boolean) | ((n: TSESTree.Node) => n is A),
 ): TSESTree.Node | A | _ {
@@ -35,3 +29,5 @@ export function findParentNode<A extends TSESTree.Node>(
   }
   return _;
 }
+
+export { findParentNode };