docs: add JSDoc comments to core package types and functions

- Add JSDoc to isHookId() function in hook-id.ts
- Add JSDoc to SemanticNode interface and properties in semantic-node.ts
- Add JSDoc to SemanticFunc interface and properties in semantic-func.ts
- Add JSDoc to HookSemanticNode interface in hook-semantic-node.ts

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: Rel1cx

packages/core/src/hook/hook-id.ts

@@ -2,6 +2,11 @@ import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as AST } from "@typescript-eslint/types";
 import { isHookName } from "./hook-name";
 
+/**
+ * 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
+ */
 export function isHookId(id: TSESTree.Node): id is TSESTree.Identifier | TSESTree.MemberExpression {
   switch (id.type) {
     case AST.Identifier:

packages/core/src/hook/hook-semantic-node.ts

@@ -5,18 +5,20 @@ import type { TSESTree } from "@typescript-eslint/types";
 import type { SemanticNode } from "../semantic";
 
 /* eslint-disable perfectionist/sort-interfaces */
+/**
+ * Represents a semantic hook node in the AST
+ * This interface extends SemanticNode and provides additional properties for React hook analysis
+ */
 export interface HookSemanticNode extends SemanticNode {
-  // The identifier of the hook
+  /** The identifier of the hook */
   id: ast.FunctionID | unit;
-  // The AST node of the hook
+  /** The AST node of the hook */
   node: ast.TSESTreeFunction;
-  // The name of the hook
+  /** The name of the hook */
   name: string;
-  // The other hooks called by the hook
+  /** 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[];
 }
 /* eslint-enable perfectionist/sort-interfaces */

packages/core/src/semantic/semantic-func.ts

@@ -5,22 +5,26 @@ import type { TSESTree } from "@typescript-eslint/types";
 import type { SemanticNode } from "./semantic-node";
 
 /* eslint-disable perfectionist/sort-interfaces */
+/**
+ * Represents a semantic function node in the AST
+ * This interface extends SemanticNode and provides additional properties for function analysis
+ */
 export interface SemanticFunc extends SemanticNode {
-  // The identifier of the function
+  /** The identifier of the function */
   id: ast.FunctionID | unit;
-  // The AST node of the function
+  /** The AST node of the function */
   node: ast.TSESTreeFunction;
-  // The name of the function
+  /** The name of the function */
   name: string | unit;
-  // The return type of the function
+  /** The return type annotation of the function */
   type: TSESTree.TSTypeAnnotation | unit;
-  // The body of the function
+  /** The body of the function */
   body: TSESTree.BlockStatement | TSESTree.Expression;
-  // The directives of the function (e.g., "use strict", "use client", "use server", etc.)
+  /** The directives of the function (e.g., "use strict", "use client", "use server", etc.) */
   directives: TSESTree.StringLiteral[];
-  // The parameters of the function
+  /** The parameters of the function */
   parameters: TSESTree.Parameter[];
-  // The type parameters of the function
+  /** The type parameters of the function */
   typeParameters: TSESTree.TSTypeParameterDeclaration | unit;
 }
 /* eslint-enable perfectionist/sort-interfaces */

packages/core/src/semantic/semantic-node.ts

@@ -1,16 +1,23 @@
 import type { unit } from "@eslint-react/eff";
 import type { TSESTree } from "@typescript-eslint/types";
 
+/**
+ * Represents a semantic node in the AST
+ * This is the base interface for all semantic nodes in the React semantic analysis
+ */
 export interface SemanticNode {
-  id:
-    | unit
-    | TSESTree.Node;
+  /** The identifier of the node */
+  id: unit | TSESTree.Node;
+  /** The unique key of the node */
   key: string;
+  /** The kind of the node */
   kind: string;
-  name:
-    | unit
-    | 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;
 }