feat(kit): add LanguagePreference (#1028)

Author: Rel1cx

packages/plugins/eslint-plugin-react-x/src/rules/prefer-react-namespace-import.ts

@@ -43,6 +43,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
         messageId: "preferReactNamespaceImport",
         node: hasOtherSpecifiers ? node : node.parent,
         data: { importSource },
+        // TODO: Use `settings.languagePreference` to determine what code style to use in the fixer (e.g. single or double quotes)
         fix(fixer) {
           const quote = node.parent.source.raw.at(0) ?? "'";
           const isTypeImport = node.parent.importKind === "type";

packages/shared/package.json

@@ -46,7 +46,8 @@
     "@eslint-react/kit": "workspace:*",
     "@typescript-eslint/utils": "^8.29.0",
     "picomatch": "^4.0.2",
-    "ts-pattern": "^5.7.0"
+    "ts-pattern": "^5.7.0",
+    "valibot": "^1.0.0"
   },
   "devDependencies": {
     "@local/configs": "workspace:*",
@@ -55,8 +56,7 @@
     "fast-equals": "^5.2.2",
     "micro-memoize": "^4.1.3",
     "tsup": "^8.4.0",
-    "type-fest": "^4.38.0",
-    "valibot": "^1.0.0"
+    "type-fest": "^4.38.0"
   },
   "engines": {
     "bun": ">=1.0.15",

packages/shared/src/settings.ts

@@ -126,6 +126,6 @@ export const defineSettings: (settings: ESLintReactSettings) => ESLintReactSetti
 
 declare module "@typescript-eslint/utils/ts-eslint" {
   export interface SharedConfigurationSettings {
-    "react-x"?: Partial<ESLintReactSettings>;
+    ["react-x"]?: Partial<ESLintReactSettings>;
   }
 }

packages/utilities/kit/docs/@eslint-react/namespaces/LanguagePreference/README.md

@@ -0,0 +1,11 @@
+[**@eslint-react/kit**](../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../README.md) / LanguagePreference
+
+# LanguagePreference
+
+## Variables
+
+- [DEFAULT\_LANGUAGE\_PREFERENCE](variables/DEFAULT_LANGUAGE_PREFERENCE.md)

packages/utilities/kit/docs/@eslint-react/namespaces/LanguagePreference/variables/DEFAULT_LANGUAGE_PREFERENCE.md

@@ -0,0 +1,53 @@
+[**@eslint-react/kit**](../../../../README.md)
+
+***
+
+[@eslint-react/kit](../../../../README.md) / [LanguagePreference](../README.md) / DEFAULT\_LANGUAGE\_PREFERENCE
+
+# Variable: DEFAULT\_LANGUAGE\_PREFERENCE
+
+> `const` **DEFAULT\_LANGUAGE\_PREFERENCE**: `object`
+
+The default language preference.
+
+## Type declaration
+
+### bracketSameLine
+
+> **bracketSameLine**: `boolean`
+
+### bracketSpacing
+
+> **bracketSpacing**: `boolean`
+
+### endOfLine
+
+> **endOfLine**: `"lf"` \| `"crlf"` \| `"cr"` \| `"auto"`
+
+### indentStyle
+
+> **indentStyle**: `"tab"` \| `"space"`
+
+### indentWidth
+
+> **indentWidth**: `number`
+
+### insertFinalNewline
+
+> **insertFinalNewline**: `boolean`
+
+### jsxQuoteStyle
+
+> **jsxQuoteStyle**: `"preferDouble"` \| `"preferSingle"`
+
+### quoteStyle
+
+> **quoteStyle**: `"preferDouble"` \| `"preferSingle"` \| `"alwaysDouble"` \| `"alwaysSingle"`
+
+### semicolon
+
+> **semicolon**: `"always"` \| `"prefer"` \| `"asi"`
+
+### trailingComma
+
+> **trailingComma**: `"all"` \| `"es5"` \| `"none"`

packages/utilities/kit/docs/README.md

@@ -7,6 +7,7 @@
 ## Namespaces
 
 - [JsxRuntime](@eslint-react/namespaces/JsxRuntime/README.md)
+- [LanguagePreference](@eslint-react/namespaces/LanguagePreference/README.md)
 
 ## Type Aliases
 

packages/utilities/kit/package.json

@@ -44,7 +44,8 @@
   "dependencies": {
     "@eslint-react/eff": "workspace:*",
     "@typescript-eslint/utils": "^8.29.0",
-    "ts-pattern": "^5.7.0"
+    "ts-pattern": "^5.7.0",
+    "valibot": "^1.0.0"
   },
   "devDependencies": {
     "@local/configs": "workspace:*",

packages/utilities/kit/src/LanguagePreference/LanguagePreference.ts

@@ -0,0 +1,20 @@
+import type { SharedConfigurationSettings } from "@typescript-eslint/utils/ts-eslint"; // eslint-disable-line @typescript-eslint/no-unused-vars
+import { type InferOutput, parse } from "valibot";
+import { LanguagePreferenceSchema } from "./LanguagePreferenceSchema";
+
+/**
+ * @internal
+ */
+export type LanguagePreference = InferOutput<typeof LanguagePreferenceSchema>;
+
+/**
+ * The default language preference.
+ */
+export const DEFAULT_LANGUAGE_PREFERENCE = parse(LanguagePreferenceSchema, {});
+
+declare module "@typescript-eslint/utils/ts-eslint" {
+  export interface SharedConfigurationSettings {
+    // eslint-disable-next-line no-restricted-syntax
+    languagePreference?: Partial<LanguagePreference>;
+  }
+}

packages/utilities/kit/src/LanguagePreference/LanguagePreferenceSchema.ts

@@ -0,0 +1,59 @@
+import { boolean, literal, number, object, optional, union } from "valibot";
+
+/**
+ * @internal
+ */
+export const LanguagePreferenceSchema = object({
+  bracketSameLine: optional(boolean(), false),
+  bracketSpacing: optional(boolean(), true),
+  endOfLine: optional(
+    union([
+      literal("lf"),
+      literal("crlf"),
+      literal("cr"),
+      literal("auto"),
+    ]),
+    "lf",
+  ),
+  indentStyle: optional(
+    union([
+      literal("tab"),
+      literal("space"),
+    ]),
+    "space",
+  ),
+  indentWidth: optional(number(), 2),
+  insertFinalNewline: optional(boolean(), true),
+  jsxQuoteStyle: optional(
+    union([
+      literal("preferDouble"),
+      literal("preferSingle"),
+    ]),
+    "preferDouble",
+  ),
+  quoteStyle: optional(
+    union([
+      literal("alwaysDouble"),
+      literal("alwaysSingle"),
+      literal("preferDouble"),
+      literal("preferSingle"),
+    ]),
+    "preferSingle",
+  ),
+  semicolon: optional(
+    union([
+      literal("always"),
+      literal("prefer"),
+      literal("asi"),
+    ]),
+    "always",
+  ),
+  trailingComma: optional(
+    union([
+      literal("all"),
+      literal("es5"),
+      literal("none"),
+    ]),
+    "all",
+  ),
+});

packages/utilities/kit/src/LanguagePreference/index.ts

@@ -0,0 +1,2 @@
+export * from "./LanguagePreference";
+export * from "./LanguagePreferenceSchema";