@eslint-react/core 5.17.2 → 5.18.0

package/dist/index.js

@@ -511,69 +511,133 @@ function isAPICall(api) {
 	};
 	return dual(2, func);
 }
+/** Check if the node is a React `captureOwnerStack` API identifier or member expression. */
 const isCaptureOwnerStack = isAPI("captureOwnerStack");
+/** Check if the node is a React `Children.count` API identifier or member expression. */
 const isChildrenCount = isAPI("Children.count");
+/** Check if the node is a React `Children.forEach` API identifier or member expression. */
 const isChildrenForEach = isAPI("Children.forEach");
+/** Check if the node is a React `Children.map` API identifier or member expression. */
 const isChildrenMap = isAPI("Children.map");
+/** Check if the node is a React `Children.only` API identifier or member expression. */
 const isChildrenOnly = isAPI("Children.only");
+/** Check if the node is a React `Children.toArray` API identifier or member expression. */
 const isChildrenToArray = isAPI("Children.toArray");
+/** Check if the node is a React `cloneElement` API identifier or member expression. */
 const isCloneElement = isAPI("cloneElement");
+/** Check if the node is a React `createContext` API identifier or member expression. */
 const isCreateContext = isAPI("createContext");
+/** Check if the node is a React `createElement` API identifier or member expression. */
 const isCreateElement = isAPI("createElement");
+/** Check if the node is a React `createRef` API identifier or member expression. */
 const isCreateRef = isAPI("createRef");
+/** Check if the node is a React `forwardRef` API identifier or member expression. */
 const isForwardRef = isAPI("forwardRef");
+/** Check if the node is a React `memo` API identifier or member expression. */
 const isMemo = isAPI("memo");
+/** Check if the node is a React `lazy` API identifier or member expression. */
 const isLazy = isAPI("lazy");
+/** Check if the node is a call expression to the React `captureOwnerStack` API. */
 const isCaptureOwnerStackCall = isAPICall("captureOwnerStack");
+/** Check if the node is a call expression to the React `Children.count` API. */
 const isChildrenCountCall = isAPICall("Children.count");
+/** Check if the node is a call expression to the React `Children.forEach` API. */
 const isChildrenForEachCall = isAPICall("Children.forEach");
+/** Check if the node is a call expression to the React `Children.map` API. */
 const isChildrenMapCall = isAPICall("Children.map");
+/** Check if the node is a call expression to the React `Children.only` API. */
 const isChildrenOnlyCall = isAPICall("Children.only");
+/** Check if the node is a call expression to the React `Children.toArray` API. */
 const isChildrenToArrayCall = isAPICall("Children.toArray");
+/** Check if the node is a call expression to the React `cloneElement` API. */
 const isCloneElementCall = isAPICall("cloneElement");
+/** Check if the node is a call expression to the React `createContext` API. */
 const isCreateContextCall = isAPICall("createContext");
+/** Check if the node is a call expression to the React `createElement` API. */
 const isCreateElementCall = isAPICall("createElement");
+/** Check if the node is a call expression to the React `createRef` API. */
 const isCreateRefCall = isAPICall("createRef");
+/** Check if the node is a call expression to the React `forwardRef` API. */
 const isForwardRefCall = isAPICall("forwardRef");
+/** Check if the node is a call expression to the React `memo` API. */
 const isMemoCall = isAPICall("memo");
+/** Check if the node is a call expression to the React `lazy` API. */
 const isLazyCall = isAPICall("lazy");
+/** Check if the node is a React `use` API identifier or member expression. */
 const isUse = isAPI("use");
+/** Check if the node is a React `useActionState` API identifier or member expression. */
 const isUseActionState = isAPI("useActionState");
+/** Check if the node is a React `useCallback` API identifier or member expression. */
 const isUseCallback = isAPI("useCallback");
+/** Check if the node is a React `useContext` API identifier or member expression. */
 const isUseContext = isAPI("useContext");
+/** Check if the node is a React `useDebugValue` API identifier or member expression. */
 const isUseDebugValue = isAPI("useDebugValue");
+/** Check if the node is a React `useDeferredValue` API identifier or member expression. */
 const isUseDeferredValue = isAPI("useDeferredValue");
+/** Check if the node is a React `useEffect` API identifier or member expression. */
 const isUseEffect = isAPI("useEffect");
+/** Check if the node is a React `useFormStatus` API identifier or member expression. */
 const isUseFormStatus = isAPI("useFormStatus");
+/** Check if the node is a React `useId` API identifier or member expression. */
 const isUseId = isAPI("useId");
+/** Check if the node is a React `useImperativeHandle` API identifier or member expression. */
 const isUseImperativeHandle = isAPI("useImperativeHandle");
+/** Check if the node is a React `useInsertionEffect` API identifier or member expression. */
 const isUseInsertionEffect = isAPI("useInsertionEffect");
