@eslint-react/var 5.17.3 → 5.18.0

package/dist/index.d.ts

@@ -5,58 +5,57 @@ import { RuleContext } from "@eslint-react/eslint";
 /**
  * Get the arguments of a require expression.
  * @param node The node to match.
- * @returns The require expression arguments or null if the node is not a require expression.
+ * @returns The require expression arguments or `null` if the node is not a require expression.
  * @internal
  */
 declare function getRequireExpressionArguments(node: TSESTree.Node): TSESTree.CallExpressionArgument[] | null;
 //#endregion
 //#region src/is-assignment-target-equal.d.ts
 /**
- * Check if two assignment targets are equal
- * Compares nodes directly or by their values.
+ * Check if two assignment targets are equal, either 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.
+ * @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-initialized-from-react.d.ts
 /**
- * Check if a variable is initialized from React import.
- * @internal
+ * Check if a variable is initialized from a React import.
  * @param name The variable name.
  * @param initialScope The initial scope.
  * @param importSource Alternative import source of React (ex: "preact/compat").
- * @returns True if the variable is initialized or derived from React import.
+ * @returns `true` if the variable is initialized or derived from a React import.
+ * @internal
  */
 declare function isInitializedFromReact(name: string, initialScope: Scope, importSource?: string): boolean;
 //#endregion
 //#region src/is-initialized-from-react-native.d.ts
 /**
- * if a variable is initialized from React Native import.
- * @internal
+ * Check if a variable is initialized from a React Native import.
  * @param name The variable name.
  * @param initialScope The initial scope.
  * @param importSource Alternative import source of React Native (ex: "react-native-web").
- * @returns True if the variable is initialized from React Native import.
+ * @returns `true` if the variable is initialized from a React Native import.
+ * @internal
  */
 declare function isInitializedFromReactNative(name: string, initialScope: Scope, importSource?: string): boolean;
 //#endregion
 //#region src/is-value-equal.d.ts
 /**
- * Determine whether node value equals to another node value.
- * @param context rule context.
- * @param a node to compare.
- * @param b node to compare.
- * @returns `true` if node value equal.
+ * Check if the value of a node equals the value of another node.
+ * @param context The rule context.
+ * @param a The first node to compare.
+ * @param b The second node to compare.
+ * @returns `true` if the node values are equal.
  */
 declare function isValueEqual(context: RuleContext, a: TSESTree.Node, b: TSESTree.Node): boolean;
 //#endregion
 //#region src/resolve.d.ts
 /**
- * Resolves an identifier to the AST node that represents its value,
+ * Resolve an identifier to the AST node that represents its value,
  * suitable for use in ESLint rule analysis.
  *
  * The resolution follows these rules per definition type:
@@ -92,18 +91,23 @@ declare function resolve(context: RuleContext, node: TSESTree.Identifier, option
 //#endregion
 //#region src/resolve-enclosing-assignment-target.d.ts
 /**
- * Finds the enclosing assignment target (variable, property, etc.) for a given node.
+ * Resolve the enclosing assignment target (variable, property, etc.) of a node.
  *
  * @param node The starting node.
- * @returns The enclosing assignment target node, or null if not found.
+ * @returns The enclosing assignment target node, or `null` if not found.
  */
 declare function resolveEnclosingAssignmentTarget(node: TSESTree.Node): TSESTree.ArrayExpression | TSESTree.ArrayPattern | TSESTree.ArrowFunctionExpressionWithBlockBody | TSESTree.ArrowFunctionExpressionWithExpressionBody | TSESTree.AssignmentExpression | TSESTree.AwaitExpression | TSESTree.PrivateInExpression | TSESTree.SymmetricBinaryExpression | TSESTree.CallExpression | TSESTree.ChainExpression | TSESTree.ClassDeclarationWithOptionalName | TSESTree.ClassExpression | TSESTree.ConditionalExpression | TSESTree.FunctionDeclarationWithName | TSESTree.FunctionDeclarationWithOptionalName | 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.TSDeclareFunctionNoDeclare | TSESTree.TSDeclareFunctionWithDeclare | TSESTree.TSEnumDeclaration | TSESTree.TSInstantiationExpression | TSESTree.TSInterfaceDeclaration | TSESTree.TSModuleDeclarationGlobal | TSESTree.TSModuleDeclarationModuleWithIdentifierId | TSESTree.TSModuleDeclarationModuleWithStringIdDeclared | TSESTree.TSModuleDeclarationModuleWithStringIdNotDeclared | TSESTree.TSModuleDeclarationNamespace | TSESTree.TSNonNullExpression | TSESTree.TSSatisfiesExpression | TSESTree.TSTypeAliasDeclaration | TSESTree.TSTypeAssertion | TSESTree.UnaryExpressionBitwiseNot | TSESTree.UnaryExpressionDelete | TSESTree.UnaryExpressionMinus | TSESTree.UnaryExpressionNot | TSESTree.UnaryExpressionPlus | TSESTree.UnaryExpressionTypeof | TSESTree.UnaryExpressionVoid | TSESTree.UpdateExpression | TSESTree.ConstDeclaration | TSESTree.LetOrVarDeclaredDeclaration | TSESTree.LetOrVarNonDeclaredDeclaration | TSESTree.UsingInForOfDeclaration | TSESTree.UsingInNormalContextDeclaration | TSESTree.YieldNoStarExpression | TSESTree.YieldStarExpression | null;
