refactor: reorder parameters in 'isInitializedFromReact' function and update related usages

Rel1cx · Rel1cx · commit 0e4f43ad4985 · 2025-01-16T23:59:14.000+08:00
diff --git a/packages/core/docs/functions/isInitializedFromReact.md b/packages/core/docs/functions/isInitializedFromReact.md
@@ -6,21 +6,21 @@
 
 # Function: isInitializedFromReact()
 
-> **isInitializedFromReact**(`name`, `initialScope`, `importSource`): `boolean`
+> **isInitializedFromReact**(`name`, `importSource`, `initialScope`): `boolean`
 
 ## Parameters
 
 ### name
 
 `string`
 
-### initialScope
+### importSource
 
-`Scope`
+`string`
 
-### importSource
+### initialScope
 
-`string` = `"react"`
+`Scope`
 
 ## Returns
 
diff --git a/packages/core/src/hook/is.ts b/packages/core/src/hook/is.ts
@@ -36,21 +36,22 @@ export function isReactHookCall(node: TSESTree.Node | _) {
 export function isReactHookCallWithName(node: TSESTree.CallExpression | _, context: RuleContext) {
   if (node == null) return returnFalse;
   const settings = unsafeDecodeSettings(context.settings);
+  const importSource = settings.importSource ?? "react";
+  const initialScope = context.sourceCode.getScope(node);
   return (name: string) => {
-    const initialScope = context.sourceCode.getScope(node);
     switch (true) {
       case node.callee.type === T.Identifier
         && node.callee.name === name:
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         return !settings.strictImportCheck
-          || isInitializedFromReact(name, initialScope, settings.importSource);
+          || isInitializedFromReact(name, importSource, initialScope);
       case node.callee.type === T.MemberExpression
         && node.callee.property.type === T.Identifier
         && node.callee.property.name === name
         && "name" in node.callee.object:
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         return !settings.strictImportCheck
-          || isInitializedFromReact(node.callee.object.name, initialScope, settings.importSource);
+          || isInitializedFromReact(node.callee.object.name, importSource, initialScope);
       default:
         return false;
     }
@@ -73,21 +74,22 @@ export function isReactHookCallWithNameLoose(node: TSESTree.CallExpression | _)
 
 export function isReactHookCallWithNameAlias(name: string, context: RuleContext, alias: string[]) {
   const settings = unsafeDecodeSettings(context);
+  const importSource = settings.importSource ?? "react";
   return (node: TSESTree.CallExpression) => {
     const initialScope = context.sourceCode.getScope(node);
     switch (true) {
       case node.callee.type === T.Identifier
         && node.callee.name === name:
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         return !settings.strictImportCheck
-          || isInitializedFromReact(name, initialScope, settings.importSource);
+          || isInitializedFromReact(name, importSource, initialScope);
       case node.callee.type === T.MemberExpression
         && node.callee.property.type === T.Identifier
         && node.callee.property.name === name
         && "name" in node.callee.object:
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         return !settings.strictImportCheck
-          || isInitializedFromReact(node.callee.object.name, initialScope, settings.importSource);
+          || isInitializedFromReact(node.callee.object.name, importSource, initialScope);
       default:
         return alias.some(isReactHookCallWithNameLoose(node));
     }
diff --git a/packages/core/src/utils/is-from-react.ts b/packages/core/src/utils/is-from-react.ts
@@ -1,7 +1,7 @@
 import * as AST from "@eslint-react/ast";
 import { dual } from "@eslint-react/eff";
 import type { RuleContext } from "@eslint-react/shared";
-import { unsafeDecodeSettings } from "@eslint-react/shared";
+import { DEFAULT_ESLINT_REACT_SETTINGS, unsafeDecodeSettings } from "@eslint-react/shared";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 
@@ -27,15 +27,16 @@ export function isFromReact(name: string) {
       }
       return node.name === name;
     }
+    const importSource = settings.importSource ?? DEFAULT_ESLINT_REACT_SETTINGS.importSource;
     const initialScope = context.sourceCode.getScope(node);
     if (node.type === T.MemberExpression) {
       return node.object.type === T.Identifier
         && node.property.type === T.Identifier
         && node.property.name === name
-        && isInitializedFromReact(node.object.name, initialScope, settings.importSource);
+        && isInitializedFromReact(node.object.name, importSource, initialScope);
     }
     if (node.name === name) {
-      return isInitializedFromReact(name, initialScope, settings.importSource);
+      return isInitializedFromReact(name, importSource, initialScope);
     }
     return false;
   };
@@ -73,17 +74,18 @@ export function isFromReactMember(
       }
       return false;
     }
+    const importSource = settings.importSource ?? DEFAULT_ESLINT_REACT_SETTINGS.importSource;
     const initialScope = context.sourceCode.getScope(node);
     if (node.property.type !== T.Identifier || node.property.name !== name) {
       return false;
     }
     if (node.object.type === T.Identifier && node.object.name === memberName) {
-      return isInitializedFromReact(node.object.name, initialScope, settings.importSource);
+      return isInitializedFromReact(node.object.name, importSource, initialScope);
     }
     if (
       node.object.type === T.MemberExpression
       && node.object.object.type === T.Identifier
-      && isInitializedFromReact(node.object.object.name, initialScope, settings.importSource)
+      && isInitializedFromReact(node.object.object.name, importSource, initialScope)
       && node.object.property.type === T.Identifier
     ) {
       return node.object.property.name === memberName;
diff --git a/packages/core/src/utils/is-initialized-from-react.ts b/packages/core/src/utils/is-initialized-from-react.ts
@@ -3,8 +3,8 @@ import type { Scope } from "@typescript-eslint/scope-manager";
 
 export function isInitializedFromReact(
   name: string,
+  importSource: string,
   initialScope: Scope,
-  importSource = "react",
 ) {
   return name.toLowerCase() === "react"
     || VAR.isInitializedFromSource(
diff --git a/packages/plugins/eslint-plugin-react-debug/src/rules/is-from-react.ts b/packages/plugins/eslint-plugin-react-debug/src/rules/is-from-react.ts
@@ -31,11 +31,8 @@ export default createRule<[], MessageID>({
   },
   name: RULE_NAME,
   create(context) {
-    const settings = {
-      importSource: "react",
-      ...getSettingsFromContext(context),
-      strictImportCheck: true,
-    };
+    const { importSource = "react" } = getSettingsFromContext(context);
+
     function isFromReact(
       node: TSESTree.Identifier | TSESTree.JSXIdentifier,
       initialScope: Scope,
@@ -45,13 +42,13 @@ export default createRule<[], MessageID>({
         case node.parent.type === T.MemberExpression
           && node.parent.property === node
           && node.parent.object.type === T.Identifier:
-          return isInitializedFromReact(node.parent.object.name, initialScope, settings.importSource);
+          return isInitializedFromReact(node.parent.object.name, importSource, initialScope);
         case node.parent.type === T.JSXMemberExpression
           && node.parent.property === node
           && node.parent.object.type === T.JSXIdentifier:
-          return isInitializedFromReact(node.parent.object.name, initialScope, settings.importSource);
+          return isInitializedFromReact(node.parent.object.name, importSource, initialScope);
         default:
-          return isInitializedFromReact(name, initialScope, settings.importSource);
+          return isInitializedFromReact(name, importSource, initialScope);
       }
     }
     function visitorFunction(node: TSESTree.Identifier | TSESTree.JSXIdentifier) {
@@ -73,7 +70,7 @@ export default createRule<[], MessageID>({
           // eslint-disable-next-line eslint-plugin/no-unused-placeholders
           type: node.type,
           name,
-          importSource: settings.importSource,
+          importSource,
         },
       });
     }
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.ts b/packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.ts
@@ -51,7 +51,7 @@ function isReactChildrenMethod(name: string): name is typeof reactChildrenMethod
 }
 
 function isUsingReactChildren(node: TSESTree.CallExpression, context: RuleContext) {
-  const settings = unsafeDecodeSettings(context.settings);
+  const { importSource = "react" } = unsafeDecodeSettings(context.settings);
   const { callee } = node;
   if (!("property" in callee) || !("object" in callee) || !("name" in callee.property)) {
     return false;
@@ -64,7 +64,7 @@ function isUsingReactChildren(node: TSESTree.CallExpression, context: RuleContex
     return true;
   }
   if (callee.object.type === T.MemberExpression && "name" in callee.object.object) {
-    return isInitializedFromReact(callee.object.object.name, initialScope, settings.importSource);
+    return isInitializedFromReact(callee.object.object.name, importSource, initialScope);
   }
   return false;
 }
diff --git a/packages/shared/src/settings.ts b/packages/shared/src/settings.ts
@@ -34,8 +34,8 @@ export interface CustomComponentPropNormalized {
 export interface ESLintReactSettingsNormalized {
   additionalComponents: CustomComponentNormalized[];
   additionalHooks: CustomHooks;
-  importSource?: string;
-  polymorphicPropName?: string | _;
+  importSource: string;
+  polymorphicPropName: string | _;
   // strict: boolean;
   strictImportCheck: boolean;
   version: string;
@@ -76,6 +76,8 @@ export const toNormalizedSettings = memoize(
   ({
     additionalComponents = [],
     additionalHooks = {},
+    importSource = "react",
+    polymorphicPropName = "as",
     version,
     ...rest
   }: ESLintReactSettings): ESLintReactSettingsNormalized => {
@@ -99,6 +101,8 @@ export const toNormalizedSettings = memoize(
         re: pm.makeRe(name, { fastpaths: true }),
       })),
       additionalHooks,
+      importSource,
+      polymorphicPropName,
       version: match(version)
         .with(P.union(P.nullish, "", "detect"), () => getReactVersion("19.0.0"))
         .otherwise(identity),

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ function isReactChildrenMethod(name: string): name is typeof reactChildrenMethod`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`function isUsingReactChildren(node: TSESTree.CallExpression, context: RuleContext) {`
`54`		`- const settings = unsafeDecodeSettings(context.settings);`
	`54`	`+ const { importSource = "react" } = unsafeDecodeSettings(context.settings);`
`55`	`55`	`const { callee } = node;`
`56`	`56`	`if (!("property" in callee) \|\| !("object" in callee) \|\| !("name" in callee.property)) {`
`57`	`57`	`return false;`
`@@ -64,7 +64,7 @@ function isUsingReactChildren(node: TSESTree.CallExpression, context: RuleContex`
`64`	`64`	`return true;`
`65`	`65`	`}`
`66`	`66`	`if (callee.object.type === T.MemberExpression && "name" in callee.object.object) {`
`67`		`- return isInitializedFromReact(callee.object.object.name, initialScope, settings.importSource);`
	`67`	`+ return isInitializedFromReact(callee.object.object.name, importSource, initialScope);`
`68`	`68`	`}`
`69`	`69`	`return false;`
`70`	`70`	`}`