refactor: improve ESLint settings retrieval

Author: Rel1cx

eslint.config.ts

@@ -138,7 +138,6 @@ export default tseslint.config(
     files: [...GLOB_JS, ...GLOB_TS],
     rules: {
       eqeqeq: ["error", "always"],
-      "max-depth": ["warn", 4],
       "no-console": "error",
       "no-else-return": "error",
       "no-fallthrough": ["error", { commentPattern: ".*intentional fallthrough.*" }],

package.json

@@ -52,9 +52,9 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.11",
-    "@effect/platform": "^0.72.0",
-    "@effect/platform-bun": "^0.52.0",
-    "@effect/platform-node": "^0.68.0",
+    "@effect/platform": "^0.72.1",
+    "@effect/platform-bun": "^0.52.1",
+    "@effect/platform-node": "^0.68.1",
     "@effect/schema": "^0.75.5",
     "@eslint/config-inspector": "^0.7.0",
     "@eslint/js": "^9.17.0",
@@ -75,7 +75,7 @@
     "cspell": "^8.17.1",
     "dedent": "^1.5.3",
     "dprint": "^0.48.0",
-    "effect": "^3.12.0",
+    "effect": "^3.12.1",
     "esbuild": "^0.24.2",
     "eslint": "^9.17.0",
     "eslint-config-flat-gitignore": "^0.3.0",

packages/core/src/hook/is.ts

@@ -1,6 +1,6 @@
 import * as AST from "@eslint-react/ast";
 import { F, O } from "@eslint-react/eff";
-import { unsafeReadSettings } from "@eslint-react/shared";
+import { getSettingsFromContext } from "@eslint-react/shared";
 import type { RuleContext } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
@@ -31,7 +31,7 @@ export function isReactHookCall(node: TSESTree.Node) {
 }
 
 export function isReactHookCallWithName(node: TSESTree.CallExpression, context: RuleContext) {
-  const settings = unsafeReadSettings(context.settings);
+  const settings = getSettingsFromContext(context);
   return (name: string) => {
     const initialScope = context.sourceCode.getScope(node);
     switch (true) {
@@ -63,7 +63,7 @@ export function isReactHookCallWithNameLoose(node: TSESTree.CallExpression) {
 }
 
 export function isReactHookCallWithNameAlias(name: string, context: RuleContext, alias: string[]) {
-  const settings = unsafeReadSettings(context.settings);
+  const settings = getSettingsFromContext(context);
   return (node: TSESTree.CallExpression) => {
     const initialScope = context.sourceCode.getScope(node);
     switch (true) {

packages/core/src/utils/is-from-react.ts

@@ -1,6 +1,6 @@
 import * as AST from "@eslint-react/ast";
 import { F } from "@eslint-react/eff";
-import { unsafeReadSettings } from "@eslint-react/shared";
+import { getSettingsFromContext } from "@eslint-react/shared";
 import type { RuleContext } from "@eslint-react/types";
 import type { TSESTree } from "@typescript-eslint/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
@@ -17,7 +17,7 @@ export function isFromReact(name: string) {
     node: TSESTree.Identifier | TSESTree.MemberExpression,
     context: RuleContext,
   ) => {
-    const settings = unsafeReadSettings(context.settings);
+    const settings = getSettingsFromContext(context);
     const initialScope = context.sourceCode.getScope(node);
     if (node.type === AST_NODE_TYPES.MemberExpression) {
       return node.object.type === AST_NODE_TYPES.Identifier
@@ -44,7 +44,7 @@ export function isFromReactMember(
     node: TSESTree.MemberExpression,
     context: RuleContext,
   ) => {
-    const settings = unsafeReadSettings(context.settings);
+    const settings = getSettingsFromContext(context);
     const initialScope = context.sourceCode.getScope(node);
     if (node.property.type !== AST_NODE_TYPES.Identifier || node.property.name !== name) return false;
     if (node.object.type === AST_NODE_TYPES.Identifier && node.object.name === memberName) {

packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.ts

@@ -1,7 +1,7 @@
 import * as AST from "@eslint-react/ast";
 import { isCloneElementCall, isCreateElementCall, isInitializedFromReact } from "@eslint-react/core";
 import { isNullable, O, or } from "@eslint-react/eff";
-import { unsafeReadSettings } from "@eslint-react/shared";
+import { getSettingsFromContext } from "@eslint-react/shared";
 import type { RuleContext, RuleFeature } from "@eslint-react/types";
 import { AST_NODE_TYPES } from "@typescript-eslint/types";
 import type { TSESTree } from "@typescript-eslint/utils";
@@ -62,7 +62,7 @@ function isReactChildrenMethod(name: string): name is typeof reactChildrenMethod
 }
 
 function isUsingReactChildren(node: TSESTree.CallExpression, context: RuleContext) {
-  const settings = unsafeReadSettings(context.settings);
+  const settings = getSettingsFromContext(context);
   const { callee } = node;
   if (!("property" in callee) || !("object" in callee) || !("name" in callee.property)) {
     return false;

packages/shared/docs/functions/getSettingsFromContext.md

@@ -8,14 +8,22 @@
 
 > **getSettingsFromContext**(`context`): `ESLintReactSettingsNormalized`
 
+Get the normalized ESLint settings for "react-x" from the given context.
+
 ## Parameters
 
 ### context
 
+The context.
+
 #### settings
 
 `unknown`
 
+The ESLint settings.
+
 ## Returns
 
 `ESLintReactSettingsNormalized`
+
+The normalized ESLint settings.

packages/shared/package.json

@@ -44,7 +44,7 @@
     "@typescript-eslint/utils": "^8.19.0",
     "picomatch": "^4.0.2",
     "ts-pattern": "^5.6.0",
-    "valibot": "^1.0.0-beta.9"
+    "valibot": "^1.0.0-beta.10"
   },
   "devDependencies": {
     "@types/picomatch": "^3.0.1",

packages/shared/src/cache.ts

@@ -1,3 +1,3 @@
-import type { ESLintReactSettingsNormalized } from "./schemas";
+import type { ESLintReactSettings, ESLintReactSettingsNormalized } from "./schemas";
 
-export const normalizedSettingsCache = new Map<unknown, ESLintReactSettingsNormalized>();
+export const normalizedSettingsCache = new WeakMap<ESLintReactSettings, ESLintReactSettingsNormalized>();

packages/shared/src/settings.ts

@@ -1,8 +1,7 @@
 import { E, F } from "@eslint-react/eff";
 import pm from "picomatch";
 import { match, P } from "ts-pattern";
-import type { PartialDeep } from "type-fest";
-import { parse } from "valibot";
+import { assert } from "valibot";
 
 import { normalizedSettingsCache } from "./cache";
 import { getReactVersion } from "./get-react-version";
@@ -22,34 +21,25 @@ export const DEFAULT_ESLINT_REACT_SETTINGS = {
 } as const satisfies ESLintReactSettings;
 
 /**
- * Unsafely casts settings from a data object from `context.settings`.
- * @internal
- * @param data The data object.
- * @returns settings The settings.
+ * Get the normalized ESLint settings for "react-x" from the given context.
+ * @param context The context.
+ * @param context.settings The ESLint settings.
+ * @returns The normalized ESLint settings.
  */
-export function unsafeReadSettings(data: unknown): PartialDeep<ESLintReactSettings> {
-  // @ts-expect-error - skip type checking for unsafe cast
-  // eslint-disable-next-line @susisu/safe-typescript/no-type-assertion
-  return (data?.["react-x"] ?? {}) as PartialDeep<ESLintReactSettings>;
-}
-
-/**
- * Normalizes the settings by converting all shorthand properties to their full form.
- * @param data The raw settings.
- * @returns The normalized settings.
- * @internal
- */
-export function normalizeSettings(data: unknown): ESLintReactSettingsNormalized {
-  const memoized = normalizedSettingsCache.get(data);
-  if (memoized) return memoized;
-
-  const settings = {
+export function getSettingsFromContext(context: { settings: unknown }): ESLintReactSettingsNormalized {
+  assert(ESLintSettingsSchema, context.settings);
+  const raw = context.settings?.["react-x"] ?? {};
+  const memoized = normalizedSettingsCache.get(raw);
+  if (memoized) {
+    return memoized;
+  }
+  const rawWithDefaults = {
     ...DEFAULT_ESLINT_REACT_SETTINGS,
-    ...parse(ESLintSettingsSchema, data)["react-x"] ?? {},
+    ...raw,
   };
-  const additionalComponents = settings.additionalComponents ?? [];
+  const additionalComponents = rawWithDefaults.additionalComponents ?? [];
   const normalized = {
-    ...settings,
+    ...rawWithDefaults,
     additionalComponents: additionalComponents.map((component) => ({
       ...component,
       attributes: component.attributes?.map((attr) => ({
@@ -64,18 +54,14 @@ export function normalizeSettings(data: unknown): ESLintReactSettingsNormalized
       if (!/^[\w-]+$/u.test(name)) return acc;
       return acc.set(name, as);
     }, new Map<string, string>()),
-    version: match(settings.version)
+    version: match(rawWithDefaults.version)
       .with(P.union(P.nullish, "", "detect"), () => E.getOrElse(getReactVersion(), F.constant("19.0.0")))
       .otherwise(F.identity),
   };
-  normalizedSettingsCache.set(data, normalized);
+  normalizedSettingsCache.set(raw, normalized);
   return normalized;
 }
 
-export function getSettingsFromContext(context: { settings: unknown }): ESLintReactSettingsNormalized {
-  return normalizeSettings(context.settings);
-}
-
 /**
  * A helper function to define settings for "react-x" with type checking in JavaScript files.
  * @param settings The settings.

packages/utilities/eff/package.json

@@ -41,7 +41,7 @@
   },
   "devDependencies": {
     "@workspace/configs": "workspace:*",
-    "effect": "^3.12.0",
+    "effect": "^3.12.1",
     "tsup": "^8.3.5"
   },
   "engines": {