-/**
- * Type representing the possible assignment targets returned by `resolveEnclosingAssignmentTarget`.
- */
+/** The possible assignment targets returned by {@link resolveEnclosingAssignmentTarget}. */
 type AssignmentTarget = ReturnType<typeof resolveEnclosingAssignmentTarget>;
 //#endregion
 //#region src/resolve-import-source.d.ts
+/**
+ * Resolve the import source of a variable by walking its latest definition.
+ * @param name The variable name.
+ * @param initialScope The initial scope.
+ * @param seen The set of already visited variable names (for cycle detection).
+ * @returns The import source, or `null` if it cannot be resolved.
+ */
 declare function resolveImportSource(name: string, initialScope: Scope, seen?: Set<string>): string | null;
 //#endregion
 //#region src/resolve-object-type.d.ts
@@ -137,10 +141,10 @@ type ObjectType = {
   reason?: string;
 };
 /**
- * Detect the ObjectType of a given node.
- * @param context The context of the rule.
- * @param node The node to check.
- * @returns The ObjectType of the node, or undefined if not detected.
+ * Resolve the object type of the given node.
+ * @param context The rule context.
+ * @param node The node to resolve.
+ * @returns The object type of the node, or `null` if it cannot be resolved.
  */
 declare function resolveObjectType(context: RuleContext, node: TSESTree.Node | null): ObjectType | null;
 //#endregion

package/dist/index.js

