@eslint-react/core 2.3.13-next.1 → 2.3.13-next.3

package/dist/index.d.ts

@@ -220,13 +220,15 @@ declare namespace useComponentCollectorLegacy {
 declare function useComponentCollectorLegacy(): useComponentCollectorLegacy.ReturnType;
 /**
  * Check whether the given node is a this.setState() call
- * @param node - The node to check
+ * @param node The node to check
+ * @param node
  * @internal
  */
 declare function isThisSetState(node: TSESTree$1.CallExpression): boolean;
 /**
  * Check whether the given node is an assignment to this.state
- * @param node - The node to check
+ * @param node The node to check
+ * @param node
  * @internal
  */
 declare function isAssignmentToThisState(node: TSESTree$1.AssignmentExpression): boolean;
@@ -235,9 +237,12 @@ declare function isAssignmentToThisState(node: TSESTree$1.AssignmentExpression):
 /**
  * Determines if a function node represents a valid React component definition
  *
- * @param context - The rule context
- * @param node - The function node to analyze
- * @param hint - Component detection hints (bit flags) to customize detection logic
+ * @param context The rule context
+ * @param node The function node to analyze
+ * @param hint Component detection hints (bit flags) to customize detection logic
+ * @param context
+ * @param node
+ * @param hint
  * @returns `true` if the node is considered a component definition
  */
 declare function isComponentDefinition(context: RuleContext, node: AST.TSESTreeFunction, hint: bigint): boolean;
@@ -286,29 +291,39 @@ declare const isGetDerivedStateFromProps: (node: TSESTree.Node) => node is AST.T
 declare const isGetDerivedStateFromError: (node: TSESTree.Node) => node is AST.TSESTreeMethodOrProperty;
 //#endregion
 //#region src/component/component-method-parts.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`
+ */
 declare function isFunctionOfComponentDidMount(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`
+ */
 declare function isFunctionOfComponentWillUnmount(node: TSESTree.Node): boolean;
 //#endregion
 //#region src/component/component-name.d.ts
 /**
  * Check if a string matches the strict component name pattern
- * @param name - The name to check
+ * @param name The name to check
  */
 declare function isComponentName(name: string): boolean;
 /**
  * Check if a string matches the loose component name pattern
- * @param name - The name to check
+ * @param name The name to check
  */
 declare function isComponentNameLoose(name: string): boolean;
 /**
  * Get component name from an identifier or identifier sequence (e.g., MemberExpression)
- * @param id - The identifier or identifier sequence
+ * @param id The identifier or identifier sequence
  */
 declare function getComponentNameFromId(id: TSESTree.Identifier | TSESTree.Identifier[] | unit): string | undefined;
 /**
  * Check if the function has no name or a loose component name
- * @param context - The rule context
- * @param fn - The function node
+ * @param context The rule context
+ * @param fn The function node
  */
 declare function hasNoneOrLooseComponentName(context: RuleContext, fn: AST.TSESTreeFunction): boolean;
 //#endregion
@@ -487,7 +502,15 @@ declare const REACT_BUILTIN_HOOK_NAMES: readonly ["use", "useActionState", "useC
 declare function isReactHookName(name: string): boolean;
 //#endregion
 //#region src/hook/hook-parts.d.ts
+/**
+ * Determines if a node is the setup function passed to a useEffect-like hook
+ * @param node The AST node to check
+ */
 declare function isFunctionOfUseEffectSetup(node: TSESTree.Node | unit): boolean;
+/**
+ * Determines 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 isFunctionOfUseEffectCleanup(node: TSESTree.Node | unit): boolean;
 //#endregion
 //#region src/jsx/jsx-attribute.d.ts
@@ -547,7 +570,7 @@ declare function resolveJsxAttributeValue(context: RuleContext, attribute: AST.T
   readonly toStatic: () => string | number | bigint | boolean | RegExp | null;
 } | {
   readonly kind: "expression";
-  readonly node: TSESTree.Expression | TSESTree.JSXEmptyExpression;
+  readonly node: TSESTree.JSXEmptyExpression | TSESTree.Expression;
   readonly toStatic: () => unknown;
 } | {
   readonly kind: "element";
@@ -555,7 +578,7 @@ declare function resolveJsxAttributeValue(context: RuleContext, attribute: AST.T
   readonly toStatic: () => undefined;
 } | {
   readonly kind: "spreadChild";
-  readonly node: TSESTree.Expression | TSESTree.JSXEmptyExpression;
+  readonly node: TSESTree.JSXEmptyExpression | TSESTree.Expression;
   readonly toStatic: () => undefined;
 } | {
   readonly kind: "spreadProps";
@@ -645,8 +668,8 @@ declare function isJsxLike(code: {
  * Determines 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
- * @param node - AST node to check
+ * @param context ESLint rule context
+ * @param node AST node to check
  * @returns boolean indicating if the element is a host element
  */
 declare function isJsxHostElement(context: RuleContext, node: TSESTree.Node): boolean;
@@ -654,8 +677,8 @@ declare function isJsxHostElement(context: RuleContext, node: TSESTree.Node): bo
  * Determines 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
- * @param node - AST node to check
+ * @param context ESLint rule context
+ * @param node AST node to check
  * @returns boolean indicating if the element is a Fragment with type narrowing
  */
 declare function isJsxFragmentElement(context: RuleContext, node: TSESTree.Node): node is TSESTree.JSXElement;
@@ -666,8 +689,8 @@ declare function isJsxFragmentElement(context: RuleContext, node: TSESTree.Node)
  * For JSX elements, returns the stringified name (e.g., "div", "Button", "React.Fragment")
  * For JSX fragments, returns an empty string
  *
- * @param context - ESLint rule context
- * @param node - JSX element or fragment node
+ * @param context ESLint rule context
+ * @param node JSX element or fragment node
  * @returns String representation of the element type
  */
 declare function getJsxElementType(context: RuleContext, node: TSESTree.JSXElement | TSESTree.JSXFragment): string;
@@ -676,8 +699,8 @@ declare function getJsxElementType(context: RuleContext, node: TSESTree.JSXEleme
 /**
  * Traverses up the AST to find a parent JSX attribute node that matches a given test
  *
- * @param node - The starting AST node
- * @param test - Optional predicate function to test if the attribute meets criteria
+ * @param node The starting AST node
+ * @param test Optional predicate function to test if the attribute meets criteria
  *               Defaults to always returning true (matches any attribute)
  * @returns The first matching JSX attribute node found when traversing upwards, or undefined
  */
@@ -687,7 +710,7 @@ declare function findParentJsxAttribute(node: TSESTree.Node, test?: (node: TSEST
 /**
  * Incomplete but sufficient stringification of JSX nodes for common use cases
  *
- * @param node - JSX node from TypeScript ESTree
+ * @param node JSX node from TypeScript ESTree
  * @returns String representation of the JSX node
  */
 declare function stringifyJsx(node: TSESTree$1.JSXIdentifier | TSESTree$1.JSXNamespacedName | TSESTree$1.JSXMemberExpression | TSESTree$1.JSXOpeningElement | TSESTree$1.JSXClosingElement | TSESTree$1.JSXOpeningFragment | TSESTree$1.JSXClosingFragment | TSESTree$1.JSXText): string;
@@ -700,7 +723,7 @@ declare function stringifyJsx(node: TSESTree$1.JSXIdentifier | TSESTree$1.JSXNam
  * @param prev The previous AST node in the traversal (used for context)
  * @internal
  */
-declare function getInstanceId(node: TSESTree.Node, prev?: TSESTree.Node): TSESTree.JSXElement | TSESTree.ArrayExpression | TSESTree.ArrayPattern | TSESTree.ArrowFunctionExpression | TSESTree.AssignmentExpression | TSESTree.AwaitExpression | TSESTree.PrivateInExpression | TSESTree.SymmetricBinaryExpression | TSESTree.CallExpression | TSESTree.ChainExpression | TSESTree.ClassExpression | TSESTree.ConditionalExpression | TSESTree.FunctionExpression | TSESTree.Identifier | TSESTree.ImportExpression | TSESTree.JSXFragment | TSESTree.BigIntLiteral | TSESTree.BooleanLiteral | TSESTree.NullLiteral | TSESTree.NumberLiteral | TSESTree.RegExpLiteral | TSESTree.StringLiteral | TSESTree.TemplateLiteral | TSESTree.LogicalExpression | TSESTree.MemberExpressionComputedName | TSESTree.MemberExpressionNonComputedName | TSESTree.MetaProperty | TSESTree.NewExpression | TSESTree.ObjectExpression | TSESTree.ObjectPattern | TSESTree.SequenceExpression | TSESTree.Super | TSESTree.TaggedTemplateExpression | TSESTree.ThisExpression | TSESTree.TSAsExpression | TSESTree.TSInstantiationExpression | TSESTree.TSNonNullExpression | TSESTree.TSSatisfiesExpression | TSESTree.TSTypeAssertion | TSESTree.UnaryExpressionBitwiseNot | TSESTree.UnaryExpressionDelete | TSESTree.UnaryExpressionMinus | TSESTree.UnaryExpressionNot | TSESTree.UnaryExpressionPlus | TSESTree.UnaryExpressionTypeof | TSESTree.UnaryExpressionVoid | TSESTree.UpdateExpression | TSESTree.YieldExpression | TSESTree.PrivateIdentifier | undefined;
+declare function getInstanceId(node: TSESTree.Node, prev?: TSESTree.Node): TSESTree.ArrayExpression | TSESTree.ArrayPattern | TSESTree.ArrowFunctionExpression | TSESTree.AssignmentExpression | TSESTree.AwaitExpression | TSESTree.PrivateInExpression | TSESTree.SymmetricBinaryExpression | TSESTree.CallExpression | TSESTree.ChainExpression | TSESTree.ClassExpression | TSESTree.ConditionalExpression | TSESTree.FunctionExpression | TSESTree.Identifier | TSESTree.ImportExpression | TSESTree.JSXElement | TSESTree.JSXFragment | TSESTree.BigIntLiteral | TSESTree.BooleanLiteral | TSESTree.NullLiteral | TSESTree.NumberLiteral | TSESTree.RegExpLiteral | TSESTree.StringLiteral | TSESTree.LogicalExpression | TSESTree.MemberExpressionComputedName | TSESTree.MemberExpressionNonComputedName | TSESTree.MetaProperty | TSESTree.NewExpression | TSESTree.ObjectExpression | TSESTree.ObjectPattern | TSESTree.PrivateIdentifier | TSESTree.SequenceExpression | TSESTree.Super | TSESTree.TaggedTemplateExpression | TSESTree.TemplateLiteral | TSESTree.ThisExpression | TSESTree.TSAsExpression | TSESTree.TSInstantiationExpression | TSESTree.TSNonNullExpression | TSESTree.TSSatisfiesExpression | TSESTree.TSTypeAssertion | TSESTree.UnaryExpressionBitwiseNot | TSESTree.UnaryExpressionDelete | TSESTree.UnaryExpressionMinus | TSESTree.UnaryExpressionNot | TSESTree.UnaryExpressionPlus | TSESTree.UnaryExpressionTypeof | TSESTree.UnaryExpressionVoid | TSESTree.UpdateExpression | TSESTree.YieldExpression | undefined;
 //#endregion
 //#region src/utils/is-from-react.d.ts
 /**
@@ -734,6 +757,11 @@ declare namespace isReactAPI {
     (context: RuleContext): (node: unit | null | TSESTree.Node) => node is TSESTree.MemberExpression | TSESTree.Identifier;
   };
 }
+/**
+ * Checks 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
+ */
 declare function isReactAPI(api: string): isReactAPI.ReturnType;
 declare namespace isReactAPICall {
   type ReturnType = {
@@ -741,6 +769,11 @@ declare namespace isReactAPICall {
     (context: RuleContext): (node: unit | null | TSESTree.Node) => node is TSESTree.CallExpression;
   };
 }
+/**
+ * Checks 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
+ */
 declare function isReactAPICall(api: string): isReactAPICall.ReturnType;
 declare const isCaptureOwnerStack: isReactAPI.ReturnType;
 declare const isChildrenCount: isReactAPI.ReturnType;

package/dist/index.js

@@ -197,10 +197,18 @@ function isReactHookId(id) {
 
 //#endregion
 //#region src/hook/hook-parts.ts
+/**
+* Determines if a node is the setup function passed to a useEffect-like hook
+* @param node The AST node to check
+*/
 function isFunctionOfUseEffectSetup(node) {
 	if (node == null) return false;
 	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.
+* @param node The AST node to check
+*/
 function isFunctionOfUseEffectCleanup(node) {
 	if (node == null) return false;
 	const pReturn = AST.findParentNode(node, AST.is(AST_NODE_TYPES.ReturnStatement));
@@ -214,7 +222,7 @@ function isFunctionOfUseEffectCleanup(node) {
 /**
 * Incomplete but sufficient stringification of JSX nodes for common use cases
 *
-* @param node - JSX node from TypeScript ESTree
+* @param node JSX node from TypeScript ESTree
 * @returns String representation of the JSX node
 */
 function stringifyJsx(node) {
@@ -492,8 +500,8 @@ function isJsxLike(code, node, hint = DEFAULT_JSX_DETECTION_HINT) {
 * For JSX elements, returns the stringified name (e.g., "div", "Button", "React.Fragment")
 * For JSX fragments, returns an empty string
 *
-* @param context - ESLint rule context
-* @param node - JSX element or fragment node
+* @param context ESLint rule context
+* @param node JSX element or fragment node
 * @returns String representation of the element type
 */
 function getJsxElementType(context, node) {
@@ -507,8 +515,8 @@ function getJsxElementType(context, node) {
 * Determines 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
-* @param node - AST node to check
+* @param context ESLint rule context
+* @param node AST node to check
 * @returns boolean indicating if the element is a host element
 */
 function isJsxHostElement(context, node) {
@@ -518,8 +526,8 @@ function isJsxHostElement(context, node) {
 * Determines 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
-* @param node - AST node to check
+* @param context ESLint rule context
+* @param node AST node to check
 * @returns boolean indicating if the element is a Fragment with type narrowing
 */
 function isJsxFragmentElement(context, node) {
@@ -532,8 +540,8 @@ function isJsxFragmentElement(context, node) {
 /**
 * Traverses up the AST to find a parent JSX attribute node that matches a given test
 *
-* @param node - The starting AST node
-* @param test - Optional predicate function to test if the attribute meets criteria
+* @param node The starting AST node
+* @param test Optional predicate function to test if the attribute meets criteria
 *               Defaults to always returning true (matches any attribute)
 * @returns The first matching JSX attribute node found when traversing upwards, or undefined
 */
@@ -629,6 +637,11 @@ function isInstanceIdEqual(context, a, b) {
 
 //#endregion
 //#region src/utils/is-react-api.ts
+/**
+* Checks 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
+*/
 function isReactAPI(api) {
 	const func = (context, node) => {
 		if (node == null) return false;
@@ -640,6 +653,11 @@ function isReactAPI(api) {
 	};
 	return dual(2, func);
 }
+/**
+* Checks 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
+*/
 function isReactAPICall(api) {
 	const func = (context, node) => {
 		if (node == null) return false;
@@ -771,7 +789,8 @@ const FUNCTION_PATTERNS = {
 /**
 * Checks if the given node is a function within a render method of a class component.
 *
-* @param node - The AST node to check
+* @param node The AST node to check
+* @param node
 * @returns `true` if the node is a render function inside a class component
 *
 * @example
@@ -789,8 +808,10 @@ function isFunctionOfRenderMethod(node) {
 /**
 * Checks 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
+* @param node The function node to check
+* @param hint Component detection hints as bit flags
+* @param node
+* @param hint
 * @returns `true` if the function matches an exclusion hint
 */
 function shouldExcludeBasedOnHint(node, hint) {
@@ -803,8 +824,10 @@ function shouldExcludeBasedOnHint(node, hint) {
 /**
 * Determines 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
+* @param context The rule context
+* @param node The AST node to check
+* @param context
+* @param node
 * @returns `true` if the node is passed as a child to `createElement`
 */
 function isChildrenOfCreateElement(context, node) {
@@ -816,9 +839,12 @@ function isChildrenOfCreateElement(context, node) {
 /**
 * Determines if a function node represents a valid React component definition
 *
-* @param context - The rule context
-* @param node - The function node to analyze
-* @param hint - Component detection hints (bit flags) to customize detection logic
+* @param context The rule context
+* @param node The function node to analyze
+* @param hint Component detection hints (bit flags) to customize detection logic
+* @param context
+* @param node
+* @param hint
 * @returns `true` if the node is considered a component definition
 */
 function isComponentDefinition(context, node, hint) {
@@ -892,21 +918,21 @@ function getComponentFlagFromInitPath(initPath) {
 //#region src/component/component-name.ts
 /**
 * Check if a string matches the strict component name pattern
-* @param name - The name to check
+* @param name The name to check
 */
 function isComponentName(name) {
 	return RE_COMPONENT_NAME.test(name);
 }
 /**
 * Check if a string matches the loose component name pattern
-* @param name - The name to check
+* @param name The name to check
 */
 function isComponentNameLoose(name) {
 	return RE_COMPONENT_NAME_LOOSE.test(name);
 }
 /**
 * Get component name from an identifier or identifier sequence (e.g., MemberExpression)
-* @param id - The identifier or identifier sequence
+* @param id The identifier or identifier sequence
 */
 function getComponentNameFromId(id) {
 	if (id == null) return unit;
@@ -914,8 +940,8 @@ function getComponentNameFromId(id) {
 }
 /**
 * Check if the function has no name or a loose component name
-* @param context - The rule context
-* @param fn - The function node
+* @param context The rule context
+* @param fn The function node
 */
 function hasNoneOrLooseComponentName(context, fn) {
 	const id = getFunctionComponentId(context, fn);
@@ -1064,7 +1090,8 @@ function useComponentCollectorLegacy() {
 }
 /**
 * Check whether the given node is a this.setState() call
-* @param node - The node to check
+* @param node The node to check
+* @param node
 * @internal
 */
 function isThisSetState(node) {
@@ -1073,7 +1100,8 @@ function isThisSetState(node) {
 }
 /**
 * Check whether the given node is an assignment to this.state
-* @param node - The node to check
+* @param node The node to check
+* @param node
 * @internal
 */
 function isAssignmentToThisState(node) {
@@ -1114,9 +1142,19 @@ const isGetDerivedStateFromError = createLifecycleChecker("getDerivedStateFromEr
 
 //#endregion
 //#region src/component/component-method-parts.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`
+*/
 function isFunctionOfComponentDidMount(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`
+*/
 function isFunctionOfComponentWillUnmount(node) {
 	return AST.isFunction(node) && isComponentWillUnmount(node.parent) && node.parent.value === node;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "2.3.13-next.1",
+  "version": "2.3.13-next.3",
   "description": "ESLint React's ESLint utility module for static analysis of React core APIs and patterns.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -35,10 +35,10 @@
     "@typescript-eslint/utils": "^8.48.1",
     "birecord": "^0.1.1",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "2.3.13-next.1",
-    "@eslint-react/eff": "2.3.13-next.1",
-    "@eslint-react/var": "2.3.13-next.1",
-    "@eslint-react/shared": "2.3.13-next.1"
+    "@eslint-react/ast": "2.3.13-next.3",
+    "@eslint-react/eff": "2.3.13-next.3",
+    "@eslint-react/shared": "2.3.13-next.3",
+    "@eslint-react/var": "2.3.13-next.3"
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",