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

package/dist/index.d.ts

@@ -127,25 +127,48 @@ declare const ComponentDetectionHint: {
 declare const DEFAULT_COMPONENT_DETECTION_HINT: bigint;
 //#endregion
 //#region src/semantic/semantic-node.d.ts
+/**
+ * Represents a semantic node in the AST
+ * This is the base interface for all semantic nodes in the React semantic analysis
+ */
 interface SemanticNode {
+  /** The identifier of the node */
   id: unit | TSESTree.Node;
+  /** The unique key of the node */
   key: string;
+  /** The kind of the node */
   kind: string;
+  /** The name of the node */
   name: unit | string;
+  /** The AST node */
   node: TSESTree.Node;
+  /** The flag of the node */
   flag: bigint;
+  /** The hint of the node */
   hint: bigint;
 }
 //#endregion
 //#region src/semantic/semantic-func.d.ts
+/**
+ * Represents a semantic function node in the AST
+ * This interface extends SemanticNode and provides additional properties for function analysis
+ */
 interface SemanticFunc extends SemanticNode {
+  /** The identifier of the function */
   id: ast.FunctionID | unit;
+  /** The AST node of the function */
   node: ast.TSESTreeFunction;
+  /** The name of the function */
   name: string | unit;
+  /** The return type annotation of the function */
   type: TSESTree.TSTypeAnnotation | unit;
+  /** The body of the function */
   body: TSESTree.BlockStatement | TSESTree.Expression;
+  /** The directives of the function (e.g., "use strict", "use client", "use server", etc.) */
   directives: TSESTree.StringLiteral[];
+  /** The parameters of the function */
   parameters: TSESTree.Parameter[];
+  /** The type parameters of the function */
   typeParameters: TSESTree.TSTypeParameterDeclaration | unit;
 }
 //#endregion
@@ -538,7 +561,7 @@ type FindEnclosingComponentOrHookFilter = (n: TSESTree.Node, name: string | null
  * @param test Optional test function to customize component or hook identification
  * @returns The enclosing component or hook node, or `null` if none is ASAST.
  */
-declare function findEnclosingComponentOrHook(node: TSESTree.Node | unit, test?: FindEnclosingComponentOrHookFilter): TSESTree.ArrowFunctionExpression | TSESTree.FunctionDeclarationWithName | TSESTree.FunctionDeclarationWithOptionalName | TSESTree.FunctionExpression | undefined;
+declare function findEnclosingComponentOrHook(node: TSESTree.Node | unit, test?: FindEnclosingComponentOrHookFilter): TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression | TSESTree.FunctionDeclarationWithName | TSESTree.FunctionDeclarationWithOptionalName | undefined;
 //#endregion
 //#region src/hierarchy/is-inside-component-or-hook.d.ts
 /**
@@ -561,14 +584,20 @@ declare function isUseEffectSetupCallback(node: TSESTree.Node | unit): boolean;
 declare function isUseEffectCleanupCallback(node: TSESTree.Node | unit): boolean;
 //#endregion
 //#region src/hook/hook-semantic-node.d.ts
+/**
+ * Represents a semantic hook node in the AST
+ * This interface extends SemanticNode and provides additional properties for React hook analysis
+ */
 interface HookSemanticNode extends SemanticNode {
+  /** The identifier of the hook */
   id: ast.FunctionID | unit;
+  /** The AST node of the hook */
   node: ast.TSESTreeFunction;
+  /** The name of the hook */
   name: string;
+  /** The other hooks called by the hook */
   hookCalls: TSESTree.CallExpression[];
-  /**
-   * The directives used in the function (e.g., "use strict", "use client", etc.)
-   */
+  /** The directives used in the function (e.g., "use strict", "use client", etc.) */
   directives: TSESTree.StringLiteral[];
 }
 //#endregion
@@ -595,6 +624,11 @@ declare namespace useHookCollector {
 declare function useHookCollector(context: RuleContext): useHookCollector.ReturnType;
 //#endregion
 //#region src/hook/hook-id.d.ts
+/**
+ * Checks if the given node is a hook identifier
+ * @param id The AST node to check
+ * @returns `true` if the node is a hook identifier or member expression with hook name, `false` otherwise
+ */
 declare function isHookId(id: TSESTree.Node): id is TSESTree.Identifier | TSESTree.MemberExpression;
 //#endregion
 //#region src/hook/hook-is.d.ts
@@ -725,7 +759,7 @@ declare function resolveJsxAttributeValue(context: RuleContext, attribute: ast.T
   readonly toStatic: () => string | number | bigint | boolean | RegExp | null;
 } | {
   readonly kind: "expression";
-  readonly node: TSESTree.JSXEmptyExpression | TSESTree.Expression;
+  readonly node: TSESTree.Expression | TSESTree.JSXEmptyExpression;
   readonly toStatic: () => unknown;
 } | {
   readonly kind: "element";
@@ -733,7 +767,7 @@ declare function resolveJsxAttributeValue(context: RuleContext, attribute: ast.T
   readonly toStatic: () => undefined;
 } | {
   readonly kind: "spreadChild";
-  readonly node: TSESTree.JSXEmptyExpression | TSESTree.Expression;
+  readonly node: TSESTree.Expression | TSESTree.JSXEmptyExpression;
   readonly toStatic: () => undefined;
 } | {
   readonly kind: "spreadProps";

package/dist/index.js

@@ -245,6 +245,11 @@ function isUseEffectCleanupCallback(node) {
 
 //#endregion
 //#region src/hook/hook-id.ts
+/**
+* Checks if the given node is a hook identifier
+* @param id The AST node to check
+* @returns `true` if the node is a hook identifier or member expression with hook name, `false` otherwise
+*/
 function isHookId(id) {
 	switch (id.type) {
 		case AST_NODE_TYPES.Identifier: return isHookName(id.name);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "2.8.2-next.1",
+  "version": "2.8.2-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": {
@@ -34,10 +34,10 @@
     "@typescript-eslint/types": "^8.54.0",
     "@typescript-eslint/utils": "^8.54.0",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "2.8.2-next.1",
-    "@eslint-react/eff": "2.8.2-next.1",
-    "@eslint-react/shared": "2.8.2-next.1",
-    "@eslint-react/var": "2.8.2-next.1"
+    "@eslint-react/ast": "2.8.2-next.3",
+    "@eslint-react/eff": "2.8.2-next.3",
+    "@eslint-react/shared": "2.8.2-next.3",
+    "@eslint-react/var": "2.8.2-next.3"
   },
   "devDependencies": {
     "tsdown": "^0.20.1",