@eslint-react/var 2.8.2-next.5 → 2.8.2-next.6

package/dist/index.d.ts

@@ -27,12 +27,29 @@ type AssignmentTarget = ReturnType<typeof findEnclosingAssignmentTarget>;
 declare function findImportSource(name: string, initialScope: Scope): string | undefined;
 //#endregion
 //#region src/find-property.d.ts
+/**
+ * Find a property by name in an array of properties
+ * Handles spread elements by recursively resolving the referenced object
+ * @param name The property name to find
+ * @param properties The array of properties to search
+ * @param initialScope The scope to use for variable resolution
+ * @param seen Set of already seen variable names to prevent circular references
+ * @returns The found property or unit if not found
+ */
 declare function findProperty(name: string, properties: (TSESTree.Property | TSESTree.RestElement | TSESTree.SpreadElement)[], initialScope: Scope, seen?: Set<string>): (typeof properties)[number] | unit;
 //#endregion
 //#region src/get-child-scopes.d.ts
+/**
+ * Get all child scopes recursively from a given scope
+ * @param scope The scope to get child scopes from
+ * @returns Array of all child scopes including the input scope
+ */
 declare function getChildScopes(scope: Scope): readonly Scope[];
 //#endregion
 //#region src/get-object-type.d.ts
+/**
+ * Represents the type classification of an object node
+ */
 type ObjectType = {
   kind: "jsx";
   node: TSESTree.JSXElement | TSESTree.JSXFragment;
@@ -68,7 +85,20 @@ type ObjectType = {
 declare function getObjectType(node: TSESTree.Node | unit, initialScope: Scope): ObjectType | unit;
 //#endregion
 //#region src/get-variable-definition-node.d.ts
+/**
+ * Get the definition node of a variable at a specific definition index
+ * @param variable The variable to get the definition node from
+ * @param at The index of the definition to retrieve (negative index supported)
+ * @returns The definition node or unit if not found
+ */
 declare function getVariableDefinitionNode(variable: Variable | unit, at: number): unit | TSESTree.ClassDeclaration | TSESTree.ClassDeclarationWithName | TSESTree.ClassDeclarationWithOptionalName | TSESTree.Expression | TSESTree.FunctionDeclaration | TSESTree.FunctionDeclarationWithName | TSESTree.FunctionDeclarationWithOptionalName;
+/**
+ * Get the definition node of a variable at a specific definition index (loose version)
+ * Also returns the function node if the definition is a parameter
+ * @param variable The variable to get the definition node from
+ * @param at The index of the definition to retrieve
+ * @returns The definition node or unit if not found
+ */
 declare function getVariableDefinitionNodeLoose(variable: Variable | unit, at: number): unit | TSESTree.ClassDeclaration | TSESTree.ClassDeclarationWithName | TSESTree.ClassDeclarationWithOptionalName | TSESTree.Expression | TSESTree.FunctionDeclaration | TSESTree.FunctionDeclarationWithName | TSESTree.FunctionDeclarationWithOptionalName;
 //#endregion
 //#region src/get-variables-from-scope.d.ts
@@ -78,13 +108,30 @@ declare function getVariableDefinitionNodeLoose(variable: Variable | unit, at: n
  * @returns All variables from the given scope up to the global scope
  */
 declare function getVariables(initialScope: Scope): Variable[];
+/**
+ * Find a variable by name or identifier node in the scope chain
+ * @param initialScope The scope to start searching from
+ * @returns The found variable or unit if not found
+ * @overload
+ * @param nameOrNode The variable name or identifier node to find
+ * @param initialScope The scope to start searching from
+ * @returns The found variable or unit if not found
+ */
 declare const findVariable: {
   (initialScope: Scope): (nameOrNode: string | TSESTree.Identifier | unit) => Variable | unit;
   (nameOrNode: string | TSESTree.Identifier | unit, initialScope: Scope): Variable | unit;
 };
 //#endregion
 //#region src/is-assignment-target-equal.d.ts
-/** @internal */
+/**
+ * Check if two assignment targets are equal
+ * Compares nodes directly or by their values
+ * @param context The rule context
+ * @param a The first node to compare
+ * @param b The second node to compare
+ * @returns True if the assignment targets are equal
+ * @internal
+ */
 declare function isAssignmentTargetEqual(context: RuleContext, a: TSESTree.Node, b: TSESTree.Node): boolean;
 //#endregion
 //#region src/is-node-value-equal.d.ts

package/dist/index.js

@@ -41,6 +41,15 @@ function getVariables(initialScope) {
 	}
 	return variables.reverse();
 }
+/**
+* Find a variable by name or identifier node in the scope chain
+* @param initialScope The scope to start searching from
+* @returns The found variable or unit if not found
+* @overload
+* @param nameOrNode The variable name or identifier node to find
+* @param initialScope The scope to start searching from
+* @returns The found variable or unit if not found
+*/
 const findVariable = dual(2, (nameOrNode, initialScope) => {
 	if (nameOrNode == null) return unit;
 	return astUtils.findVariable(initialScope, nameOrNode) ?? unit;
@@ -90,6 +99,12 @@ function findImportSource(name, initialScope) {
 
 //#endregion
 //#region src/get-variable-definition-node.ts
+/**
+* Get the definition node of a variable at a specific definition index
+* @param variable The variable to get the definition node from
+* @param at The index of the definition to retrieve (negative index supported)
+* @returns The definition node or unit if not found
+*/
 function getVariableDefinitionNode(variable, at) {
 	if (variable == null) return unit;
 	const def = variable.defs.at(at);
@@ -101,6 +116,13 @@ function getVariableDefinitionNode(variable, at) {
 		default: return unit;
 	}
 }
+/**
+* Get the definition node of a variable at a specific definition index (loose version)
+* Also returns the function node if the definition is a parameter
+* @param variable The variable to get the definition node from
+* @param at The index of the definition to retrieve
+* @returns The definition node or unit if not found
+*/
 function getVariableDefinitionNodeLoose(variable, at) {
 	if (variable == null) return unit;
 	const node = getVariableDefinitionNode(variable, at);
@@ -112,6 +134,15 @@ function getVariableDefinitionNodeLoose(variable, at) {
 
 //#endregion
 //#region src/find-property.ts
+/**
+* Find a property by name in an array of properties
+* Handles spread elements by recursively resolving the referenced object
+* @param name The property name to find
+* @param properties The array of properties to search
+* @param initialScope The scope to use for variable resolution
+* @param seen Set of already seen variable names to prevent circular references
+* @returns The found property or unit if not found
+*/
 function findProperty(name, properties, initialScope, seen = /* @__PURE__ */ new Set()) {
 	return properties.findLast((prop) => {
 		if (prop.type === AST_NODE_TYPES.Property) return "name" in prop.key && prop.key.name === name;
@@ -134,6 +165,11 @@ function findProperty(name, properties, initialScope, seen = /* @__PURE__ */ new
 
 //#endregion
 //#region src/get-child-scopes.ts
+/**
+* Get all child scopes recursively from a given scope
+* @param scope The scope to get child scopes from
+* @returns Array of all child scopes including the input scope
+*/
 function getChildScopes(scope) {
 	const scopes = [scope];
 	for (const childScope of scope.childScopes) scopes.push(...getChildScopes(childScope));
@@ -279,7 +315,15 @@ function isNodeValueEqual(a, b, initialScopes) {
 
 //#endregion
 //#region src/is-assignment-target-equal.ts
-/** @internal */
+/**
+* Check if two assignment targets are equal
+* Compares nodes directly or by their values
+* @param context The rule context
+* @param a The first node to compare
+* @param b The second node to compare
+* @returns True if the assignment targets are equal
+* @internal
+*/
 function isAssignmentTargetEqual(context, a, b) {
 	return ast.isNodeEqual(a, b) || isNodeValueEqual(a, b, [context.sourceCode.getScope(a), context.sourceCode.getScope(b)]);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "2.8.2-next.5",
+  "version": "2.8.2-next.6",
   "description": "ESLint React's TSESTree AST utility module for static analysis of variables.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -34,9 +34,9 @@
     "@typescript-eslint/types": "^8.54.0",
     "@typescript-eslint/utils": "^8.54.0",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "2.8.2-next.5",
-    "@eslint-react/eff": "2.8.2-next.5",
-    "@eslint-react/shared": "2.8.2-next.5"
+    "@eslint-react/ast": "2.8.2-next.6",
+    "@eslint-react/shared": "2.8.2-next.6",
+    "@eslint-react/eff": "2.8.2-next.6"
   },
   "devDependencies": {
     "tsdown": "^0.20.1",