+/** Check if the node is a React `useLayoutEffect` API identifier or member expression. */
 const isUseLayoutEffect = isAPI("useLayoutEffect");
+/** Check if the node is a React `useMemo` API identifier or member expression. */
 const isUseMemo = isAPI("useMemo");
+/** Check if the node is a React `useOptimistic` API identifier or member expression. */
 const isUseOptimistic = isAPI("useOptimistic");
+/** Check if the node is a React `useReducer` API identifier or member expression. */
 const isUseReducer = isAPI("useReducer");
+/** Check if the node is a React `useRef` API identifier or member expression. */
 const isUseRef = isAPI("useRef");
+/** Check if the node is a React `useState` API identifier or member expression. */
 const isUseState = isAPI("useState");
+/** Check if the node is a React `useSyncExternalStore` API identifier or member expression. */
 const isUseSyncExternalStore = isAPI("useSyncExternalStore");
+/** Check if the node is a React `useTransition` API identifier or member expression. */
 const isUseTransition = isAPI("useTransition");
+/** Check if the node is a call expression to the React `use` API. */
 const isUseCall = isAPICall("use");
+/** Check if the node is a call expression to the React `useActionState` API. */
 const isUseActionStateCall = isAPICall("useActionState");
+/** Check if the node is a call expression to the React `useCallback` API. */
 const isUseCallbackCall = isAPICall("useCallback");
+/** Check if the node is a call expression to the React `useContext` API. */
 const isUseContextCall = isAPICall("useContext");
+/** Check if the node is a call expression to the React `useDebugValue` API. */
 const isUseDebugValueCall = isAPICall("useDebugValue");
+/** Check if the node is a call expression to the React `useDeferredValue` API. */
 const isUseDeferredValueCall = isAPICall("useDeferredValue");
+/** Check if the node is a call expression to the React `useEffect` API. */
 const isUseEffectCall = isAPICall("useEffect");
+/** Check if the node is a call expression to the React `useFormStatus` API. */
 const isUseFormStatusCall = isAPICall("useFormStatus");
+/** Check if the node is a call expression to the React `useId` API. */
 const isUseIdCall = isAPICall("useId");
+/** Check if the node is a call expression to the React `useImperativeHandle` API. */
 const isUseImperativeHandleCall = isAPICall("useImperativeHandle");
+/** Check if the node is a call expression to the React `useInsertionEffect` API. */
 const isUseInsertionEffectCall = isAPICall("useInsertionEffect");
+/** Check if the node is a call expression to the React `useLayoutEffect` API. */
 const isUseLayoutEffectCall = isAPICall("useLayoutEffect");
+/** Check if the node is a call expression to the React `useMemo` API. */
 const isUseMemoCall = isAPICall("useMemo");
+/** Check if the node is a call expression to the React `useOptimistic` API. */
 const isUseOptimisticCall = isAPICall("useOptimistic");
+/** Check if the node is a call expression to the React `useReducer` API. */
 const isUseReducerCall = isAPICall("useReducer");
+/** Check if the node is a call expression to the React `useRef` API. */
 const isUseRefCall = isAPICall("useRef");
+/** Check if the node is a call expression to the React `useState` API. */
 const isUseStateCall = isAPICall("useState");
+/** Check if the node is a call expression to the React `useSyncExternalStore` API. */
 const isUseSyncExternalStoreCall = isAPICall("useSyncExternalStore");
+/** Check if the node is a call expression to the React `useTransition` API. */
 const isUseTransitionCall = isAPICall("useTransition");
 
 //#endregion
