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 index 00d92ed088..030342cfa3 100644 --- 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): 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/JsxRuntimeOptions/README.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/README.md similarity index 60% rename from packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/README.md rename to packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/README.md index 50d78df1da..8e78204fb6 100644 --- a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/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 new file mode 100644 index 0000000000..a81c0910b4 --- /dev/null +++ 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/JsxRuntimeOptions/functions/getFromContext.md b/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromContext.md similarity index 76% rename from packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/getFromContext.md rename to packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeConfig/functions/getFromContext.md index bb3d2ef630..3e6b40c24a 100644 --- a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/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 new file mode 100644 index 0000000000..9e0f0c0097 --- /dev/null +++ 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 new file mode 100644 index 0000000000..7beaff1e37 --- /dev/null +++ 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 deleted file mode 100644 index 28888f30a3..0000000000 --- a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/getFromAnnotation.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@eslint-react/kit**](../../../../README.md) - -*** - -[@eslint-react/kit](../../../../README.md) / [JsxRuntimeOptions](../README.md) / getFromAnnotation - -# Function: getFromAnnotation() - -> **getFromAnnotation**(`context`): [`JsxRuntimeOptions`](../type-aliases/JsxRuntimeOptions.md) - -Get JsxRuntimeOptions from annotation - -## Parameters - -### context - -[`RuleContext`](../../../../type-aliases/RuleContext.md) - -The RuleContext - -## Returns - -[`JsxRuntimeOptions`](../type-aliases/JsxRuntimeOptions.md) - -JsxRuntimeOptions 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 deleted file mode 100644 index 6e834a2c7a..0000000000 --- a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/functions/make.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@eslint-react/kit**](../../../../README.md) - -*** - -[@eslint-react/kit](../../../../README.md) / [JsxRuntimeOptions](../README.md) / make - -# Function: make() - -> **make**(): [`JsxRuntimeOptions`](../type-aliases/JsxRuntimeOptions.md) - -Create a JsxRuntimeOptions object - -## Returns - -[`JsxRuntimeOptions`](../type-aliases/JsxRuntimeOptions.md) - -JsxRuntimeOptions 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 deleted file mode 100644 index f61a8af132..0000000000 --- a/packages/utilities/kit/docs/@eslint-react/namespaces/JsxRuntimeOptions/type-aliases/JsxRuntimeOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@eslint-react/kit**](../../../../README.md) - -*** - -[@eslint-react/kit](../../../../README.md) / [JsxRuntimeOptions](../README.md) / JsxRuntimeOptions - -# Type Alias: JsxRuntimeOptions - -> **JsxRuntimeOptions** = [`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/README.md b/packages/utilities/kit/docs/README.md index c4116918a1..13f0b152ee 100644 --- 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/JsxRuntimeOptions/JsxRuntimeOptions.ts b/packages/utilities/kit/src/JsxRuntimeConfig/JsxRuntimeConfig.ts similarity index 88% rename from packages/utilities/kit/src/JsxRuntimeOptions/JsxRuntimeOptions.ts rename to packages/utilities/kit/src/JsxRuntimeConfig/JsxRuntimeConfig.ts index 7ba49cc131..bd49b5b76e 100644 --- a/packages/utilities/kit/src/JsxRuntimeOptions/JsxRuntimeOptions.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 new file mode 100644 index 0000000000..6b87285632 --- /dev/null +++ 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 deleted file mode 100644 index dc9752cb31..0000000000 --- a/packages/utilities/kit/src/JsxRuntimeOptions/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./JsxRuntimeOptions"; diff --git a/packages/utilities/kit/src/index.ts b/packages/utilities/kit/src/index.ts index 8524b62460..0fd0940e8c 100644 --- 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";