refactor: update useComponentCollector function parameters and related documentation

Author: Rel1cx

packages/core/docs/functions/isFunctionOfUseEffectCleanup.md

@@ -12,7 +12,7 @@
 
 ### node
 
-[`Node`](../-internal-/type-aliases/Node.md)
+`undefined` | [`Node`](../-internal-/type-aliases/Node.md)
 
 ## Returns
 

packages/core/docs/functions/useComponentCollector.md

@@ -6,7 +6,7 @@
 
 # Function: useComponentCollector()
 
-> **useComponentCollector**(`context`, `hint`, `options`): [`ReturnType`](../namespaces/useComponentCollector/type-aliases/ReturnType.md)
+> **useComponentCollector**(`context`, `options`): [`ReturnType`](../namespaces/useComponentCollector/type-aliases/ReturnType.md)
 
 Get a ctx and listeners for the rule to collect function components
 
@@ -18,12 +18,6 @@ Get a ctx and listeners for the rule to collect function components
 
 The ESLint rule context
 
-### hint
-
-`bigint` = `DEFAULT_COMPONENT_HINT`
-
-The hint to use
-
 ### options
 
 [`Options`](../namespaces/useComponentCollector/type-aliases/Options.md) = `{}`

packages/core/docs/namespaces/useComponentCollector/type-aliases/Options.md

@@ -17,3 +17,7 @@
 ### collectHookCalls?
 
 > `optional` **collectHookCalls**: `boolean`
+
+### hint?
+
+> `optional` **hint**: [`ERComponentHint`](../../../type-aliases/ERComponentHint.md)

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

@@ -9,6 +9,7 @@ import type { ESLintUtils } from "@typescript-eslint/utils";
 
 import { isReactHookCall } from "../hook";
 import { DISPLAY_NAME_ASSIGNMENT_SELECTOR } from "../utils";
+import type { ERComponentHint } from "./component-collector-hint";
 import { DEFAULT_COMPONENT_HINT } from "./component-collector-hint";
 import { ERComponentFlag } from "./component-flag";
 import { getFunctionComponentIdentifier } from "./component-id";
@@ -27,6 +28,7 @@ export declare namespace useComponentCollector {
   type Options = {
     collectDisplayName?: boolean;
     collectHookCalls?: boolean;
+    hint?: ERComponentHint;
   };
   type ReturnType = {
     ctx: {
@@ -41,16 +43,18 @@ export declare namespace useComponentCollector {
 /**
  * Get a ctx and listeners for the rule to collect function components
  * @param context The ESLint rule context
- * @param hint The hint to use
  * @param options The options to use
  * @returns The component collector
  */
 export function useComponentCollector(
   context: RuleContext,
-  hint = DEFAULT_COMPONENT_HINT,
   options: useComponentCollector.Options = {},
 ): useComponentCollector.ReturnType {
-  const { collectDisplayName = false, collectHookCalls = false } = options;
+  const {
+    collectDisplayName = false,
+    collectHookCalls = false,
+    hint = DEFAULT_COMPONENT_HINT,
+  } = options;
 
   const jsxCtx = { getScope: (node: TSESTree.Node) => context.sourceCode.getScope(node) } as const;
   const components = new Map<string, ERFunctionComponent>();

packages/core/src/effect/is.ts

@@ -14,9 +14,10 @@ export function isFunctionOfUseEffectSetup(node: TSESTree.Node | _) {
     && isUseEffectCallLoose(node.parent);
 }
 
-export function isFunctionOfUseEffectCleanup(node: TSESTree.Node) {
-  const nearReturn = AST.findParentNode(node, AST.is(T.ReturnStatement));
-  const nearFunction = AST.findParentNode(node, AST.isFunction);
-  const nearFunctionOfReturn = AST.findParentNode(nearReturn, AST.isFunction);
-  return nearFunction === nearFunctionOfReturn && isFunctionOfUseEffectSetup(nearFunction);
+export function isFunctionOfUseEffectCleanup(node: TSESTree.Node | _) {
+  if (node == null) return _;
+  const returnStatement = AST.findParentNode(node, AST.is(T.ReturnStatement));
+  const enclosingFunction = AST.findParentNode(node, AST.isFunction);
+  const functionOfReturnStatement = AST.findParentNode(returnStatement, AST.isFunction);
+  return enclosingFunction === functionOfReturnStatement && isFunctionOfUseEffectSetup(enclosingFunction);
 }

packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts

@@ -29,10 +29,10 @@ export default createRule<[], MessageID>({
   create(context) {
     const { ctx, listeners } = useComponentCollector(
       context,
-      DEFAULT_COMPONENT_HINT,
       {
         collectDisplayName: true,
         collectHookCalls: true,
+        hint: DEFAULT_COMPONENT_HINT,
       },
     );
     return {

packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.ts

@@ -47,8 +47,8 @@ export default createRule<[], MessageID>({
       listeners,
     } = useComponentCollector(
       context,
-      DEFAULT_COMPONENT_HINT,
       {
+        hint: DEFAULT_COMPONENT_HINT,
         collectDisplayName: false,
         collectHookCalls: true,
       },

packages/plugins/eslint-plugin-react-x/src/rules/no-missing-component-display-name.ts

@@ -35,8 +35,8 @@ export default createRule<[], MessageID>({
       listeners,
     } = useComponentCollector(
       context,
-      DEFAULT_COMPONENT_HINT,
       {
+        hint: DEFAULT_COMPONENT_HINT,
         collectDisplayName: true,
         collectHookCalls: false,
       },

packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.ts

@@ -50,7 +50,7 @@ export default createRule<[], MessageID>({
       | ERComponentHint.StrictLogical
       | ERComponentHint.StrictConditional;
 
-    const collector = useComponentCollector(context, hint);
+    const collector = useComponentCollector(context, { hint });
     const collectorLegacy = useComponentCollectorLegacy();
 
     return {