@eslint-react/core 2.7.5-next.6 → 2.7.5-next.8

package/dist/index.d.ts

@@ -3,13 +3,12 @@ import { unit } from "@eslint-react/eff";
 import { TSESTree } from "@typescript-eslint/types";
 import { RegExpLike, RuleContext } from "@eslint-react/shared";
 import { ESLintUtils, TSESTree as TSESTree$1 } from "@typescript-eslint/utils";
-import * as birecord0 from "birecord";
 import { Scope } from "@typescript-eslint/scope-manager";
 import * as typescript0 from "typescript";
 
 //#region src/api/is-from-react.d.ts
 /**
- * Checks if a variable is initialized or derived from React import
+ * Check if a variable is initialized from React import
  * @param name The variable name
  * @param initialScope The initial scope
  * @param importSource Alternative import source of React (e.g., "preact/compat")
@@ -19,7 +18,7 @@ declare function isInitializedFromReact(name: string, initialScope: Scope, impor
 //#endregion
 //#region src/api/is-from-react-native.d.ts
 /**
- * Checks if a variable is initialized from React Native import
+ * if a variable is initialized from React Native import
  * @param name The variable name
  * @param initialScope The initial scope
  * @param importSource Alternative import source of React Native (e.g., "react-native-web")
@@ -35,7 +34,7 @@ declare namespace isReactAPI {
   };
 }
 /**
- * Checks if the node is a React API identifier or member expression
+ * Check if the node is a React API identifier or member expression
  * @param api The React API name to check against (e.g., "useState", "React.memo")
  * @returns A predicate function to check if a node matches the API
  */
@@ -47,7 +46,7 @@ declare namespace isReactAPICall {
   };
 }
 /**
- * Checks if the node is a call expression to a specific React API
+ * Check if the node is a call expression to a specific React API
  * @param api The React API name to check against
  * @returns A predicate function to check if a node is a call to the API
  */
