refactor: rename JsxRuntimeOptions to JsxRuntimeConfig (#1040)

Rel1cx · web-flow · commit 15b81b9825fa · 2025-04-07T22:24:24.000+08:00
diff --git a/packages/plugins/eslint-plugin-react-x/src/rules/jsx-uses-react.ts b/packages/plugins/eslint-plugin-react-x/src/rules/jsx-uses-react.ts
@@ -2,7 +2,7 @@ import type { TSESTree } from "@typescript-eslint/types";
 import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
 
 import type { CamelCase } from "string-ts";
-import { JsxRuntimeOptions, type RuleContext, type RuleFeature } from "@eslint-react/kit";
+import { JsxRuntimeConfig, type RuleContext, type RuleFeature } from "@eslint-react/kit";
 import { JsxEmit } from "typescript";
 import { createRule } from "../utils";
 
@@ -30,14 +30,12 @@ export default createRule<[], MessageID>({
 });
 
 export function create(context: RuleContext<MessageID, []>): RuleListener {
-  const jsxRuntimeOptionsFromContext = JsxRuntimeOptions.getFromContext(context);
-  const jsxRuntimeOptionsFromAnnotation = JsxRuntimeOptions.getFromAnnotation(context);
-  const jsxRuntimeOptions = {
-    ...jsxRuntimeOptionsFromContext,
-    ...jsxRuntimeOptionsFromAnnotation,
+  const jsxRuntimeConfig = {
+    ...JsxRuntimeConfig.getFromContext(context),
+    ...JsxRuntimeConfig.getFromAnnotation(context),
   };
 
-  const { jsx, jsxFactory, jsxFragmentFactory } = jsxRuntimeOptions;
+  const { jsx, jsxFactory, jsxFragmentFactory } = jsxRuntimeConfig;
 
   if (jsx === JsxEmit.ReactJSX || jsx === JsxEmit.ReactJSXDev) return {};
 
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/README.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/README.md
@@ -2,13 +2,13 @@
 
 ***
 
-[@eslint-react/kit](../../../README.md) / JsxRuntimeOptions
+[@eslint-react/kit](../../../README.md) / JsxRuntimeConfig
 
-# JsxRuntimeOptions
+# JsxRuntimeConfig
 
 ## Type Aliases
 
-- [JsxRuntimeOptions](type-aliases/JsxRuntimeOptions.md)
+- [JsxRuntimeConfig](type-aliases/JsxRuntimeConfig.md)
 
 ## Functions
 
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromAnnotation.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromAnnotation.md
@@ -0,0 +1,25 @@
+[**@eslint-react/kit**](../../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../../README.md) / [JsxRuntimeConfig](../README.md) / getFromAnnotation
+
+# Function: getFromAnnotation()
+
+> **getFromAnnotation**(`context`): [`JsxRuntimeConfig`](../type-aliases/JsxRuntimeConfig.md)
+
+Get JsxRuntimeConfig from annotation
+
+## Parameters
+
+### context
+
+[`RuleContext`](../../../../type-aliases/RuleContext.md)
+
+The RuleContext
+
+## Returns
+
+[`JsxRuntimeConfig`](../type-aliases/JsxRuntimeConfig.md)
+
+JsxRuntimeConfig
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromContext.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromContext.md
@@ -2,13 +2,13 @@
 
 ***
 
-[@eslint-react/kit](../../../../README.md) / [JsxRuntimeOptions](../README.md) / getFromContext
+[@eslint-react/kit](../../../../README.md) / [JsxRuntimeConfig](../README.md) / getFromContext
 
 # Function: getFromContext()
 
 > **getFromContext**(`context`): `object`
 
-Get JsxRuntimeOptions from RuleContext
+Get JsxRuntimeConfig from RuleContext
 
 ## Parameters
 
@@ -22,7 +22,7 @@ The RuleContext
 
 `object`
 
-JsxRuntimeOptions
+JsxRuntimeConfig
 
 ### jsx
 
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/make.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/make.md
@@ -0,0 +1,17 @@
+[**@eslint-react/kit**](../../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../../README.md) / [JsxRuntimeConfig](../README.md) / make
+
+# Function: make()
+
+> **make**(): [`JsxRuntimeConfig`](../type-aliases/JsxRuntimeConfig.md)
+
+Create a JsxRuntimeConfig object
+
+## Returns
+
+[`JsxRuntimeConfig`](../type-aliases/JsxRuntimeConfig.md)
+
+JsxRuntimeConfig
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/type-aliases/JsxRuntimeConfig.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/type-aliases/JsxRuntimeConfig.md
@@ -0,0 +1,9 @@
+[**@eslint-react/kit**](../../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../../README.md) / [JsxRuntimeConfig](../README.md) / JsxRuntimeConfig
+
+# Type Alias: JsxRuntimeConfig
+
+> **JsxRuntimeConfig** = [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<`CompilerOptions`, `"reactNamespace"` \| `"jsx"` \| `"jsxFactory"` \| `"jsxFragmentFactory"` \| `"jsxImportSource"`\>
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/getFromAnnotation.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/getFromAnnotation.md
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/make.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/make.md
diff --git a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/type-aliases/JsxRuntimeOptions.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/type-aliases/JsxRuntimeOptions.md
diff --git a/packages/utilities/kit/docs/README.md b/packages/utilities/kit/docs/README.md
@@ -6,7 +6,7 @@
 
 ## Namespaces
 
-- [JsxRuntimeOptions](@eslint-react/namespaces/JsxRuntimeOptions/README.md)
+- [JsxRuntimeConfig](@eslint-react/namespaces/JsxRuntimeConfig/README.md)
 - [LanguagePreference](@eslint-react/namespaces/LanguagePreference/README.md)
 
 ## Type Aliases
diff --git a/packages/utilities/kit/src/JsxRuntimeConfig/JsxRuntimeConfig.ts b/packages/utilities/kit/src/JsxRuntimeConfig/JsxRuntimeConfig.ts
@@ -8,7 +8,7 @@ import {
   RE_ANNOTATION_JSX_RUNTIME,
 } from "../RegExp";
 
-export type JsxRuntimeOptions = Pick<
+export type JsxRuntimeConfig = Pick<
   CompilerOptions,
   // Specifies the object invoked for `createElement` and `__spread` when targeting `'react'` JSX emit.
   | "reactNamespace"
@@ -23,17 +23,17 @@ export type JsxRuntimeOptions = Pick<
 >;
 
 /**
- * Create a JsxRuntimeOptions object
- * @returns JsxRuntimeOptions
+ * Create a JsxRuntimeConfig object
+ * @returns JsxRuntimeConfig
  */
-export function make(): JsxRuntimeOptions {
+export function make(): JsxRuntimeConfig {
   return {};
 }
 
 /**
- * Get JsxRuntimeOptions from RuleContext
+ * Get JsxRuntimeConfig from RuleContext
  * @param context The RuleContext
- * @returns JsxRuntimeOptions
+ * @returns JsxRuntimeConfig
  */
 export function getFromContext(context: RuleContext) {
   const options = context.sourceCode.parserServices?.program?.getCompilerOptions() ?? {};
@@ -47,9 +47,9 @@ export function getFromContext(context: RuleContext) {
 }
 
 /**
- * Get JsxRuntimeOptions from annotation
+ * Get JsxRuntimeConfig from annotation
  * @param context The RuleContext
- * @returns JsxRuntimeOptions
+ * @returns JsxRuntimeConfig
  */
 export function getFromAnnotation(context: RuleContext) {
   if (!context.sourceCode.text.includes("@jsx")) return {};
diff --git a/packages/utilities/kit/src/JsxRuntimeConfig/index.ts b/packages/utilities/kit/src/JsxRuntimeConfig/index.ts
@@ -0,0 +1 @@
+export * from "./JsxRuntimeConfig";
diff --git a/packages/utilities/kit/src/JsxRuntimeOptions/index.ts b/packages/utilities/kit/src/JsxRuntimeOptions/index.ts
diff --git a/packages/utilities/kit/src/index.ts b/packages/utilities/kit/src/index.ts
@@ -1,4 +1,4 @@
-export * as JsxRuntimeOptions from "./JsxRuntimeOptions";
+export * as JsxRuntimeConfig from "./JsxRuntimeConfig";
 export * as LanguagePreference from "./LanguagePreference";
 export * from "./RegExp";
 export * from "./Rule";
