@eslint-react/var 5.16.0 → 5.17.0

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { TSESTree } from "@typescript-eslint/types";
 import { RuleContext } from "@eslint-react/eslint";
 //#region src/compute-object-type.d.ts
 /**
- * Represents the type classification of an object node
+ * Represents the type classification of an object node.
  */
 type ObjectType = {
   kind: "jsx";
@@ -32,18 +32,18 @@ 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
+ * 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.
  */
 declare function computeObjectType(context: RuleContext, node: TSESTree.Node | null): ObjectType | null;
 //#endregion
 //#region src/get-require-expression-arguments.d.ts
 /**
- * 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
+ * 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.
  * @internal
  */
 declare function getRequireExpressionArguments(node: TSESTree.Node): TSESTree.CallExpressionArgument[] | null;
@@ -51,44 +51,44 @@ declare function getRequireExpressionArguments(node: TSESTree.Node): TSESTree.Ca
 //#region src/is-assignment-target-equal.d.ts
 /**
  * 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
+ * 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-initialized-from-react.d.ts
 /**
- * Check if a variable is initialized from React import
+ * Check if a variable is initialized from React import.
  * @internal
- * @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
+ * @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.
  */
 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
+ * if a variable is initialized from React Native import.
  * @internal
- * @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
+ * @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.
  */
 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
+ * 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.
  */
 declare function isValueEqual(context: RuleContext, a: TSESTree.Node, b: TSESTree.Node): boolean;
 //#endregion
@@ -130,14 +130,14 @@ 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
+ * Finds the enclosing assignment target (variable, property, etc.) for a given node.
  *
- * @param node The starting node
- * @returns The enclosing assignment target node, or null if not found
+ * @param node The starting node.
+ * @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`
+ * Type representing the possible assignment targets returned by `resolveEnclosingAssignmentTarget`.
  */
 type AssignmentTarget = ReturnType<typeof resolveEnclosingAssignmentTarget>;
 //#endregion

package/dist/index.js

@@ -66,10 +66,10 @@ function resolve(context, node, options) {
 //#endregion
 //#region src/compute-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
+* 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.
 */
 function computeObjectType(context, node) {
 	if (node == null) return null;
@@ -177,9 +177,9 @@ function computeObjectType(context, node) {
 //#endregion
 //#region src/get-require-expression-arguments.ts
 /**
-* 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
+* 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.
 * @internal
 */
 function getRequireExpressionArguments(node) {
@@ -201,11 +201,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
+* 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.
 */
 function isValueEqual(context, a, b) {
 	a = Check.isTypeExpression(a) ? Extract.unwrap(a) : a;
@@ -264,11 +264,11 @@ function isValueEqual(context, a, b) {
 //#region src/is-assignment-target-equal.ts
 /**
 * 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
+* 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) {
@@ -301,12 +301,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
+* Check if a variable is initialized from React import.
 * @internal
-* @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
+* @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.
 */
 function isInitializedFromReact(name, initialScope, importSource = "react") {
 	return name.toLowerCase() === "react" || Boolean(resolveImportSource(name, initialScope)?.startsWith(importSource));
@@ -315,12 +315,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
+* if a variable is initialized from React Native import.
 * @internal
-* @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
+* @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.
 */
 function isInitializedFromReactNative(name, initialScope, importSource = "react-native") {
 	return [
@@ -333,10 +333,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
+* Finds the enclosing assignment target (variable, property, etc.) for a given node.
 *
-* @param node The starting node
-* @returns The enclosing assignment target node, or null if not found
+* @param node The starting node.
+* @returns The enclosing assignment target node, or null if not found.
 */
 function resolveEnclosingAssignmentTarget(node) {
 	switch (true) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "5.16.0",
+  "version": "5.17.0",
   "description": "ESLint React's TSESTree AST utility module for static analysis of variables.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
@@ -33,8 +33,8 @@
     "@typescript-eslint/types": "^8.64.0",
     "@typescript-eslint/utils": "^8.64.0",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "5.16.0",
-    "@eslint-react/eslint": "5.16.0"
+    "@eslint-react/eslint": "5.17.0",
+    "@eslint-react/ast": "5.17.0"
   },
   "devDependencies": {
     "@typescript-eslint/parser": "^8.64.0",
@@ -43,8 +43,8 @@
     "tsdown": "^0.22.7",
     "typescript": "6.0.3",
     "vitest": "^4.1.10",
-    "@local/configs": "0.0.0",
-    "@local/eff": "0.0.0"
+    "@local/eff": "0.0.0",
+    "@local/configs": "0.0.0"
   },
   "peerDependencies": {
     "eslint": "*",