@eslint-react/core 2.3.13-next.2 → 2.3.13-next.4

package/dist/index.d.ts

@@ -291,7 +291,17 @@ 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
@@ -492,16 +502,24 @@ 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
 /**
- * Get a function to find JSX attributes by name, considering direct attributes and spread attributes.
+ * Creates a helper function to find a specific JSX attribute by name
+ * Handles direct attributes and spread attributes (variables or object literals)
  * @param context The ESLint rule context
  * @param node The JSX element node
- * @param initialScope Optional initial scope for variable resolution
- * @returns A function that takes an attribute name and returns the corresponding JSX attribute node or undefined
+ * @param initialScope (Optional) The initial scope to use for variable resolution
  */
 declare function getJsxAttribute(context: RuleContext, node: TSESTree.JSXElement, initialScope?: Scope): (name: string) => TSESTree.JSXAttribute | TSESTree.JSXSpreadAttribute | undefined;
 //#endregion
@@ -542,6 +560,13 @@ type JsxAttributeValue = {
   node: TSESTree.JSXSpreadChild["expression"];
   toStatic(): unknown;
 };
+/**
+ * Resolves the static value of a JSX attribute or spread attribute
+ *
+ * @param context - The ESLint rule context
+ * @param attribute - The JSX attribute node to resolve
+ * @returns An object containing the value kind, the node (if applicable), and a `toStatic` helper
+ */
 declare function resolveJsxAttributeValue(context: RuleContext, attribute: AST.TSESTreeJSXAttributeLike): {
   readonly kind: "boolean";
   readonly toStatic: () => true;
@@ -584,9 +609,9 @@ interface JsxConfig {
   jsxImportSource?: string;
 }
 /**
- * Get JsxConfig from the rule context by reading compiler options.
- * @param context The RuleContext.
- * @returns JsxConfig derived from compiler options.
+ * Get JsxConfig from the rule context by reading compiler options
+ * @param context The RuleContext
+ * @returns JsxConfig derived from compiler options
  */
 declare function getJsxConfigFromContext(context: RuleContext): {
   jsx: 4 | typescript0.JsxEmit;
@@ -595,9 +620,9 @@ declare function getJsxConfigFromContext(context: RuleContext): {
   jsxImportSource: string;
 };
 /**
- * Get JsxConfig from pragma comments (annotations) in the source code.
- * @param context The RuleContext.
- * @returns JsxConfig derived from pragma comments.
+ * Get JsxConfig from pragma comments (annotations) in the source code
+ * @param context The RuleContext
+ * @returns JsxConfig derived from pragma comments
  */
 declare function getJsxConfigFromAnnotation(context: RuleContext): JsxConfig;
 //#endregion

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));
@@ -245,19 +253,18 @@ function getJsxAttributeName(context, node) {
 //#endregion
 //#region src/jsx/jsx-attribute.ts
 /**
-* Get a function to find JSX attributes by name, considering direct attributes and spread attributes.
+* Creates a helper function to find a specific JSX attribute by name
+* Handles direct attributes and spread attributes (variables or object literals)
 * @param context The ESLint rule context
 * @param node The JSX element node
-* @param initialScope Optional initial scope for variable resolution
-* @returns A function that takes an attribute name and returns the corresponding JSX attribute node or undefined
+* @param initialScope (Optional) The initial scope to use for variable resolution
 */
 function getJsxAttribute(context, node, initialScope) {
 	const scope = initialScope ?? context.sourceCode.getScope(node);
 	const attributes = node.openingElement.attributes;
 	/**
-	* Find a JSX attribute by name, considering both direct attributes and spread attributes.
-	* @param name The name of the attribute to find
-	* @returns The JSX attribute node if found, otherwise undefined
+	* Finds the last occurrence of a specific attribute
+	* @param name The attribute name to search for
 	*/
 	return (name) => {
 		return attributes.findLast((attr) => {
@@ -277,8 +284,19 @@ function getJsxAttribute(context, node, initialScope) {
 
 //#endregion
 //#region src/jsx/jsx-attribute-value.ts
+/**
+* Resolves the static value of a JSX attribute or spread attribute
+*
+* @param context - The ESLint rule context
+* @param attribute - The JSX attribute node to resolve
+* @returns An object containing the value kind, the node (if applicable), and a `toStatic` helper
+*/
 function resolveJsxAttributeValue(context, attribute) {
 	const initialScope = context.sourceCode.getScope(attribute);
+	/**
+	* Handles standard JSX attributes (e.g., prop="value", prop={value}, prop)
+	* @param node The JSX attribute node
+	*/
 	function handleJsxAttribute(node) {
 		if (node.value == null) return {
 			kind: "boolean",
@@ -323,6 +341,10 @@ function resolveJsxAttributeValue(context, attribute) {
 			};
 		}
 	}
+	/**
+	* Handles JSX spread attributes (e.g., {...props})
+	* @param node The JSX spread attribute node
+	*/
 	function handleJsxSpreadAttribute(node) {
 		return {
 			kind: "spreadProps",
@@ -350,9 +372,9 @@ const JsxEmit = {
 	ReactJSXDev: 5
 };
 /**
-* Get JsxConfig from the rule context by reading compiler options.
-* @param context The RuleContext.
-* @returns JsxConfig derived from compiler options.
+* Get JsxConfig from the rule context by reading compiler options
+* @param context The RuleContext
+* @returns JsxConfig derived from compiler options
 */
 function getJsxConfigFromContext(context) {
 	const options = context.sourceCode.parserServices?.program?.getCompilerOptions() ?? {};
@@ -365,9 +387,9 @@ function getJsxConfigFromContext(context) {
 }
 const cache = /* @__PURE__ */ new WeakMap();
 /**
-* Get JsxConfig from pragma comments (annotations) in the source code.
-* @param context The RuleContext.
-* @returns JsxConfig derived from pragma comments.
+* Get JsxConfig from pragma comments (annotations) in the source code
+* @param context The RuleContext
+* @returns JsxConfig derived from pragma comments
 */
 function getJsxConfigFromAnnotation(context) {
 	return getOrElseUpdate(cache, context.sourceCode, () => {
@@ -1134,9 +1156,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.2",
+  "version": "2.3.13-next.4",
   "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.2",
-    "@eslint-react/shared": "2.3.13-next.2",
-    "@eslint-react/var": "2.3.13-next.2",
-    "@eslint-react/eff": "2.3.13-next.2"
+    "@eslint-react/ast": "2.3.13-next.4",
+    "@eslint-react/shared": "2.3.13-next.4",
+    "@eslint-react/eff": "2.3.13-next.4",
+    "@eslint-react/var": "2.3.13-next.4"
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",