@@ -152,6 +151,9 @@ interface SemanticFunc extends SemanticNode {
 //#endregion
 //#region src/component/component-flag.d.ts
 type ComponentFlag = bigint;
+/**
+ * Component flag constants
+ */
 declare const ComponentFlag: {
   /** No flags set */None: bigint; /** Indicates the component is a pure component (e.g., extends PureComponent) */
   PureComponent: bigint; /** Indicates the component creates elements using `createElement` instead of JSX */
@@ -162,7 +164,7 @@ declare const ComponentFlag: {
 //#endregion
 //#region src/component/component-semantic-node.d.ts
 /**
- * Represents a React function component
+ * Represents a React Function Component
  */
 interface FunctionComponentSemanticNode extends SemanticNode {
   /**
@@ -211,7 +213,7 @@ interface FunctionComponentSemanticNode extends SemanticNode {
   displayName: unit | TSESTree.Expression;
 }
 /**
- * Represents a React class component
+ * Represents a React Class Component
  */
 interface ClassComponentSemanticNode extends SemanticNode {
   /**
@@ -244,7 +246,7 @@ interface ClassComponentSemanticNode extends SemanticNode {
   displayName: unit | TSESTree.Expression;
 }
 /**
- * Union type representing either a class or function component
+ * Represents a React Component
  */
 type ComponentSemanticNode = ClassComponentSemanticNode | FunctionComponentSemanticNode;
 //#endregion
@@ -275,7 +277,7 @@ declare namespace useComponentCollector {
   };
 }
 /**
- * Get a ctx and visitor for the rule to collect function components
+ * Get a ctx and visitor object for the rule to collect function components
  * @param context The ESLint rule context
  * @param options The options to use
  * @returns The ctx and visitor of the collector
@@ -292,7 +294,7 @@ declare namespace useComponentCollectorLegacy {
   };
 }
 /**
- * Get a ctx and visitor object for the rule to collect class components
+ * Get a ctx and visitor object for the rule to collect class componentss
  * @param context The ESLint rule context
  * @returns The ctx and visitor of the collector
  */
@@ -312,7 +314,7 @@ declare function isAssignmentToThisState(node: TSESTree$1.AssignmentExpression):
 //#endregion
 //#region src/component/component-definition.d.ts
 /**
- * Determines if a function node represents a valid React component definition
+ * Determine if a function node represents a valid React component definition
  *
  * @param context The rule context
  * @param node The function node to analyze
@@ -322,9 +324,20 @@ declare function isAssignmentToThisState(node: TSESTree$1.AssignmentExpression):
 declare function isComponentDefinition(context: RuleContext, node: AST.TSESTreeFunction, hint: bigint): boolean;
 //#endregion
 //#region src/component/component-id.d.ts
+/**
+ * Get function component identifier from `const Component = memo(() => {});`
+ * @param context The rule context
+ * @param node The function node to analyze
+ * @returns The function identifier or `unit` if not found
+ */
 declare function getFunctionComponentId(context: RuleContext, node: AST.TSESTreeFunction): AST.FunctionID | unit;
 //#endregion
 //#region src/component/component-init-path.d.ts
+/**
+ * Get component flag from init path
+ * @param initPath The init path of the function component
+ * @returns The component flag
+ */
 declare function getComponentFlagFromInitPath(initPath: FunctionComponentSemanticNode["initPath"]): bigint;
 //#endregion
 //#region src/component/component-is.d.ts
@@ -337,24 +350,27 @@ declare function isClassComponent(node: TSESTree.Node): node is AST.TSESTreeClas
 /**
  * Check if a node is a React PureComponent
  * @param node The AST node to check
- * @returns `true` if the node is a pure component, `false` otherwise
+ * @returns `true` if the node is a PureComponent, `false` otherwise
  */
 declare function isPureComponent(node: TSESTree.Node): boolean;
 //#endregion
 //#region src/component/component-kind.d.ts
+/**
+ * Represents the kind of a React component
+ */
 type ComponentKind = "classComponent" | "functionComponent";
 //#endregion
 //#region src/component/component-method-callback.d.ts
 /**
- * Checks if the node is a function of `componentDidMount`
- * @param node The AST node to check
- * @returns `true` if the node is a function of `componentDidMount`
+ * Check if the given node is a componentDidMount callback
+ * @param node The node to check
+ * @returns True if the node is a componentDidMount callback, false otherwise
  */
 declare function isComponentDidMountCallback(node: TSESTree.Node): boolean;
 /**
- * Checks if the node is a function of `componentWillUnmount`
- * @param node The AST node to check
- * @returns `true` if the node is a function of `componentWillUnmount`
+ * Check if the given node is a componentWillUnmount callback
+ * @param node The node to check
+ * @returns True if the node is a componentWillUnmount callback, false otherwise
  */
 declare function isComponentWillUnmountCallback(node: TSESTree.Node): boolean;
 //#endregion
@@ -396,22 +412,6 @@ declare function isComponentNameLoose(name: string): boolean;
  */
 declare function hasNoneOrLooseComponentName(context: RuleContext, fn: AST.TSESTreeFunction): boolean;
 //#endregion
-//#region src/component/component-phase.d.ts
-type ComponentEffectPhaseKind = "cleanup" | "setup";
-type ComponentLifecyclePhaseKind = "mount" | "unmount";
-type ComponentPhaseKind = ComponentEffectPhaseKind | ComponentLifecyclePhaseKind;
-declare const ComponentPhaseRelevance: birecord0.BiRecord<{
-  readonly mount: "unmount";
-  readonly setup: "cleanup";
-}>;
-//#endregion
-//#region src/component/component-phase-helpers.d.ts
-declare const isInversePhase: {
-  (a: ComponentPhaseKind): (b: ComponentPhaseKind) => boolean;
-  (a: ComponentPhaseKind, b: ComponentPhaseKind): boolean;
-};
-declare function getPhaseKindOfFunction(node: AST.TSESTreeFunction): ComponentPhaseKind | null;
-//#endregion
 //#region src/component/component-render-method.d.ts
 /**
  * Check whether given node is a render method of a class component
@@ -510,7 +510,7 @@ declare function isComponentWrapperCallbackLoose(context: RuleContext, node: TSE
 //#endregion
 //#region src/function/function-semantic-node.d.ts
 /**
- * Represents a React function
+ * Represents a React Client Function
  */
 interface ClientFunctionSemanticNode extends SemanticFunc {
   /**
@@ -518,12 +518,18 @@ interface ClientFunctionSemanticNode extends SemanticFunc {
    */
   kind: "client-function";
 }
+/**
+ * Represents a React Server Function
+ */
 interface ServerFunctionSemanticNode extends SemanticFunc {
   /**
    * The kind of function
    */
   kind: "server-function";
 }
+/**
+ * Represents a React Function
+ */
 type FunctionSemanticNode = ClientFunctionSemanticNode | ServerFunctionSemanticNode;
 //#endregion
 //#region src/hierarchy/find-enclosing-component-or-hook.d.ts
@@ -538,7 +544,7 @@ declare function findEnclosingComponentOrHook(node: TSESTree.Node | unit, test?:
 //#endregion
 //#region src/hierarchy/is-inside-component-or-hook.d.ts
 /**
- * Checks if a given AST node is inside a React component or hook
+ * Check if a given AST node is inside a React component or hook
  * @param node The AST node to check
  * @returns True if the node is inside a component or hook, false otherwise
  */
@@ -546,12 +552,12 @@ declare function isInsideComponentOrHook(node: TSESTree.Node | unit): boolean;
 //#endregion
 //#region src/hook/hook-callback.d.ts
 /**
- * Determines if a node is the setup function passed to a useEffect-like hook
+ * Determine if a node is the setup function passed to a useEffect-like hook
  * @param node The AST node to check
  */
 declare function isUseEffectSetupCallback(node: TSESTree.Node | unit): boolean;
 /**
- * Determines if a node is the cleanup function returned by a useEffect-like hook's setup function.
+ * Determine if a node is the cleanup function returned by a useEffect-like hook's setup function.
  * @param node The AST node to check
  */
 declare function isUseEffectCleanupCallback(node: TSESTree.Node | unit): boolean;
@@ -581,7 +587,7 @@ declare namespace useHookCollector {
   };
 }
 /**
- * Get a ctx and visitor for the rule to collect hooks
+ * Get a ctx and visitor object for the rule to collect hooks
  * @param context The ESLint rule context
  * @returns The ctx and visitor of the collector
  */
@@ -592,7 +598,7 @@ declare function isHookId(id: TSESTree.Node): id is TSESTree.Identifier | TSESTr
 //#endregion
 //#region src/hook/hook-is.d.ts
 /**
- * Determines if a function node is a React Hook based on its name.
+ * Determine if a function node is a React Hook based on its name.
  * @param node The function node to check
  * @returns True if the function is a React Hook, false otherwise
  */
@@ -604,21 +610,21 @@ declare function isHook(node: AST.TSESTreeFunction | unit): boolean;
  */
 declare function isHookCall(node: TSESTree.Node | unit): node is TSESTree.CallExpression;
 /**
- * Checks if a node is a call to a specific React hook.
+ * Check if a node is a call to a specific React hook.
  * Returns a function that accepts a hook name to check against.
  * @param node The AST node to check
  * @returns A function that takes a hook name and returns boolean
  */
 declare function isHookCallWithName(node: TSESTree.Node | unit): (name: string) => boolean;
 /**
- * Detects useEffect calls and variations (useLayoutEffect, etc.) using regex pattern.
+ * Detect useEffect calls and variations (useLayoutEffect, etc.) using a regex pattern
  * @param node The AST node to check
  * @param additionalEffectHooks Regex pattern matching custom hooks that should be treated as effect hooks
  * @returns True if the node is a useEffect-like call
  */
 declare function isUseEffectLikeCall(node: TSESTree.Node | unit, additionalEffectHooks?: RegExpLike): node is TSESTree.CallExpression;
 /**
- * Detects useState calls and variations (useCustomState, etc.) using regex pattern.
+ * Detect useState calls and variations (useCustomState, etc.) using a regex pattern
  * @param node The AST node to check
  * @param additionalStateHooks Regex pattern matching custom hooks that should be treated as state hooks
  * @returns True if the node is a useState-like call
@@ -702,7 +708,7 @@ type JsxAttributeValue = {
   toStatic(): unknown;
 };
 /**
- * Resolves the static value of a JSX attribute or spread attribute
+ * Resolve the static value of a JSX attribute or spread attribute
  *
  * @param context - The ESLint rule context
  * @param attribute - The JSX attribute node to resolve
@@ -792,13 +798,13 @@ declare const JsxDetectionHint: {
  */
 declare const DEFAULT_JSX_DETECTION_HINT: bigint;
 /**
- * Checks if a node is a `JSXText` or a `Literal` node
+ * Check if a node is a `JSXText` or a `Literal` node
  * @param node The AST node to check
  * @returns `true` if the node is a `JSXText` or a `Literal` node
  */
 declare function isJsxText(node: TSESTree$1.Node | null | unit): node is TSESTree$1.JSXText | TSESTree$1.Literal;
 /**
- * Determines if a node represents JSX-like content based on heuristics
+ * Determine if a node represents JSX-like content based on heuristics
  * Supports configuration through hint flags to customize detection behavior
  *
  * @param code The source code with scope lookup capability
@@ -813,7 +819,7 @@ declare function isJsxLike(code: {
 //#endregion
 //#region src/jsx/jsx-element-is.d.ts
 /**
- * Determines if a JSX element is a host element
+ * Determine if a JSX element is a host element
  * Host elements in React start with lowercase letters (e.g., div, span)
  *
  * @param context ESLint rule context
@@ -822,7 +828,7 @@ declare function isJsxLike(code: {
  */
 declare function isJsxHostElement(context: RuleContext, node: TSESTree.Node): boolean;
 /**
- * Determines if a JSX element is a React Fragment
+ * Determine if a JSX element is a React Fragment
  * Fragments can be imported from React and used like <Fragment> or <React.Fragment>
  *
  * @param context ESLint rule context
@@ -867,7 +873,7 @@ declare function stringifyJsx(node: TSESTree$1.JSXIdentifier | TSESTree$1.JSXNam
 //#endregion
 //#region src/ref/is-from-ref.d.ts
 /**
- * Checks if the variable with the given name is initialized or derived from a ref
+ * Check if the variable with the given name is initialized or derived from a ref
  * @param name The variable name
  * @param initialScope The initial scope
  * @returns True if the variable is derived from a ref, false otherwise
@@ -876,10 +882,10 @@ declare function isInitializedFromRef(name: string, initialScope: Scope): boolea
 //#endregion
 //#region src/ref/ref-name.d.ts
 /**
- * Checks if a given name corresponds to a ref name
+ * Check if a given name corresponds to a ref name
  * @param name The name to check
  * @returns True if the name is "ref" or ends with "Ref"
  */
 declare function isRefName(name: string): boolean;
 //#endregion
-export { ClassComponentSemanticNode, ClientFunctionSemanticNode, ComponentDetectionHint, ComponentEffectPhaseKind, ComponentFlag, ComponentKind, ComponentLifecyclePhaseKind, ComponentPhaseKind, ComponentPhaseRelevance, ComponentSemanticNode, DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, FindEnclosingComponentOrHookFilter, FunctionComponentSemanticNode, FunctionSemanticNode, HookSemanticNode, JsxAttributeValue, JsxConfig, JsxDetectionHint, JsxEmit, REACT_BUILTIN_HOOK_NAMES, SemanticFunc, SemanticNode, ServerFunctionSemanticNode, findEnclosingComponentOrHook, findParentJsxAttribute, getComponentFlagFromInitPath, getFunctionComponentId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, getPhaseKindOfFunction, hasNoneOrLooseComponentName, isAssignmentToThisState, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDefinition, isComponentDidCatch, isComponentDidMount, isComponentDidMountCallback, isComponentDidUpdate, isComponentName, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUnmountCallback, isComponentWillUpdate, isComponentWrapperCall, isComponentWrapperCallLoose, isComponentWrapperCallback, isComponentWrapperCallbackLoose, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRef, isForwardRefCall, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHook, isHookCall, isHookCallWithName, isHookId, isHookName, isInitializedFromReact, isInitializedFromReactNative, isInitializedFromRef, isInsideComponentOrHook, isInversePhase, isJsxFragmentElement, isJsxHostElement, isJsxLike, isJsxText, isLazy, isLazyCall, isMemo, isMemoCall, isPureComponent, isReactAPI, isReactAPICall, isRefName, isRender, isRenderFunctionLoose, isRenderMethodLike, isRenderPropLoose, isShouldComponentUpdate, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseActionStateCall, isUseCall, isUseCallbackCall, isUseContextCall, isUseDebugValueCall, isUseDeferredValueCall, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatusCall, isUseIdCall, isUseImperativeHandleCall, isUseInsertionEffectCall, isUseLayoutEffectCall, isUseMemoCall, isUseOptimisticCall, isUseReducerCall, isUseRefCall, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStoreCall, isUseTransitionCall, resolveJsxAttributeValue, stringifyJsx, useComponentCollector, useComponentCollectorLegacy, useHookCollector };
+export { ClassComponentSemanticNode, ClientFunctionSemanticNode, ComponentDetectionHint, ComponentFlag, ComponentKind, ComponentSemanticNode, DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, FindEnclosingComponentOrHookFilter, FunctionComponentSemanticNode, FunctionSemanticNode, HookSemanticNode, JsxAttributeValue, JsxConfig, JsxDetectionHint, JsxEmit, REACT_BUILTIN_HOOK_NAMES, SemanticFunc, SemanticNode, ServerFunctionSemanticNode, findEnclosingComponentOrHook, findParentJsxAttribute, getComponentFlagFromInitPath, getFunctionComponentId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, hasNoneOrLooseComponentName, isAssignmentToThisState, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDefinition, isComponentDidCatch, isComponentDidMount, isComponentDidMountCallback, isComponentDidUpdate, isComponentName, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUnmountCallback, isComponentWillUpdate, isComponentWrapperCall, isComponentWrapperCallLoose, isComponentWrapperCallback, isComponentWrapperCallbackLoose, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRef, isForwardRefCall, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHook, isHookCall, isHookCallWithName, isHookId, isHookName, isInitializedFromReact, isInitializedFromReactNative, isInitializedFromRef, isInsideComponentOrHook, isJsxFragmentElement, isJsxHostElement, isJsxLike, isJsxText, isLazy, isLazyCall, isMemo, isMemoCall, isPureComponent, isReactAPI, isReactAPICall, isRefName, isRender, isRenderFunctionLoose, isRenderMethodLike, isRenderPropLoose, isShouldComponentUpdate, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseActionStateCall, isUseCall, isUseCallbackCall, isUseContextCall, isUseDebugValueCall, isUseDeferredValueCall, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatusCall, isUseIdCall, isUseImperativeHandleCall, isUseInsertionEffectCall, isUseLayoutEffectCall, isUseMemoCall, isUseOptimisticCall, isUseReducerCall, isUseRefCall, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStoreCall, isUseTransitionCall, resolveJsxAttributeValue, stringifyJsx, useComponentCollector, useComponentCollectorLegacy, useHookCollector };

package/dist/index.js

@@ -6,11 +6,10 @@ import { IdGenerator, RE_ANNOTATION_JSX, RE_ANNOTATION_JSX_FRAG, RE_ANNOTATION_J
 import { getStaticValue } from "@typescript-eslint/utils/ast-utils";
 import { P, match } from "ts-pattern";
 import { AST_NODE_TYPES as AST_NODE_TYPES$1 } from "@typescript-eslint/utils";
-import birecord from "birecord";
 
 //#region src/api/is-from-react.ts
 /**
-* Checks if a variable is initialized or derived from React import
+* Check if a variable is initialized from React import
 * @param name The variable name
 * @param initialScope The initial scope
 * @param importSource Alternative import source of React (e.g., "preact/compat")
@@ -23,7 +22,7 @@ function isInitializedFromReact(name, initialScope, importSource = "react") {
 //#endregion
 //#region src/api/is-from-react-native.ts
 /**
-* Checks if a variable is initialized from React Native import
+* if a variable is initialized from React Native import
 * @param name The variable name
 * @param initialScope The initial scope
 * @param importSource Alternative import source of React Native (e.g., "react-native-web")
@@ -40,7 +39,7 @@ function isInitializedFromReactNative(name, initialScope, importSource = "react-
 //#endregion
 //#region src/api/is-react-api.ts
 /**
-* Checks if the node is a React API identifier or member expression
+* Check if the node is a React API identifier or member expression
 * @param api The React API name to check against (e.g., "useState", "React.memo")
 * @returns A predicate function to check if a node matches the API
 */
@@ -56,7 +55,7 @@ function isReactAPI(api) {
 	return dual(2, func);
 }
 /**
-* Checks if the node is a call expression to a specific React API
+* Check if the node is a call expression to a specific React API
 * @param api The React API name to check against
 * @returns A predicate function to check if a node is a call to the API
 */
@@ -131,7 +130,7 @@ function isHookName(name) {
 //#endregion
 //#region src/hook/hook-is.ts
 /**
-* Determines if a function node is a React Hook based on its name.
+* Determine if a function node is a React Hook based on its name.
 * @param node The function node to check
 * @returns True if the function is a React Hook, false otherwise
 */
@@ -157,7 +156,7 @@ function isHookCall(node) {
 	return false;
 }
 /**
-* Checks if a node is a call to a specific React hook.
+* Check if a node is a call to a specific React hook.
 * Returns a function that accepts a hook name to check against.
 * @param node The AST node to check
 * @returns A function that takes a hook name and returns boolean
@@ -173,7 +172,7 @@ function isHookCallWithName(node) {
 	};
 }
 /**
-* Detects useEffect calls and variations (useLayoutEffect, etc.) using regex pattern.
+* Detect useEffect calls and variations (useLayoutEffect, etc.) using a regex pattern
 * @param node The AST node to check
 * @param additionalEffectHooks Regex pattern matching custom hooks that should be treated as effect hooks
 * @returns True if the node is a useEffect-like call
@@ -188,7 +187,7 @@ function isUseEffectLikeCall(node, additionalEffectHooks = { test: constFalse })
 	});
 }
 /**
-* Detects useState calls and variations (useCustomState, etc.) using regex pattern.
+* Detect useState calls and variations (useCustomState, etc.) using a regex pattern
 * @param node The AST node to check
 * @param additionalStateHooks Regex pattern matching custom hooks that should be treated as state hooks
 * @returns True if the node is a useState-like call
@@ -225,7 +224,7 @@ const isUseTransitionCall = flip(isHookCallWithName)("useTransition");
 //#endregion
 //#region src/hook/hook-callback.ts
 /**
-* Determines if a node is the setup function passed to a useEffect-like hook
+* Determine if a node is the setup function passed to a useEffect-like hook
 * @param node The AST node to check
 */
 function isUseEffectSetupCallback(node) {
@@ -233,7 +232,7 @@ function isUseEffectSetupCallback(node) {
 	return node.parent?.type === AST_NODE_TYPES.CallExpression && node.parent.arguments.at(0) === node && isUseEffectLikeCall(node.parent);
 }
 /**
-* Determines if a node is the cleanup function returned by a useEffect-like hook's setup function.
+* Determine if a node is the cleanup function returned by a useEffect-like hook's setup function.
 * @param node The AST node to check
 */
 function isUseEffectCleanupCallback(node) {
@@ -258,7 +257,7 @@ function isHookId(id) {
 //#region src/hook/hook-collector.ts
 const idGen$2 = new IdGenerator("hook_");
 /**
-* Get a ctx and visitor for the rule to collect hooks
+* Get a ctx and visitor object for the rule to collect hooks
 * @param context The ESLint rule context
 * @returns The ctx and visitor of the collector
 */
@@ -388,7 +387,7 @@ function getJsxAttribute(context, node, initialScope) {
 //#endregion
 //#region src/jsx/jsx-attribute-value.ts
 /**
-* Resolves the static value of a JSX attribute or spread attribute
+* Resolve the static value of a JSX attribute or spread attribute
 *
 * @param context - The ESLint rule context
 * @param attribute - The JSX attribute node to resolve
@@ -536,7 +535,7 @@ const JsxDetectionHint = {
 */
 const DEFAULT_JSX_DETECTION_HINT = 0n | JsxDetectionHint.SkipUndefined | JsxDetectionHint.SkipBooleanLiteral;
 /**
-* Checks if a node is a `JSXText` or a `Literal` node
+* Check if a node is a `JSXText` or a `Literal` node
 * @param node The AST node to check
 * @returns `true` if the node is a `JSXText` or a `Literal` node
 */
@@ -545,7 +544,7 @@ function isJsxText(node) {
 	return node.type === AST_NODE_TYPES.JSXText || node.type === AST_NODE_TYPES.Literal;
 }
 /**
-* Determines if a node represents JSX-like content based on heuristics
+* Determine if a node represents JSX-like content based on heuristics
 * Supports configuration through hint flags to customize detection behavior
 *
 * @param code The source code with scope lookup capability
@@ -627,7 +626,7 @@ function getJsxElementType(context, node) {
 //#endregion
 //#region src/jsx/jsx-element-is.ts
 /**
-* Determines if a JSX element is a host element
+* Determine if a JSX element is a host element
 * Host elements in React start with lowercase letters (e.g., div, span)
 *
 * @param context ESLint rule context
@@ -638,7 +637,7 @@ function isJsxHostElement(context, node) {
 	return node.type === AST_NODE_TYPES.JSXElement && node.openingElement.name.type === AST_NODE_TYPES.JSXIdentifier && /^[a-z]/u.test(node.openingElement.name.name);
 }
 /**
-* Determines if a JSX element is a React Fragment
+* Determine if a JSX element is a React Fragment
 * Fragments can be imported from React and used like <Fragment> or <React.Fragment>
 *
 * @param context ESLint rule context
@@ -709,7 +708,7 @@ function isClassComponent(node) {
 /**
 * Check if a node is a React PureComponent
 * @param node The AST node to check
-* @returns `true` if the node is a pure component, `false` otherwise
+* @returns `true` if the node is a PureComponent, `false` otherwise
 */
 function isPureComponent(node) {
 	if ("superClass" in node && node.superClass != null) {
@@ -743,7 +742,7 @@ function isRenderMethodLike(node) {
 //#endregion
 //#region src/component/component-definition.ts
 /**
-* Checks if the given node is a function within a render method of a class component.
+* Check if the given node is a function within a render method of a class component.
 *
 * @param node The AST node to check
 * @returns `true` if the node is a render function inside a class component
@@ -761,7 +760,7 @@ function isRenderMethodCallback(node) {
 	return greatGrandparent != null && isRenderMethodLike(parent) && isClassComponent(greatGrandparent);
 }
 /**
-* Checks if a function node should be excluded based on provided detection hints
+* Check if a function node should be excluded based on provided detection hints
 *
 * @param node The function node to check
 * @param hint Component detection hints as bit flags
@@ -779,7 +778,7 @@ function shouldExcludeBasedOnHint(node, hint) {
 	return false;
 }
 /**
-* Determines if the node is an argument within `createElement`'s children list (3rd argument onwards)
+* Determine if the node is an argument within `createElement`'s children list (3rd argument onwards)
 *
 * @param context The rule context
 * @param node The AST node to check
@@ -792,7 +791,7 @@ function isChildrenOfCreateElement(context, node) {
 	return parent.arguments.slice(2).some((arg) => arg === node);
 }
 /**
-* Determines if a function node represents a valid React component definition
+* Determine if a function node represents a valid React component definition
 *
 * @param context The rule context
 * @param node The function node to analyze
@@ -863,6 +862,12 @@ function isComponentWrapperCallbackLoose(context, node) {
 
 //#endregion
 //#region src/component/component-id.ts
+/**
+* Get function component identifier from `const Component = memo(() => {});`
+* @param context The rule context
+* @param node The function node to analyze
+* @returns The function identifier or `unit` if not found
+*/
 function getFunctionComponentId(context, node) {
 	const functionId = AST.getFunctionId(node);
 	if (functionId != null) return functionId;
@@ -874,6 +879,9 @@ function getFunctionComponentId(context, node) {
 
 //#endregion
 //#region src/component/component-flag.ts
+/**
+* Component flag constants
+*/
 const ComponentFlag = {
 	None: 0n,
 	PureComponent: 1n << 0n,
@@ -884,6 +892,11 @@ const ComponentFlag = {
 
 //#endregion
 //#region src/component/component-init-path.ts
+/**
+* Get component flag from init path
+* @param initPath The init path of the function component
+* @returns The component flag
+*/
 function getComponentFlagFromInitPath(initPath) {
 	let flag = ComponentFlag.None;
 	if (initPath != null && AST.hasCallInFunctionInitPath("memo", initPath)) flag |= ComponentFlag.Memo;
@@ -924,7 +937,7 @@ function hasNoneOrLooseComponentName(context, fn) {
 //#region src/component/component-collector.ts
 const idGen$1 = new IdGenerator("function_component_");
 /**
-* Get a ctx and visitor for the rule to collect function components
+* Get a ctx and visitor object for the rule to collect function components
 * @param context The ESLint rule context
 * @param options The options to use
 * @returns The ctx and visitor of the collector
@@ -1044,7 +1057,7 @@ function useComponentCollector(context, options = {}) {
 //#region src/component/component-collector-legacy.ts
 const idGen = new IdGenerator("class_component_");
 /**
-* Get a ctx and visitor object for the rule to collect class components
+* Get a ctx and visitor object for the rule to collect class componentss
 * @param context The ESLint rule context
 * @returns The ctx and visitor of the collector
 */
@@ -1107,9 +1120,7 @@ function isAssignmentToThisState(node) {
 * @param isStatic Whether the method is static
 */
 function createLifecycleChecker(methodName, isStatic = false) {
-	return function(node) {
-		return AST.isMethodOrProperty(node) && node.static === isStatic && node.key.type === AST_NODE_TYPES.Identifier && node.key.name === methodName;
-	};
+	return (node) => AST.isMethodOrProperty(node) && node.static === isStatic && node.key.type === AST_NODE_TYPES.Identifier && node.key.name === methodName;
 }
 const isRender = createLifecycleChecker("render");
 const isComponentDidCatch = createLifecycleChecker("componentDidCatch");
@@ -1133,36 +1144,22 @@ const isGetDerivedStateFromError = createLifecycleChecker("getDerivedStateFromEr
 //#endregion
 //#region src/component/component-method-callback.ts
 /**
-* Checks if the node is a function of `componentDidMount`
-* @param node The AST node to check
-* @returns `true` if the node is a function of `componentDidMount`
+* Check if the given node is a componentDidMount callback
+* @param node The node to check
+* @returns True if the node is a componentDidMount callback, false otherwise
 */
 function isComponentDidMountCallback(node) {
 	return AST.isFunction(node) && isComponentDidMount(node.parent) && node.parent.value === node;
 }
 /**
-* Checks if the node is a function of `componentWillUnmount`
-* @param node The AST node to check
-* @returns `true` if the node is a function of `componentWillUnmount`
+* Check if the given node is a componentWillUnmount callback
+* @param node The node to check
+* @returns True if the node is a componentWillUnmount callback, false otherwise
 */
 function isComponentWillUnmountCallback(node) {
 	return AST.isFunction(node) && isComponentWillUnmount(node.parent) && node.parent.value === node;
 }
 
-//#endregion
-//#region src/component/component-phase.ts
-const ComponentPhaseRelevance = birecord({
-	mount: "unmount",
-	setup: "cleanup"
-});
-
-//#endregion
-//#region src/component/component-phase-helpers.ts
-const isInversePhase = dual(2, (a, b) => ComponentPhaseRelevance.get(a) === b);
-function getPhaseKindOfFunction(node) {
-	return match(node).when(isUseEffectSetupCallback, () => "setup").when(isUseEffectCleanupCallback, () => "cleanup").when(isComponentDidMountCallback, () => "mount").when(isComponentWillUnmountCallback, () => "unmount").otherwise(() => null);
-}
-
 //#endregion
 //#region src/component/component-render-prop.ts
 /**
@@ -1262,7 +1259,7 @@ function findEnclosingComponentOrHook(node, test = (n, name) => {
 //#endregion
 //#region src/hierarchy/is-inside-component-or-hook.ts
 /**
-* Checks if a given AST node is inside a React component or hook
+* Check if a given AST node is inside a React component or hook
 * @param node The AST node to check
 * @returns True if the node is inside a component or hook, false otherwise
 */
@@ -1273,7 +1270,7 @@ function isInsideComponentOrHook(node) {
 //#endregion
 //#region src/ref/ref-name.ts
 /**
-* Checks if a given name corresponds to a ref name
+* Check if a given name corresponds to a ref name
 * @param name The name to check
 * @returns True if the name is "ref" or ends with "Ref"
 */
@@ -1284,7 +1281,7 @@ function isRefName(name) {
 //#endregion
 //#region src/ref/is-from-ref.ts
 /**
-* Checks if the variable with the given name is initialized or derived from a ref
+* Check if the variable with the given name is initialized or derived from a ref
 * @param name The variable name
 * @param initialScope The initial scope
 * @returns True if the variable is derived from a ref, false otherwise
@@ -1303,4 +1300,4 @@ function isInitializedFromRef(name, initialScope) {
 }
 
 //#endregion
-export { ComponentDetectionHint, ComponentFlag, ComponentPhaseRelevance, DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, JsxDetectionHint, JsxEmit, REACT_BUILTIN_HOOK_NAMES, findEnclosingComponentOrHook, findParentJsxAttribute, getComponentFlagFromInitPath, getFunctionComponentId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, getPhaseKindOfFunction, hasNoneOrLooseComponentName, isAssignmentToThisState, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDefinition, isComponentDidCatch, isComponentDidMount, isComponentDidMountCallback, isComponentDidUpdate, isComponentName, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUnmountCallback, isComponentWillUpdate, isComponentWrapperCall, isComponentWrapperCallLoose, isComponentWrapperCallback, isComponentWrapperCallbackLoose, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRef, isForwardRefCall, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHook, isHookCall, isHookCallWithName, isHookId, isHookName, isInitializedFromReact, isInitializedFromReactNative, isInitializedFromRef, isInsideComponentOrHook, isInversePhase, isJsxFragmentElement, isJsxHostElement, isJsxLike, isJsxText, isLazy, isLazyCall, isMemo, isMemoCall, isPureComponent, isReactAPI, isReactAPICall, isRefName, isRender, isRenderFunctionLoose, isRenderMethodLike, isRenderPropLoose, isShouldComponentUpdate, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseActionStateCall, isUseCall, isUseCallbackCall, isUseContextCall, isUseDebugValueCall, isUseDeferredValueCall, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatusCall, isUseIdCall, isUseImperativeHandleCall, isUseInsertionEffectCall, isUseLayoutEffectCall, isUseMemoCall, isUseOptimisticCall, isUseReducerCall, isUseRefCall, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStoreCall, isUseTransitionCall, resolveJsxAttributeValue, stringifyJsx, useComponentCollector, useComponentCollectorLegacy, useHookCollector };
+export { ComponentDetectionHint, ComponentFlag, DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, JsxDetectionHint, JsxEmit, REACT_BUILTIN_HOOK_NAMES, findEnclosingComponentOrHook, findParentJsxAttribute, getComponentFlagFromInitPath, getFunctionComponentId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, hasNoneOrLooseComponentName, isAssignmentToThisState, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDefinition, isComponentDidCatch, isComponentDidMount, isComponentDidMountCallback, isComponentDidUpdate, isComponentName, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUnmountCallback, isComponentWillUpdate, isComponentWrapperCall, isComponentWrapperCallLoose, isComponentWrapperCallback, isComponentWrapperCallbackLoose, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRef, isForwardRefCall, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHook, isHookCall, isHookCallWithName, isHookId, isHookName, isInitializedFromReact, isInitializedFromReactNative, isInitializedFromRef, isInsideComponentOrHook, isJsxFragmentElement, isJsxHostElement, isJsxLike, isJsxText, isLazy, isLazyCall, isMemo, isMemoCall, isPureComponent, isReactAPI, isReactAPICall, isRefName, isRender, isRenderFunctionLoose, isRenderMethodLike, isRenderPropLoose, isShouldComponentUpdate, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseActionStateCall, isUseCall, isUseCallbackCall, isUseContextCall, isUseDebugValueCall, isUseDeferredValueCall, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatusCall, isUseIdCall, isUseImperativeHandleCall, isUseInsertionEffectCall, isUseLayoutEffectCall, isUseMemoCall, isUseOptimisticCall, isUseReducerCall, isUseRefCall, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStoreCall, isUseTransitionCall, resolveJsxAttributeValue, stringifyJsx, useComponentCollector, useComponentCollectorLegacy, useHookCollector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "2.7.5-next.6",
+  "version": "2.7.5-next.8",
   "description": "ESLint React's ESLint utility module for static analysis of React core APIs and patterns.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -33,12 +33,11 @@
     "@typescript-eslint/scope-manager": "^8.54.0",
     "@typescript-eslint/types": "^8.54.0",
     "@typescript-eslint/utils": "^8.54.0",
-    "birecord": "^0.1.1",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "2.7.5-next.6",
-    "@eslint-react/eff": "2.7.5-next.6",
-    "@eslint-react/var": "2.7.5-next.6",
-    "@eslint-react/shared": "2.7.5-next.6"
+    "@eslint-react/ast": "2.7.5-next.8",
+    "@eslint-react/eff": "2.7.5-next.8",
+    "@eslint-react/shared": "2.7.5-next.8",
+    "@eslint-react/var": "2.7.5-next.8"
   },
   "devDependencies": {
     "tsdown": "^0.20.1",