@@ -581,7 +645,7 @@ const isUseTransitionCall = isAPICall("useTransition");
 /**
 * Get the class identifier of a class node.
 * @param node The class node to get the identifier from.
-* @returns The class identifier or null if not found.
+* @returns The class identifier or `null` if not found.
 */
 function getClassId(node) {
 	if (node.id != null) return node.id;
@@ -591,6 +655,11 @@ function getClassId(node) {
 
 //#endregion
 //#region src/class-component.ts
+/**
+* Check if the node is a class component (extends `Component` or `PureComponent`).
+* @param node The node to check.
+* @returns `true` if the node is a class component.
+*/
 function isClassComponent(node) {
 	if ("superClass" in node && node.superClass != null) {
 		const re = /^(?:Pure)?Component$/u;
@@ -602,7 +671,9 @@ function isClassComponent(node) {
 	return false;
 }
 /**
+* Check if the node is a pure component (extends `PureComponent`).
 * @param node The AST node to check.
+* @returns `true` if the node is a pure component.
 * @deprecated Class components are legacy. This function exists only to support legacy rules.
 */
 function isPureComponent(node) {
@@ -655,19 +726,28 @@ const isGetDerivedStateFromProps = createLifecycleChecker("getDerivedStateFromPr
 /** @deprecated Class components are legacy. */
 const isGetDerivedStateFromError = createLifecycleChecker("getDerivedStateFromError", true);
 /**
+* Check if the node is a render-like method of a class component.
 * @param node The AST node to check.
+* @returns `true` if the node is a render-like method.
 * @deprecated Class components are legacy. This function exists only to support legacy rules.
 */
 function isRenderMethodLike(node) {
 	return Check.isPropertyOrMethod(node) && node.key.type === AST_NODE_TYPES.Identifier && node.key.name.startsWith("render") && Check.isOneOf([AST_NODE_TYPES.ClassDeclaration, AST_NODE_TYPES.ClassExpression])(node.parent.parent);
 }
+/**
+* Check if the function is a callback passed to a class component's render method.
+* @param node The function node to check.
+* @returns `true` if the function is a render method callback.
+*/
 function isRenderMethodCallback(node) {
 	const parent = node.parent;
 	const greatGrandparent = parent.parent?.parent;
 	return greatGrandparent != null && isRenderMethodLike(parent) && isClassComponent(greatGrandparent);
 }
 /**
+* Check if the call expression is a `this.setState(...)` call.
 * @param node The call expression node to check.
+* @returns `true` if the node is a `this.setState(...)` call.
 * @deprecated Class components are legacy. This function exists only to support legacy rules.
 */
 function isThisSetStateCall(node) {
@@ -675,7 +755,9 @@ function isThisSetStateCall(node) {
 	return callee.type === AST_NODE_TYPES.MemberExpression && callee.object.type === AST_NODE_TYPES.ThisExpression && Extract.getCalleeName(node) === "setState";
 }
 /**
+* Check if the assignment expression assigns to `this.state`.
 * @param node The assignment expression node to check.
+* @returns `true` if the node assigns to `this.state`.
 * @deprecated Class components are legacy. This function exists only to support legacy rules.
 */
 function isAssignmentToThisState(node) {
@@ -692,6 +774,7 @@ function isAssignmentToThisState(node) {
 //#endregion
 //#region src/class-component-collector.ts
 /**
+* Get an api and visitor object for the rule to collect class components.
 * @param context The rule context.
 * @deprecated Class components are legacy. This function exists only to support legacy rules.
 */
@@ -730,7 +813,7 @@ function getClassComponentCollector(context) {
 //#endregion
 //#region src/function.ts
 /**
-* Gets the static identifier of a function AST node.
+* Get the static identifier of a function AST node.
 *
 * @remarks
 * For function declarations this is straightforward. For anonymous function
@@ -757,7 +840,7 @@ function getFunctionId(node) {
 	return null;
 }
 /**
-* Identifies the initialization path of a function node in the AST.
+* Get the initialization path of a function node in the AST.
 *
 * @param node The function node to analyze.
 * @returns The function initialization path or `null` if not identifiable.
@@ -808,7 +891,7 @@ function getFunctionInitPath(node) {
 	return null;
 }
 /**
-* Checks if a specific function call exists in the function initialization path.
+* Check if a specific function call exists in the function initialization path.
 *
 * @param callName The name of the call to check for (e.g., "memo", "forwardRef").
 * @param initPath The function initialization path to search in.
@@ -824,7 +907,7 @@ function isFunctionHasCallInInitPath(callName, initPath) {
 	});
 }
 /**
-* Checks if a function is empty.
+* Check if a function is empty.
 *
 * @param node The function node to check.
 * @returns `true` if the function is empty, `false` otherwise.
@@ -832,6 +915,11 @@ function isFunctionHasCallInInitPath(callName, initPath) {
 function isFunctionEmpty(node) {
 	return node.body.type === AST_NODE_TYPES.BlockStatement && node.body.body.length === 0;
 }
+/**
+* Get the directives of a function (ex: "use strict", "use client", "use server").
+* @param node The function node to get the directives from.
+* @returns The directives of the function.
+*/
 function getFunctionDirectives(node) {
 	const directives = [];
 	if (node.body.type !== AST_NODE_TYPES.BlockStatement) return directives;
@@ -845,7 +933,7 @@ function getFunctionDirectives(node) {
 	return directives;
 }
 /**
-* Checks if a directive with the given name exists in the function directives.
+* Check if a directive with the given name exists in the function directives.
 *
 * @param node The function AST node.
 * @param name The directive name to check (e.g., "use memo", "use no memo").
@@ -854,6 +942,7 @@ function getFunctionDirectives(node) {
 function isFunctionHasDirective(node, name) {
 	return getFunctionDirectives(node).some((d) => d.directive === name);
 }
+/** The esquery selector matching `displayName` assignment expressions. */
 const SEL_FUNCTION_DISPLAY_NAME_ASSIGNMENT = [
 	"AssignmentExpression",
 	"[operator='=']",
@@ -867,17 +956,29 @@ const SEL_FUNCTION_DISPLAY_NAME_ASSIGNMENT = [
 * Hints for JSX detection.
 */
 const JsxDetectionHint = {
+	/** No hints set. */
 	None: 0n,
+	/** Do not treat `null` values as JSX-like. */
 	DoNotIncludeJsxWithNullValue: 1n << 0n,
+	/** Do not treat number values as JSX-like. */
 	DoNotIncludeJsxWithNumberValue: 1n << 1n,
+	/** Do not treat bigint values as JSX-like. */
 	DoNotIncludeJsxWithBigIntValue: 1n << 2n,
+	/** Do not treat string values as JSX-like. */
 	DoNotIncludeJsxWithStringValue: 1n << 3n,
+	/** Do not treat boolean values as JSX-like. */
 	DoNotIncludeJsxWithBooleanValue: 1n << 4n,
+	/** Do not treat undefined values as JSX-like. */
 	DoNotIncludeJsxWithUndefinedValue: 1n << 5n,
+	/** Do not treat empty array values as JSX-like. */
 	DoNotIncludeJsxWithEmptyArrayValue: 1n << 6n,
+	/** Do not treat `createElement` calls as JSX-like. */
 	DoNotIncludeJsxWithCreateElementValue: 1n << 7n,
+	/** Require all array elements to be JSX-like for the array to be JSX-like. */
 	RequireAllArrayElementsToBeJsx: 1n << 8n,
+	/** Require both sides of a logical expression to be JSX-like. */
 	RequireBothSidesOfLogicalExpressionToBeJsx: 1n << 9n,
+	/** Require both branches of a conditional expression to be JSX-like. */
 	RequireBothBranchesOfConditionalExpressionToBeJsx: 1n << 10n
 };
 /**
@@ -889,9 +990,9 @@ const JsxDetectionHint = {
 */
 const DEFAULT_JSX_DETECTION_HINT = 0n | JsxDetectionHint.DoNotIncludeJsxWithNumberValue | JsxDetectionHint.DoNotIncludeJsxWithBigIntValue | JsxDetectionHint.DoNotIncludeJsxWithBooleanValue | JsxDetectionHint.DoNotIncludeJsxWithStringValue | JsxDetectionHint.DoNotIncludeJsxWithUndefinedValue;
 /**
-* Determine whether a node represents JSX-like content based on heuristics.
+* Check if the node represents JSX-like content based on heuristics.
 *
-* The detection behaviour is configurable through {@link JsxDetectionHint}
+* The detection behavior is configurable through {@link JsxDetectionHint}
 * bit-flags so that callers can opt individual value kinds in or out.
 *
 * Identifiers are resolved to their definitions via scope analysis;
@@ -899,8 +1000,8 @@ const DEFAULT_JSX_DETECTION_HINT = 0n | JsxDetectionHint.DoNotIncludeJsxWithNumb
 * treated as not JSX-like instead of recursing indefinitely.
 *
 * @param context The ESLint rule context (needed for variable resolution).
-* @param node The AST node to analyse.
-* @param hint Optional bit-flags to adjust detection behaviour. Defaults to {@link DEFAULT_JSX_DETECTION_HINT}.
+* @param node The AST node to analyze.
+* @param hint Optional bit-flags to adjust detection behavior. Defaults to {@link DEFAULT_JSX_DETECTION_HINT}.
 * @returns Whether the node is considered JSX-like.
 *
 * @example
@@ -1023,6 +1124,7 @@ function getFunctionComponentId(context, node) {
 /**
 * Check if a string matches the strict component name pattern.
 * @param name The name to check.
+* @returns `true` if the name matches the strict component name pattern.
 */
 function isFunctionComponentName(name) {
 	return RE_COMPONENT_NAME.test(name);
@@ -1030,6 +1132,7 @@ function isFunctionComponentName(name) {
 /**
 * Check if a string matches the loose component name pattern.
 * @param name The name to check.
+* @returns `true` if the name matches the loose component name pattern.
 */
 function isFunctionComponentNameLoose(name) {
 	return RE_COMPONENT_NAME_LOOSE.test(name);
@@ -1039,7 +1142,7 @@ function isFunctionComponentNameLoose(name) {
 * @param context The rule context.
 * @param fn The function to check.
 * @param allowNone Whether to allow no name.
-* @returns Whether the function has a loose component name.
+* @returns `true` if the function has a loose component name.
 */
 function isFunctionWithLooseComponentName(context, fn, allowNone = false) {
 	const id = getFunctionComponentId(context, fn);
@@ -1053,13 +1156,21 @@ function isFunctionWithLooseComponentName(context, fn, allowNone = false) {
 */
 const FunctionComponentDetectionHint = {
 	...JsxDetectionHint,
+	/** Exclude functions defined as class methods from component detection. */
 	DoNotIncludeFunctionDefinedAsClassMethod: 1n << 11n,
+	/** Exclude functions defined as class properties from component detection. */
 	DoNotIncludeFunctionDefinedAsClassProperty: 1n << 12n,
+	/** Exclude functions defined as object methods from component detection. */
 	DoNotIncludeFunctionDefinedAsObjectMethod: 1n << 13n,
+	/** Exclude functions defined as array expression elements from component detection. */
 	DoNotIncludeFunctionDefinedAsArrayExpressionElement: 1n << 14n,
+	/** Exclude functions defined as array pattern elements from component detection. */
 	DoNotIncludeFunctionDefinedAsArrayPatternElement: 1n << 15n,
+	/** Exclude functions defined as array flatMap callbacks from component detection. */
 	DoNotIncludeFunctionDefinedAsArrayFlatMapCallback: 1n << 16n,
+	/** Exclude functions defined as array map callbacks from component detection. */
 	DoNotIncludeFunctionDefinedAsArrayMapCallback: 1n << 17n,
+	/** Exclude functions defined as arbitrary call expression callbacks from component detection. */
 	DoNotIncludeFunctionDefinedAsArbitraryCallExpressionCallback: 1n << 18n
 };
 /**
@@ -1067,7 +1178,7 @@ const FunctionComponentDetectionHint = {
 */
 const DEFAULT_COMPONENT_DETECTION_HINT = 0n | FunctionComponentDetectionHint.DoNotIncludeJsxWithBigIntValue | FunctionComponentDetectionHint.DoNotIncludeJsxWithBooleanValue | FunctionComponentDetectionHint.DoNotIncludeJsxWithNumberValue | FunctionComponentDetectionHint.DoNotIncludeJsxWithStringValue | FunctionComponentDetectionHint.DoNotIncludeJsxWithUndefinedValue | FunctionComponentDetectionHint.DoNotIncludeFunctionDefinedAsArbitraryCallExpressionCallback | FunctionComponentDetectionHint.DoNotIncludeFunctionDefinedAsArrayExpressionElement | FunctionComponentDetectionHint.DoNotIncludeFunctionDefinedAsArrayFlatMapCallback | FunctionComponentDetectionHint.DoNotIncludeFunctionDefinedAsArrayMapCallback | FunctionComponentDetectionHint.DoNotIncludeFunctionDefinedAsArrayPatternElement | FunctionComponentDetectionHint.RequireAllArrayElementsToBeJsx | FunctionComponentDetectionHint.RequireBothBranchesOfConditionalExpressionToBeJsx | FunctionComponentDetectionHint.RequireBothSidesOfLogicalExpressionToBeJsx;
 /**
-* Determine if a function node represents a valid React component definition.
+* Check if the function node is a valid React component definition.
 *
 * @param context The rule context.
 * @param node The function node to analyze.
@@ -1130,6 +1241,7 @@ function isFunctionComponentDefinition(context, node, hint) {
 
 //#endregion
 //#region src/hook.ts
+/** The names of React's built-in hooks. */
 const REACT_BUILTIN_HOOK_NAMES = [
 	"use",
 	"useActionState",
@@ -1152,9 +1264,9 @@ const REACT_BUILTIN_HOOK_NAMES = [
 	"useTransition"
 ];
 /**
-* Catch all identifiers that begin with "use" followed by an uppercase Latin
-* character to exclude identifiers like "user".
+* Check if the name is a hook name (starts with `use` followed by an uppercase letter or digit).
 * @param name The name of the identifier to check.
+* @returns `true` if the name is a hook name.
 * @see https://github.com/facebook/react/blob/1d6c8168db1d82713202e842df3167787ffa00ed/packages/eslint-plugin-react-hooks/src/rules/RulesOfHooks.ts#L16
 */
 function isHookName(name) {
@@ -1182,9 +1294,9 @@ function isHookTag(tag) {
 	return isHookId(Extract.unwrap(tag));
 }
 /**
-* Determine if a function node is a React Hook based on its name.
+* Check if the function node is a hook definition based on its name.
 * @param node The function node to check.
-* @returns True if the function is a React Hook, false otherwise.
+* @returns `true` if the function is a hook definition.
 */
 function isHookDefinition(node) {
 	if (node == null) return false;
@@ -1196,7 +1308,7 @@ function isHookDefinition(node) {
 	}
 }
 /**
-* Check if the given node is a React Hook call by its name.
+* Check if the node is a React Hook call by its name.
 * @param node The node to check.
 * @returns `true` if the node is a React Hook call, `false` otherwise.
 */
@@ -1208,23 +1320,23 @@ function isHookCall(node) {
 	return isHookName(name);
 }
 /**
-* Detect useEffect calls and variations (useLayoutEffect, etc.) using a regex pattern.
+* Check if the node is a useRef-like call (ex: `useRef` or a custom ref hook).
 * @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.
+* @param additionalRefHooks Regex pattern matching custom hooks that should be treated as ref hooks.
+* @returns `true` if the node is a useRef-like call.
 */
-function isUseEffectLikeCall(node, additionalEffectHooks = { test: constFalse }) {
+function isUseRefLikeCall(node, additionalRefHooks = { test: constFalse }) {
 	if (node == null) return false;
 	if (node.type !== AST_NODE_TYPES.CallExpression) return false;
 	const name = Extract.getCalleeName(node);
 	if (name == null) return false;
-	return /^use\w*Effect$/u.test(name) || additionalEffectHooks.test(name);
+	return name === "useRef" || additionalRefHooks.test(name);
 }
 /**
-* Detect useState calls and variations using a regex pattern.
+* Check if the node is a useState-like call (ex: `useState` or a custom state hook).
 * @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.
+* @returns `true` if the node is a useState-like call.
 */
 function isUseStateLikeCall(node, additionalStateHooks = { test: constFalse }) {
 	if (node == null) return false;
@@ -1234,8 +1346,22 @@ function isUseStateLikeCall(node, additionalStateHooks = { test: constFalse }) {
 	return name === "useState" || additionalStateHooks.test(name);
 }
 /**
-* Determine if a node is the setup function passed to a useEffect-like hook.
+* Check if the node is a useEffect-like call (ex: `useEffect`, `useLayoutEffect`, or a custom effect hook).
 * @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.
+*/
+function isUseEffectLikeCall(node, additionalEffectHooks = { test: constFalse }) {
+	if (node == null) return false;
+	if (node.type !== AST_NODE_TYPES.CallExpression) return false;
+	const name = Extract.getCalleeName(node);
+	if (name == null) return false;
+	return /^use\w*Effect$/u.test(name) || additionalEffectHooks.test(name);
+}
+/**
+* Check if the node is the setup callback passed to a useEffect-like call.
+* @param node The AST node to check.
+* @returns `true` if the node is a useEffect setup callback.
 */
 function isUseEffectSetupCallback(node) {
 	if (node == null) return false;
@@ -1243,8 +1369,9 @@ function isUseEffectSetupCallback(node) {
 	return expr.parent?.type === AST_NODE_TYPES.CallExpression && expr.parent.arguments.at(0) === expr && isUseEffectLikeCall(expr.parent);
 }
 /**
-* Determine if a node is the cleanup function returned by a useEffect-like hook's setup function.
+* Check if the node is the cleanup callback returned by a useEffect-like setup callback.
 * @param node The AST node to check.
+* @returns `true` if the node is a useEffect cleanup callback.
 */
 function isUseEffectCleanupCallback(node) {
 	if (node == null) return false;
@@ -1520,50 +1647,109 @@ function isFlagSetOnObject(obj, flag) {
 	return isFlagSet(obj.flags, flag);
 }
 const isTypeFlagSet = isFlagSetOnObject;
+/**
+* Check if the type is a boolean literal type.
+* @param type The type to check.
+* @returns `true` if the type is a boolean literal type.
+*/
 function isBooleanLiteralType(type) {
 	return isTypeFlagSet(type, ts.TypeFlags.BooleanLiteral);
 }
-/** @internal */
+/**
+* Check if the type is the `false` literal type.
+* @internal
+*/
 const isFalseLiteralType = (type) => isBooleanLiteralType(type) && type.intrinsicName === "false";
-/** @internal */
+/**
+* Check if the type is the `true` literal type.
+* @internal
+*/
 const isTrueLiteralType = (type) => isBooleanLiteralType(type) && type.intrinsicName === "true";
-/** @internal */
+/**
+* Check if the type is an any-like type.
+* @internal
+*/
 const isAnyType = (type) => isTypeFlagSet(type, ts.TypeFlags.TypeParameter | ts.TypeFlags.Any);
-/** @internal */
+/**
+* Check if the type is a bigint-like type.
+* @internal
+*/
 const isBigIntType = (type) => isTypeFlagSet(type, ts.TypeFlags.BigIntLike);
-/** @internal */
+/**
+* Check if the type is a boolean-like type.
+* @internal
+*/
 const isBooleanType = (type) => isTypeFlagSet(type, ts.TypeFlags.BooleanLike);
-/** @internal */
+/**
+* Check if the type is an enum-like type.
+* @internal
+*/
 const isEnumType = (type) => isTypeFlagSet(type, ts.TypeFlags.EnumLike);
-/** @internal */
+/**
+* Check if the type is a falsy bigint literal type.
+* @internal
+*/
 const isFalsyBigIntType = (type) => type.isLiteral() && isMatching({ value: { base10Value: "0" } }, type);
-/** @internal */
+/**
+* Check if the type is a falsy number literal type.
+* @internal
+*/
 const isFalsyNumberType = (type) => type.isNumberLiteral() && type.value === 0;
-/** @internal */
+/**
+* Check if the type is a falsy string literal type.
+* @internal
+*/
 const isFalsyStringType = (type) => type.isStringLiteral() && type.value === "";
-/** @internal */
+/**
+* Check if the type is the never type.
+* @internal
+*/
 const isNeverType = (type) => isTypeFlagSet(type, ts.TypeFlags.Never);
-/** @internal */
+/**
+* Check if the type is a nullish type (null, undefined, or void).
+* @internal
+*/
 const isNullishType = (type) => isTypeFlagSet(type, ts.TypeFlags.Null | ts.TypeFlags.Undefined | ts.TypeFlags.VoidLike);
-/** @internal */
+/**
+* Check if the type is a number-like type.
+* @internal
+*/
 const isNumberType = (type) => isTypeFlagSet(type, ts.TypeFlags.NumberLike);
-/** @internal */
+/**
+* Check if the type is an object type.
+* @internal
+*/
 const isObjectType = (type) => !isTypeFlagSet(type, ts.TypeFlags.Null | ts.TypeFlags.Undefined | ts.TypeFlags.VoidLike | ts.TypeFlags.BooleanLike | ts.TypeFlags.StringLike | ts.TypeFlags.NumberLike | ts.TypeFlags.BigIntLike | ts.TypeFlags.TypeParameter | ts.TypeFlags.Any | ts.TypeFlags.Unknown | ts.TypeFlags.Never);
-/** @internal */
+/**
+* Check if the type is a string-like type.
+* @internal
+*/
 const isStringType = (type) => isTypeFlagSet(type, ts.TypeFlags.StringLike);
-/** @internal */
+/**
+* Check if the type is a truthy bigint literal type.
+* @internal
+*/
 const isTruthyBigIntType = (type) => type.isLiteral() && isMatching({ value: { base10Value: P.not("0") } }, type);
-/** @internal */
+/**
+* Check if the type is a truthy number literal type.
+* @internal
+*/
 const isTruthyNumberType = (type) => type.isNumberLiteral() && type.value !== 0;
-/** @internal */
+/**
+* Check if the type is a truthy string literal type.
+* @internal
+*/
 const isTruthyStringType = (type) => type.isStringLiteral() && type.value !== "";
-/** @internal */
+/**
+* Check if the type is the unknown type.
+* @internal
+*/
 const isUnknownType = (type) => isTypeFlagSet(type, ts.TypeFlags.Unknown);
 
 //#endregion
 //#region src/type-name.ts
 /**
-* An enhanced version of getFullyQualifiedName that handles cases that original function does not handle.
+* Get the fully qualified name of a symbol, handling cases that `ts.TypeChecker.getFullyQualifiedName` does not handle (ex: `export as namespace preact`).
 * @param checker The TypeScript type checker.
 * @param symbol The symbol to get fully qualified name for.
 * @returns The fully qualified name of the symbol.
@@ -1616,10 +1802,10 @@ function getFullyQualifiedNameEx(checker, symbol) {
 //#endregion
 //#region src/type-variant.ts
 /**
-* Ported from https://github.com/typescript-eslint/typescript-eslint/blob/eb736bbfc22554694400e6a4f97051d845d32e0b/packages/eslint-plugin/src/rules/strict-boolean-expressions.ts#L826 with some enhancements.
 * Get the variants of an array of types.
 * @param types The types to get the variants of.
 * @returns The variants of the types.
+* @remarks Ported from https://github.com/typescript-eslint/typescript-eslint/blob/eb736bbfc22554694400e6a4f97051d845d32e0b/packages/eslint-plugin/src/rules/strict-boolean-expressions.ts#L826 with some enhancements.
 * @internal
 */
 function getTypeVariants(types) {
@@ -1658,4 +1844,4 @@ function getTypeVariants(types) {
 }
 
 //#endregion
-export { DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, FunctionComponentDetectionHint, FunctionComponentFlag, JsxDetectionHint, REACT_BUILTIN_HOOK_NAMES, SEL_FUNCTION_DISPLAY_NAME_ASSIGNMENT, getClassComponentCollector, getClassId, getFullyQualifiedNameEx, getFunctionComponentCollector, getFunctionComponentFlagFromInitPath, getFunctionComponentId, getFunctionDirectives, getFunctionId, getFunctionInitPath, getHookCollector, getJsxConfig, getJsxConfigFromAnnotation, getJsxConfigFromCompilerOptions, getTypeVariants, isAPI, isAPICall, isAnyType, isAssignmentToThisState, isBigIntType, isBooleanLiteralType, isBooleanType, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDidCatch, isComponentDidMount, isComponentDidUpdate, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUpdate, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isEnumType, isFalseLiteralType, isFalsyBigIntType, isFalsyNumberType, isFalsyStringType, isForwardRef, isForwardRefCall, isFunctionComponentDefinition, isFunctionComponentName, isFunctionComponentNameLoose, isFunctionComponentWrapperCall, isFunctionComponentWrapperCallback, isFunctionEmpty, isFunctionHasCallInInitPath, isFunctionHasDirective, isFunctionWithLooseComponentName, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHookCall, isHookDefinition, isHookId, isHookName, isHookTag, isJsxLike, isLazy, isLazyCall, isMemo, isMemoCall, isNeverType, isNullishType, isNumberType, isObjectType, isPureComponent, isRender, isRenderMethodCallback, isRenderMethodLike, isShouldComponentUpdate, isStringType, isThisSetStateCall, isTrueLiteralType, isTruthyBigIntType, isTruthyNumberType, isTruthyStringType, isUnknownType, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUse, isUseActionState, isUseActionStateCall, isUseCall, isUseCallback, isUseCallbackCall, isUseContext, isUseContextCall, isUseDebugValue, isUseDebugValueCall, isUseDeferredValue, isUseDeferredValueCall, isUseEffect, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatus, isUseFormStatusCall, isUseId, isUseIdCall, isUseImperativeHandle, isUseImperativeHandleCall, isUseInsertionEffect, isUseInsertionEffectCall, isUseLayoutEffect, isUseLayoutEffectCall, isUseMemo, isUseMemoCall, isUseOptimistic, isUseOptimisticCall, isUseReducer, isUseReducerCall, isUseRef, isUseRefCall, isUseState, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStore, isUseSyncExternalStoreCall, isUseTransition, isUseTransitionCall };
+export { DEFAULT_COMPONENT_DETECTION_HINT, DEFAULT_JSX_DETECTION_HINT, FunctionComponentDetectionHint, FunctionComponentFlag, JsxDetectionHint, REACT_BUILTIN_HOOK_NAMES, SEL_FUNCTION_DISPLAY_NAME_ASSIGNMENT, getClassComponentCollector, getClassId, getFullyQualifiedNameEx, getFunctionComponentCollector, getFunctionComponentFlagFromInitPath, getFunctionComponentId, getFunctionDirectives, getFunctionId, getFunctionInitPath, getHookCollector, getJsxConfig, getJsxConfigFromAnnotation, getJsxConfigFromCompilerOptions, getTypeVariants, isAPI, isAPICall, isAnyType, isAssignmentToThisState, isBigIntType, isBooleanLiteralType, isBooleanType, isCaptureOwnerStack, isCaptureOwnerStackCall, isChildrenCount, isChildrenCountCall, isChildrenForEach, isChildrenForEachCall, isChildrenMap, isChildrenMapCall, isChildrenOnly, isChildrenOnlyCall, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElement, isCloneElementCall, isComponentDidCatch, isComponentDidMount, isComponentDidUpdate, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUnmount, isComponentWillUpdate, isCreateContext, isCreateContextCall, isCreateElement, isCreateElementCall, isCreateRef, isCreateRefCall, isEnumType, isFalseLiteralType, isFalsyBigIntType, isFalsyNumberType, isFalsyStringType, isForwardRef, isForwardRefCall, isFunctionComponentDefinition, isFunctionComponentName, isFunctionComponentNameLoose, isFunctionComponentWrapperCall, isFunctionComponentWrapperCallback, isFunctionEmpty, isFunctionHasCallInInitPath, isFunctionHasDirective, isFunctionWithLooseComponentName, isGetChildContext, isGetDefaultProps, isGetDerivedStateFromError, isGetDerivedStateFromProps, isGetInitialState, isGetSnapshotBeforeUpdate, isHookCall, isHookDefinition, isHookId, isHookName, isHookTag, isJsxLike, isLazy, isLazyCall, isMemo, isMemoCall, isNeverType, isNullishType, isNumberType, isObjectType, isPureComponent, isRender, isRenderMethodCallback, isRenderMethodLike, isShouldComponentUpdate, isStringType, isThisSetStateCall, isTrueLiteralType, isTruthyBigIntType, isTruthyNumberType, isTruthyStringType, isUnknownType, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUse, isUseActionState, isUseActionStateCall, isUseCall, isUseCallback, isUseCallbackCall, isUseContext, isUseContextCall, isUseDebugValue, isUseDebugValueCall, isUseDeferredValue, isUseDeferredValueCall, isUseEffect, isUseEffectCall, isUseEffectCleanupCallback, isUseEffectLikeCall, isUseEffectSetupCallback, isUseFormStatus, isUseFormStatusCall, isUseId, isUseIdCall, isUseImperativeHandle, isUseImperativeHandleCall, isUseInsertionEffect, isUseInsertionEffectCall, isUseLayoutEffect, isUseLayoutEffectCall, isUseMemo, isUseMemoCall, isUseOptimistic, isUseOptimisticCall, isUseReducer, isUseReducerCall, isUseRef, isUseRefCall, isUseRefLikeCall, isUseState, isUseStateCall, isUseStateLikeCall, isUseSyncExternalStore, isUseSyncExternalStoreCall, isUseTransition, isUseTransitionCall };