@@ -8,7 +8,7 @@ import { P, isMatching } from "ts-pattern";
 /**
 * Get the arguments of a require expression.
 * @param node The node to match.
-* @returns The require expression arguments or null if the node is not a require expression.
+* @returns The require expression arguments or `null` if the node is not a require expression.
 * @internal
 */
 function getRequireExpressionArguments(node) {
@@ -24,7 +24,7 @@ function getRequireExpressionArguments(node) {
 //#endregion
 //#region src/resolve.ts
 /**
-* Resolves an identifier to the AST node that represents its value,
+* Resolve an identifier to the AST node that represents its value,
 * suitable for use in ESLint rule analysis.
 *
 * The resolution follows these rules per definition type:
@@ -90,11 +90,11 @@ const thisBlockTypes = [
 	AST_NODE_TYPES.Program
 ];
 /**
-* Determine whether node value equals to another node value.
-* @param context rule context.
-* @param a node to compare.
-* @param b node to compare.
-* @returns `true` if node value equal.
+* Check if the value of a node equals the value of another node.
+* @param context The rule context.
+* @param a The first node to compare.
+* @param b The second node to compare.
+* @returns `true` if the node values are equal.
 */
 function isValueEqual(context, a, b) {
 	a = Check.isTypeExpression(a) ? Extract.unwrap(a) : a;
@@ -152,12 +152,11 @@ function isValueEqual(context, a, b) {
 //#endregion
 //#region src/is-assignment-target-equal.ts
 /**
-* Check if two assignment targets are equal
-* Compares nodes directly or by their values.
+* Check if two assignment targets are equal, either 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.
+* @returns `true` if the assignment targets are equal.
 * @internal
 */
 function isAssignmentTargetEqual(context, a, b) {
@@ -166,6 +165,13 @@ function isAssignmentTargetEqual(context, a, b) {
 
 //#endregion
 //#region src/resolve-import-source.ts
+/**
+* Resolve the import source of a variable by walking its latest definition.
+* @param name The variable name.
+* @param initialScope The initial scope.
+* @param seen The set of already visited variable names (for cycle detection).
+* @returns The import source, or `null` if it cannot be resolved.
+*/
 function resolveImportSource(name, initialScope, seen = /* @__PURE__ */ new Set()) {
 	if (seen.has(name)) return null;
 	seen.add(name);
@@ -190,12 +196,12 @@ function resolveImportSource(name, initialScope, seen = /* @__PURE__ */ new Set(
 //#endregion
 //#region src/is-initialized-from-react.ts
 /**
-* Check if a variable is initialized from React import.
-* @internal
+* Check if a variable is initialized from a React import.
 * @param name The variable name.
 * @param initialScope The initial scope.
 * @param importSource Alternative import source of React (ex: "preact/compat").
-* @returns True if the variable is initialized or derived from React import.
+* @returns `true` if the variable is initialized or derived from a React import.
+* @internal
 */
 function isInitializedFromReact(name, initialScope, importSource = "react") {
 	return name.toLowerCase() === "react" || Boolean(resolveImportSource(name, initialScope)?.startsWith(importSource));
@@ -204,12 +210,12 @@ function isInitializedFromReact(name, initialScope, importSource = "react") {
 //#endregion
 //#region src/is-initialized-from-react-native.ts
 /**
-* if a variable is initialized from React Native import.
-* @internal
+* Check if a variable is initialized from a React Native import.
 * @param name The variable name.
 * @param initialScope The initial scope.
 * @param importSource Alternative import source of React Native (ex: "react-native-web").
-* @returns True if the variable is initialized from React Native import.
+* @returns `true` if the variable is initialized from a React Native import.
+* @internal
 */
 function isInitializedFromReactNative(name, initialScope, importSource = "react-native") {
 	return [
@@ -222,10 +228,10 @@ function isInitializedFromReactNative(name, initialScope, importSource = "react-
 //#endregion
 //#region src/resolve-enclosing-assignment-target.ts
 /**
-* Finds the enclosing assignment target (variable, property, etc.) for a given node.
+* Resolve the enclosing assignment target (variable, property, etc.) of a node.
 *
 * @param node The starting node.
-* @returns The enclosing assignment target node, or null if not found.
+* @returns The enclosing assignment target node, or `null` if not found.
 */
 function resolveEnclosingAssignmentTarget(node) {
 	switch (true) {
@@ -241,10 +247,10 @@ function resolveEnclosingAssignmentTarget(node) {
 //#endregion
 //#region src/resolve-object-type.ts
 /**
-* Detect the ObjectType of a given node.
-* @param context The context of the rule.
-* @param node The node to check.
-* @returns The ObjectType of the node, or undefined if not detected.
+* Resolve the object type of the given node.
+* @param context The rule context.
+* @param node The node to resolve.
+* @returns The object type of the node, or `null` if it cannot be resolved.
 */
 function resolveObjectType(context, node) {
 	if (node == null) return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "5.17.3",
+  "version": "5.18.0",
   "description": "ESLint React's TSESTree AST utility module for static analysis of variables.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -29,18 +29,18 @@
     "dist"
   ],
   "dependencies": {
-    "@typescript-eslint/scope-manager": "^8.64.0",
-    "@typescript-eslint/types": "^8.64.0",
-    "@typescript-eslint/utils": "^8.64.0",
+    "@typescript-eslint/scope-manager": "^8.65.0",
+    "@typescript-eslint/types": "^8.65.0",
+    "@typescript-eslint/utils": "^8.65.0",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/eslint": "5.17.3",
-    "@eslint-react/ast": "5.17.3"
+    "@eslint-react/ast": "5.18.0",
+    "@eslint-react/eslint": "5.18.0"
   },
   "devDependencies": {
-    "@typescript-eslint/parser": "^8.64.0",
-    "@typescript-eslint/typescript-estree": "^8.64.0",
+    "@typescript-eslint/parser": "^8.65.0",
+    "@typescript-eslint/typescript-estree": "^8.65.0",
     "eslint": "^10.7.0",
-    "tsdown": "^0.22.9",
+    "tsdown": "^0.22.13",
     "typescript": "6.0.3",
     "vitest": "^4.1.10",
     "@local/configs": "0.0.0",