feat(core): ComponentCollector adds options to skip the collection of… (#917)

Author: Rel1cx

packages/core/docs/README.md

@@ -6,6 +6,7 @@
 
 ## Interfaces
 
+- [ComponentCollectorOptions](interfaces/ComponentCollectorOptions.md)
 - [ERClassComponent](interfaces/ERClassComponent.md)
 - [ERFunctionComponent](interfaces/ERFunctionComponent.md)
 - [ERHook](interfaces/ERHook.md)
@@ -30,6 +31,7 @@
 
 ## Variables
 
+- [DEFAULT\_COMPONENT\_COLLECT\_OPTIONS](variables/DEFAULT_COMPONENT_COLLECT_OPTIONS.md)
 - [DEFAULT\_COMPONENT\_HINT](variables/DEFAULT_COMPONENT_HINT.md)
 - [ERClassComponentFlag](variables/ERClassComponentFlag.md)
 - [ERComponentHint](variables/ERComponentHint.md)

packages/core/docs/functions/useComponentCollector.md

@@ -6,7 +6,7 @@
 
 # Function: useComponentCollector()
 
-> **useComponentCollector**(`context`, `hint`): `object`
+> **useComponentCollector**(`context`, `hint`, `options`): `object`
 
 ## Parameters
 
@@ -18,6 +18,10 @@
 
 `bigint` = `DEFAULT_COMPONENT_HINT`
 
+### options
+
+[`ComponentCollectorOptions`](../interfaces/ComponentCollectorOptions.md) = `DEFAULT_COMPONENT_COLLECT_OPTIONS`
+
 ## Returns
 
 `object`
@@ -84,7 +88,7 @@
 
 `void`
 
-#### listeners.AssignmentExpression\[type\]\[operator='='\]\[left.type='MemberExpression'\]\[left.property.name='displayName'\]()
+#### listeners.AssignmentExpression\[type\]\[operator='='\]\[left.type='MemberExpression'\]\[left.property.name='displayName'\]()?
 
 ##### Parameters
 
@@ -96,7 +100,7 @@
 
 `void`
 
-#### listeners.CallExpression\[type\]:exit()
+#### listeners.CallExpression\[type\]:exit()?
 
 ##### Parameters
 

packages/core/docs/interfaces/ComponentCollectorOptions.md

@@ -0,0 +1,19 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / ComponentCollectorOptions
+
+# Interface: ComponentCollectorOptions
+
+## Properties
+
+### collectDisplayName
+
+> **collectDisplayName**: `boolean`
+
+***
+
+### collectHookCalls
+
+> **collectHookCalls**: `boolean`

packages/core/docs/variables/DEFAULT_COMPONENT_COLLECT_OPTIONS.md

@@ -0,0 +1,9 @@
+[**@eslint-react/core**](../README.md)
+
+***
+
+[@eslint-react/core](../README.md) / DEFAULT\_COMPONENT\_COLLECT\_OPTIONS
+
+# Variable: DEFAULT\_COMPONENT\_COLLECT\_OPTIONS
+
+> `const` **DEFAULT\_COMPONENT\_COLLECT\_OPTIONS**: [`ComponentCollectorOptions`](../interfaces/ComponentCollectorOptions.md)

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

@@ -1,3 +1,4 @@
+/* eslint-disable no-restricted-syntax */
 import * as AST from "@eslint-react/ast";
 import { _ } from "@eslint-react/eff";
 import * as JSX from "@eslint-react/jsx";
@@ -57,10 +58,21 @@ function getComponentFlag(initPath: ERFunctionComponent["initPath"]) {
   return flag;
 }
 
+export interface ComponentCollectorOptions {
+  collectDisplayName?: boolean;
+  collectHookCalls?: boolean;
+}
+
+// dprint-ignore
+const displayNameAssignmentSelector = "AssignmentExpression[type][operator='='][left.type='MemberExpression'][left.property.name='displayName']";
+
 export function useComponentCollector(
   context: RuleContext,
   hint = DEFAULT_COMPONENT_HINT,
+  options: ComponentCollectorOptions = {},
 ) {
+  const { collectDisplayName = false, collectHookCalls = false } = options;
+
   const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
   const components = new Map<string, ERFunctionComponent>();
   const functionEntries: {
@@ -69,6 +81,7 @@ export function useComponentCollector(
     hookCalls: TSESTree.CallExpression[];
     isComponent: boolean;
   }[] = [];
+
   const getCurrentEntry = () => functionEntries.at(-1);
   const onFunctionEnter = (node: AST.TSESTreeFunction) => {
     const key = getId();
@@ -137,34 +150,36 @@ export function useComponentCollector(
         initPath,
       });
     },
-    "AssignmentExpression[type][operator='='][left.type='MemberExpression'][left.property.name='displayName']"(
-      node: TSESTree.AssignmentExpression & { left: TSESTree.MemberExpression },
-    ) {
-      const { left, right } = node;
-      const componentName = left.object.type === T.Identifier
-        ? left.object.name
-        : _;
-      const component = [...components.values()]
-        .findLast(({ name }) => name != null && name === componentName);
-      if (component == null) {
-        return;
+    ...collectDisplayName
+      ? {
+        [displayNameAssignmentSelector](node: TSESTree.AssignmentExpression & { left: TSESTree.MemberExpression }) {
+          const { left, right } = node;
+          const componentName = left.object.type === T.Identifier
+            ? left.object.name
+            : _;
+          const component = [...components.values()]
+            .findLast(({ name }) => name != null && name === componentName);
+          if (component == null) {
+            return;
+          }
+          component.displayName = right;
+        },
       }
-      components.set(component.key, {
-        ...component,
-        displayName: right,
-      });
-    },
-    "CallExpression[type]:exit"(node: TSESTree.CallExpression) {
-      if (!isReactHookCall(node)) {
-        return;
+      : {},
+    ...collectHookCalls
+      ? {
+        "CallExpression[type]:exit"(node: TSESTree.CallExpression) {
+          if (!isReactHookCall(node)) {
+            return;
+          }
+          const entry = getCurrentEntry();
+          if (entry == null) {
+            return;
+          }
+          entry.hookCalls.push(node);
+        },
       }
-      const entry = getCurrentEntry();
-      if (entry == null) {
-        return;
-      }
-      functionEntries.pop();
-      functionEntries.push({ ...entry, hookCalls: [...entry.hookCalls, node] });
-    },
+      : {},
     "ReturnStatement[type]"(node: TSESTree.ReturnStatement) {
       const entry = getCurrentEntry();
       if (entry == null) {

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

@@ -57,13 +57,7 @@ export function useHookCollector() {
       if (hook == null) {
         return;
       }
-      hooks.set(hook.key, {
-        ...hook,
-        hookCalls: [
-          ...hook.hookCalls,
-          node,
-        ],
-      });
+      hook.hookCalls.push(node);
     },
   } as const satisfies ESLintUtils.RuleListener;
   return { ctx, listeners } as const;