@coderwyd/eslint-config 2.2.2 → 2.3.1

package/dist/cli.cjs

@@ -46,32 +46,32 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "2.2.2";
+var version = "2.3.1";
 var devDependencies = {
   "@antfu/ni": "^0.21.12",
-  "@types/eslint": "^8.56.5",
+  "@types/eslint": "^8.56.6",
   "@types/fs-extra": "^11.0.4",
-  "@types/node": "^20.11.25",
+  "@types/node": "^20.11.30",
   "@types/prompts": "^2.4.9",
   "@types/yargs": "^17.0.32",
-  "@unocss/eslint-plugin": "^0.58.5",
+  "@unocss/eslint-plugin": "^0.58.7",
   bumpp: "^9.4.0",
-  eslint: "^8.57.0",
-  "eslint-flat-config-viewer": "^0.1.11",
-  "eslint-plugin-react": "^7.34.0",
+  eslint: "9.0.0-rc.0",
+  "eslint-flat-config-viewer": "^0.1.14",
+  "eslint-plugin-react": "^7.34.1",
   "eslint-plugin-react-hooks": "^4.6.0",
-  "eslint-plugin-react-refresh": "^0.4.5",
+  "eslint-plugin-react-refresh": "^0.4.6",
   "eslint-plugin-svelte": "^2.35.1",
   execa: "^8.0.1",
   "fast-glob": "^3.3.2",
   "fs-extra": "^11.2.0",
   "lint-staged": "^15.2.2",
   rimraf: "^5.0.5",
-  "simple-git-hooks": "^2.10.0",
+  "simple-git-hooks": "^2.11.1",
   "svelte-eslint-parser": "^0.33.1",
   tsup: "^8.0.2",
   tsx: "^4.7.1",
-  typescript: "^5.3.3"
+  typescript: "^5.4.3"
 };
 
 // src/cli/constants.ts
@@ -97,7 +97,6 @@ var vscodeSettingsString = `
   // Enable eslint for all supported languages
   "eslint.validate": [
     "svelte",
-    "astro",
     "html",
     "css",
     "less",
@@ -107,7 +106,9 @@ var vscodeSettingsString = `
     "yaml",
     "yml",
     "markdown",
-    "toml"
+    "toml",
+    "gql",
+    "graphql"
   ]
 `;
 

package/dist/cli.js

@@ -17,32 +17,32 @@ import parse from "parse-gitignore";
 import c from "picocolors";
 
 // package.json
-var version = "2.2.2";
+var version = "2.3.1";
 var devDependencies = {
   "@antfu/ni": "^0.21.12",
-  "@types/eslint": "^8.56.5",
+  "@types/eslint": "^8.56.6",
   "@types/fs-extra": "^11.0.4",
-  "@types/node": "^20.11.25",
+  "@types/node": "^20.11.30",
   "@types/prompts": "^2.4.9",
   "@types/yargs": "^17.0.32",
-  "@unocss/eslint-plugin": "^0.58.5",
+  "@unocss/eslint-plugin": "^0.58.7",
   bumpp: "^9.4.0",
-  eslint: "^8.57.0",
-  "eslint-flat-config-viewer": "^0.1.11",
-  "eslint-plugin-react": "^7.34.0",
+  eslint: "9.0.0-rc.0",
+  "eslint-flat-config-viewer": "^0.1.14",
+  "eslint-plugin-react": "^7.34.1",
   "eslint-plugin-react-hooks": "^4.6.0",
-  "eslint-plugin-react-refresh": "^0.4.5",
+  "eslint-plugin-react-refresh": "^0.4.6",
   "eslint-plugin-svelte": "^2.35.1",
   execa: "^8.0.1",
   "fast-glob": "^3.3.2",
   "fs-extra": "^11.2.0",
   "lint-staged": "^15.2.2",
   rimraf: "^5.0.5",
-  "simple-git-hooks": "^2.10.0",
+  "simple-git-hooks": "^2.11.1",
   "svelte-eslint-parser": "^0.33.1",
   tsup: "^8.0.2",
   tsx: "^4.7.1",
-  typescript: "^5.3.3"
+  typescript: "^5.4.3"
 };
 
 // src/cli/constants.ts
@@ -68,7 +68,6 @@ var vscodeSettingsString = `
   // Enable eslint for all supported languages
   "eslint.validate": [
     "svelte",
-    "astro",
     "html",
     "css",
     "less",
@@ -78,7 +77,9 @@ var vscodeSettingsString = `
     "yaml",
     "yml",
     "markdown",
-    "toml"
+    "toml",
+    "gql",
+    "graphql"
   ]
 `;
 

package/dist/index.cjs

@@ -30,7 +30,19 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  defineConfig: () => defineConfig
+  combine: () => combine,
+  defaultPluginRenaming: () => defaultPluginRenaming,
+  defineConfig: () => defineConfig,
+  ensurePackages: () => ensurePackages,
+  getOverrides: () => getOverrides,
+  getVueVersion: () => getVueVersion,
+  interopDefault: () => interopDefault,
+  loadPrettierConfig: () => loadPrettierConfig,
+  parserPlain: () => parserPlain,
+  renamePluginInConfigs: () => renamePluginInConfigs,
+  renameRules: () => renameRules,
+  resolveSubOptions: () => resolveSubOptions,
+  toArray: () => toArray
 });
 module.exports = __toCommonJS(src_exports);
 var import_node_process4 = __toESM(require("process"), 1);
@@ -48,7 +60,7 @@ var DEFAULT_PRETTIER_RULES = {
 // src/plugins/index.ts
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
 var import_eslint_plugin_eslint_comments = __toESM(require("eslint-plugin-eslint-comments"), 1);
-var pluginImport = __toESM(require("eslint-plugin-i"), 1);
+var pluginImport = __toESM(require("eslint-plugin-import-x"), 1);
 var import_eslint_plugin_n = __toESM(require("eslint-plugin-n"), 1);
 var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
 var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-imports"), 1);
@@ -91,7 +103,7 @@ var GLOB_JSONC = "**/*.jsonc";
 var GLOB_MARKDOWN = "**/*.md";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
-var GLOB_GRAPHQL = "**/*.graphql";
+var GLOB_GRAPHQL = "**/*.{g,graph}ql";
 var GLOB_PRETTIER_LINT = [GLOB_SRC, GLOB_VUE];
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
@@ -180,10 +192,7 @@ async function imports() {
         ],
         ...{
           // format
-          "import/newline-after-import": [
-            "error",
-            { considerComments: true, count: 1 }
-          ]
+          "import/newline-after-import": ["error", { count: 1 }]
         }
       }
     },
@@ -488,15 +497,34 @@ async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
 }
-function renameRules(rules, from, to) {
+function renameRules(rules, map) {
   return Object.fromEntries(
     Object.entries(rules).map(([key, value]) => {
-      if (key.startsWith(from))
-        return [to + key.slice(from.length), value];
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`))
+          return [to + key.slice(from.length), value];
+      }
       return [key, value];
     })
   );
 }
+function renamePluginInConfigs(configs, map) {
+  return configs.map((i) => {
+    const clone = { ...i };
+    if (clone.rules)
+      clone.rules = renameRules(clone.rules, map);
+    if (clone.plugins) {
+      clone.plugins = Object.fromEntries(
+        Object.entries(clone.plugins).map(([key, value]) => {
+          if (key in map)
+            return [map[key], value];
+          return [key, value];
+        })
+      );
+    }
+    return clone;
+  });
+}
 function getVueVersion() {
   const pkg = (0, import_local_pkg.getPackageInfoSync)("vue", { paths: [import_node_process.default.cwd()] });
   if (pkg && typeof pkg.version === "string" && !Number.isNaN(+pkg.version[0]))
@@ -754,6 +782,22 @@ async function sortPackageJson() {
           {
             order: ["types", "import", "require", "default"],
             pathPattern: "^exports.*$"
+          },
+          {
+            order: [
+              // client hooks only
+              "pre-commit",
+              "prepare-commit-msg",
+              "commit-msg",
+              "post-commit",
+              "pre-rebase",
+              "post-rewrite",
+              "post-checkout",
+              "post-merge",
+              "pre-push",
+              "pre-auto-gc"
+            ],
+            pathPattern: "^(?:gitHooks|husky|simple-git-hooks)$"
           }
         ]
       }
@@ -991,14 +1035,11 @@ async function typescript(options = {}) {
       rules: {
         ...renameRules(
           pluginTs.configs["eslint-recommended"].overrides[0].rules,
-          "@typescript-eslint/",
-          "ts/"
-        ),
-        ...renameRules(
-          pluginTs.configs.strict.rules,
-          "@typescript-eslint/",
-          "ts/"
+          { "@typescript-eslint": "ts" }
         ),
+        ...renameRules(pluginTs.configs.strict.rules, {
+          "@typescript-eslint": "ts"
+        }),
         "no-dupe-class-members": "off",
         "no-loss-of-precision": "off",
         "no-redeclare": "off",
@@ -1506,12 +1547,19 @@ async function unocss(options = {}) {
 async function formatter(options = {}, prettierRules2 = {}) {
   const {
     css = true,
-    graphql,
+    graphql = false,
     html = true,
-    markdown,
-    toml,
-    yaml
-  } = options || {};
+    markdown = false,
+    toml = false,
+    yaml = false
+  } = typeof options === "object" ? options : {
+    css: true,
+    graphql: true,
+    html: true,
+    markdown: true,
+    toml: true,
+    yaml: true
+  };
   const pluginPrettier = await interopDefault(import("eslint-plugin-prettier"));
   function createPrettierFormatter(files, parser, plugins) {
     const rules = {
@@ -1698,6 +1746,7 @@ async function tailwindcss(options = {}) {
         "tailwindcss/no-arbitrary-value": "off",
         "tailwindcss/no-contradicting-classname": "error",
         "tailwindcss/no-custom-classname": "off",
+        "tailwindcss/no-unnecessary-arbitrary-value": "warn",
         ...overrides
       }
     }
@@ -1725,8 +1774,16 @@ var flatConfigProps = [
   "rules",
   "settings"
 ];
+var defaultPluginRenaming = {
+  "@typescript-eslint": "ts",
+  "import-x": "import",
+  n: "node",
+  vitest: "test",
+  yml: "yaml"
+};
 async function defineConfig(options = {}, ...userConfigs) {
   const {
+    autoRenamePlugins = true,
     componentExts = [],
     gitignore: enableGitignore = true,
     isInEditor: isInEditor2 = isInEditor,
@@ -1850,10 +1907,10 @@ async function defineConfig(options = {}, ...userConfigs) {
     );
     Object.assign(prettierRules2, prettierConfig);
   }
-  configs.push(
-    prettier(prettierRules2),
-    formatter(options.formatter, prettierRules2)
-  );
+  configs.push(prettier(options.formatter ? prettierRules2 : {}));
+  if (options.formatter) {
+    configs.push(formatter(options.formatter, prettierRules2));
+  }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
     if (key in options)
       acc[key] = options[key];
@@ -1861,10 +1918,24 @@ async function defineConfig(options = {}, ...userConfigs) {
   }, {});
   if (Object.keys(fusedConfig).length > 0)
     configs.push([fusedConfig]);
-  const merged = combine(...configs, ...userConfigs);
+  const merged = await combine(...configs, ...userConfigs);
+  if (autoRenamePlugins)
+    return renamePluginInConfigs(merged, defaultPluginRenaming);
   return merged;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  defineConfig
+  combine,
+  defaultPluginRenaming,
+  defineConfig,
+  ensurePackages,
+  getOverrides,
+  getVueVersion,
+  interopDefault,
+  loadPrettierConfig,
+  parserPlain,
+  renamePluginInConfigs,
+  renameRules,
+  resolveSubOptions,
+  toArray
 });

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
-import { RuleConfig, FlatESLintConfigItem, MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, NRules, Prefix, ReactHooksRules, ReactRules, JSDocRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules } from '@antfu/eslint-define-config';
-import { RequiredOptions, LiteralUnion, BuiltInParserName } from 'prettier';
+import { RuleConfig, MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, NRules, Prefix, ReactHooksRules, ReactRules, JSDocRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { BuiltInParserName, RequiredOptions, LiteralUnion } from 'prettier';
 import { Linter } from 'eslint';
 import { Rules } from 'eslint-plugin-antfu';
 
@@ -284,6 +284,44 @@ interface NoCustomClassnameRule {
   'tailwindcss/no-custom-classname': NoCustomClassnameRuleConfig
 }
 
+/**
+ * Option.
+ */
+interface NoUnnecessaryArbitraryValueOption {
+  callees?: string[]
+  ignoredKeys?: string[]
+  config?: string | Record<string, any>
+  tags?: string[]
+
+  [k: string]: any
+}
+
+/**
+ * Options.
+ */
+type NoUnnecessaryArbitraryValueOptions = [
+  NoUnnecessaryArbitraryValueOption?,
+]
+
+/**
+ * Avoid unjustified arbitrary classnames.
+ * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+ */
+type NoUnnecessaryArbitraryValueRuleConfig =
+  RuleConfig<NoUnnecessaryArbitraryValueOptions>
+
+/**
+ * Avoid unjustified arbitrary classnames.
+ * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+ */
+interface NoUnnecessaryArbitraryValueRule {
+  /**
+   * Avoid unjustified arbitrary classnames.
+   * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+   */
+  'tailwindcss/no-unnecessary-arbitrary-value': NoUnnecessaryArbitraryValueRuleConfig
+}
+
 /**
  * All TailwindCss rules.
  */
@@ -293,7 +331,8 @@ type TailwindCssRules = ClassnamesOrderRule &
   MigrationFromTailwind_2Rule &
   NoArbitraryValueRule &
   NoContradictingClassnameRule &
-  NoCustomClassnameRule
+  NoCustomClassnameRule &
+  NoUnnecessaryArbitraryValueRule
 
 type WrapRuleConfig<T extends {
     [key: string]: any;
@@ -318,6 +357,12 @@ type FlatConfigItem = Omit<FlatESLintConfigItem<EslintFlatRules, false>, 'plugin
 type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
 
 type Awaitable<T> = T | Promise<T>;
+interface OptionsFiles {
+    /**
+     * Override the `files` option to provide custom globs.
+     */
+    files?: string[];
+}
 type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
 interface OptionsFormatters {
     /**
@@ -372,6 +417,12 @@ interface OptionsTypeScriptWithTypes {
      */
     tsconfigPath?: string | string[];
 }
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
 interface OptionsOverrides {
     overrides?: FlatConfigItem['rules'];
 }
@@ -487,9 +538,6 @@ interface OptionsConfig extends OptionsComponentExts {
     /**
      * Use external formatters to format files.
      *
-     * Requires installing:
-     * - `eslint-plugin-prettier`
-     *
      * @default
      * {
      *  "html": true,
@@ -499,8 +547,10 @@ interface OptionsConfig extends OptionsComponentExts {
      *  "yaml": false
      *  "toml": false
      * }
+     *
+     * When set to `true`, it will enable all formatters.
      */
-    formatter?: OptionsFormatters;
+    formatter?: boolean | OptionsFormatters;
     /**
      * Default prettier rules
      *
@@ -521,11 +571,107 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default auto-detect based on the process.env
      */
     isInEditor?: boolean;
+    /**
+     * Automatically rename plugins in the config.
+     *
+     * @default true
+     */
+    autoRenamePlugins?: boolean;
 }
-
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+
+declare const parserPlain: {
+    meta: {
+        name: string;
+    };
+    parseForESLint: (code: string) => {
+        ast: {
+            body: never[];
+            comments: never[];
+            loc: {
+                end: number;
+                start: number;
+            };
+            range: number[];
+            tokens: never[];
+            type: string;
+        };
+        scopeManager: null;
+        services: {
+            isPlain: boolean;
+        };
+        visitorKeys: {
+            Program: never[];
+        };
+    };
+};
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+/**
+ * Rename plugin prefixes in a rule object.
+ * Accepts a map of prefixes to rename.
+ *
+ * @example
+ * ```ts
+ * import { renameRules } from '@coderwyd/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+declare function renameRules(rules: Record<string, any>, map: Record<string, string>): {
+    [k: string]: any;
+};
+/**
+ * Rename plugin names a flat configs array
+ *
+ * @example
+ * ```ts
+ * import { renamePluginInConfigs } from '@antfu/eslint-config'
+ * import someConfigs from './some-configs'
+ *
+ * export default renamePluginInConfigs(someConfigs, {
+ *   '@typescript-eslint': 'ts',
+ *   'import-x': 'import',
+ * })
+ * ```
+ */
+declare function renamePluginInConfigs(configs: UserConfigItem[], map: Record<string, string>): UserConfigItem[];
+declare function getVueVersion(): number;
+declare function toArray<T>(value: T | T[]): T[];
+declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
+declare function ensurePackages(packages: string[]): Promise<void>;
+declare function loadPrettierConfig(cwd: string): Promise<Partial<PrettierOptions>>;
+declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
+declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): {};
+
+declare const defaultPluginRenaming: {
+    '@typescript-eslint': string;
+    'import-x': string;
+    n: string;
+    vitest: string;
+    yml: string;
+};
 /**
  * Construct an array of ESLint flat config items.
+ *
+ * @param {OptionsConfig & FlatConfigItem} options
+ *  The options for generating the ESLint configurations.
+ * @param {Awaitable<UserConfigItem | UserConfigItem[]>[]} userConfigs
+ *  The user configurations to be merged with the generated configurations.
+ * @returns {Promise<UserConfigItem[]>}
+ *  The merged ESLint configurations.
  */
 declare function defineConfig(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 
-export { defineConfig };
+export { type Awaitable, type EslintFlatRules, type FlatConfigItem, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnoCSS, type OptionsVue, type PartialPrettierExtendedOptions, type PrettierParser, type ResolvedOptions, type UserConfigItem, type WrapRuleConfig, combine, defaultPluginRenaming, defineConfig, ensurePackages, getOverrides, getVueVersion, interopDefault, loadPrettierConfig, parserPlain, renamePluginInConfigs, renameRules, resolveSubOptions, toArray };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
-import { RuleConfig, FlatESLintConfigItem, MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, NRules, Prefix, ReactHooksRules, ReactRules, JSDocRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules } from '@antfu/eslint-define-config';
-import { RequiredOptions, LiteralUnion, BuiltInParserName } from 'prettier';
+import { RuleConfig, MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, NRules, Prefix, ReactHooksRules, ReactRules, JSDocRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { BuiltInParserName, RequiredOptions, LiteralUnion } from 'prettier';
 import { Linter } from 'eslint';
 import { Rules } from 'eslint-plugin-antfu';
 
@@ -284,6 +284,44 @@ interface NoCustomClassnameRule {
   'tailwindcss/no-custom-classname': NoCustomClassnameRuleConfig
 }
 
+/**
+ * Option.
+ */
+interface NoUnnecessaryArbitraryValueOption {
+  callees?: string[]
+  ignoredKeys?: string[]
+  config?: string | Record<string, any>
+  tags?: string[]
+
+  [k: string]: any
+}
+
+/**
+ * Options.
+ */
+type NoUnnecessaryArbitraryValueOptions = [
+  NoUnnecessaryArbitraryValueOption?,
+]
+
+/**
+ * Avoid unjustified arbitrary classnames.
+ * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+ */
+type NoUnnecessaryArbitraryValueRuleConfig =
+  RuleConfig<NoUnnecessaryArbitraryValueOptions>
+
+/**
+ * Avoid unjustified arbitrary classnames.
+ * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+ */
+interface NoUnnecessaryArbitraryValueRule {
+  /**
+   * Avoid unjustified arbitrary classnames.
+   * @see [no-unnecessary-arbitrary-value](https://github.com/francoismassart/eslint-plugin-tailwindcss/tree/master/docs/rules/no-unnecessary-arbitrary-value.md)
+   */
+  'tailwindcss/no-unnecessary-arbitrary-value': NoUnnecessaryArbitraryValueRuleConfig
+}
+
 /**
  * All TailwindCss rules.
  */
@@ -293,7 +331,8 @@ type TailwindCssRules = ClassnamesOrderRule &
   MigrationFromTailwind_2Rule &
   NoArbitraryValueRule &
   NoContradictingClassnameRule &
-  NoCustomClassnameRule
+  NoCustomClassnameRule &
+  NoUnnecessaryArbitraryValueRule
 
 type WrapRuleConfig<T extends {
     [key: string]: any;
@@ -318,6 +357,12 @@ type FlatConfigItem = Omit<FlatESLintConfigItem<EslintFlatRules, false>, 'plugin
 type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
 
 type Awaitable<T> = T | Promise<T>;
+interface OptionsFiles {
+    /**
+     * Override the `files` option to provide custom globs.
+     */
+    files?: string[];
+}
 type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
 interface OptionsFormatters {
     /**
@@ -372,6 +417,12 @@ interface OptionsTypeScriptWithTypes {
      */
     tsconfigPath?: string | string[];
 }
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
 interface OptionsOverrides {
     overrides?: FlatConfigItem['rules'];
 }
@@ -487,9 +538,6 @@ interface OptionsConfig extends OptionsComponentExts {
     /**
      * Use external formatters to format files.
      *
-     * Requires installing:
-     * - `eslint-plugin-prettier`
-     *
      * @default
      * {
      *  "html": true,
@@ -499,8 +547,10 @@ interface OptionsConfig extends OptionsComponentExts {
      *  "yaml": false
      *  "toml": false
      * }
+     *
+     * When set to `true`, it will enable all formatters.
      */
-    formatter?: OptionsFormatters;
+    formatter?: boolean | OptionsFormatters;
     /**
      * Default prettier rules
      *
@@ -521,11 +571,107 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default auto-detect based on the process.env
      */
     isInEditor?: boolean;
+    /**
+     * Automatically rename plugins in the config.
+     *
+     * @default true
+     */
+    autoRenamePlugins?: boolean;
 }
-
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+
+declare const parserPlain: {
+    meta: {
+        name: string;
+    };
+    parseForESLint: (code: string) => {
+        ast: {
+            body: never[];
+            comments: never[];
+            loc: {
+                end: number;
+                start: number;
+            };
+            range: number[];
+            tokens: never[];
+            type: string;
+        };
+        scopeManager: null;
+        services: {
+            isPlain: boolean;
+        };
+        visitorKeys: {
+            Program: never[];
+        };
+    };
+};
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+/**
+ * Rename plugin prefixes in a rule object.
+ * Accepts a map of prefixes to rename.
+ *
+ * @example
+ * ```ts
+ * import { renameRules } from '@coderwyd/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+declare function renameRules(rules: Record<string, any>, map: Record<string, string>): {
+    [k: string]: any;
+};
+/**
+ * Rename plugin names a flat configs array
+ *
+ * @example
+ * ```ts
+ * import { renamePluginInConfigs } from '@antfu/eslint-config'
+ * import someConfigs from './some-configs'
+ *
+ * export default renamePluginInConfigs(someConfigs, {
+ *   '@typescript-eslint': 'ts',
+ *   'import-x': 'import',
+ * })
+ * ```
+ */
+declare function renamePluginInConfigs(configs: UserConfigItem[], map: Record<string, string>): UserConfigItem[];
+declare function getVueVersion(): number;
+declare function toArray<T>(value: T | T[]): T[];
+declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
+declare function ensurePackages(packages: string[]): Promise<void>;
+declare function loadPrettierConfig(cwd: string): Promise<Partial<PrettierOptions>>;
+declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
+declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): {};
+
+declare const defaultPluginRenaming: {
+    '@typescript-eslint': string;
+    'import-x': string;
+    n: string;
+    vitest: string;
+    yml: string;
+};
 /**
  * Construct an array of ESLint flat config items.
+ *
+ * @param {OptionsConfig & FlatConfigItem} options
+ *  The options for generating the ESLint configurations.
+ * @param {Awaitable<UserConfigItem | UserConfigItem[]>[]} userConfigs
+ *  The user configurations to be merged with the generated configurations.
+ * @returns {Promise<UserConfigItem[]>}
+ *  The merged ESLint configurations.
  */
 declare function defineConfig(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 
-export { defineConfig };
+export { type Awaitable, type EslintFlatRules, type FlatConfigItem, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnoCSS, type OptionsVue, type PartialPrettierExtendedOptions, type PrettierParser, type ResolvedOptions, type UserConfigItem, type WrapRuleConfig, combine, defaultPluginRenaming, defineConfig, ensurePackages, getOverrides, getVueVersion, interopDefault, loadPrettierConfig, parserPlain, renamePluginInConfigs, renameRules, resolveSubOptions, toArray };

package/dist/index.js

@@ -14,7 +14,7 @@ var DEFAULT_PRETTIER_RULES = {
 // src/plugins/index.ts
 import { default as default2 } from "eslint-plugin-antfu";
 import { default as default3 } from "eslint-plugin-eslint-comments";
-import * as pluginImport from "eslint-plugin-i";
+import * as pluginImport from "eslint-plugin-import-x";
 import { default as default4 } from "eslint-plugin-n";
 import { default as default5 } from "eslint-plugin-unicorn";
 import { default as default6 } from "eslint-plugin-unused-imports";
@@ -57,7 +57,7 @@ var GLOB_JSONC = "**/*.jsonc";
 var GLOB_MARKDOWN = "**/*.md";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
-var GLOB_GRAPHQL = "**/*.graphql";
+var GLOB_GRAPHQL = "**/*.{g,graph}ql";
 var GLOB_PRETTIER_LINT = [GLOB_SRC, GLOB_VUE];
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
@@ -146,10 +146,7 @@ async function imports() {
         ],
         ...{
           // format
-          "import/newline-after-import": [
-            "error",
-            { considerComments: true, count: 1 }
-          ]
+          "import/newline-after-import": ["error", { count: 1 }]
         }
       }
     },
@@ -454,15 +451,34 @@ async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
 }
-function renameRules(rules, from, to) {
+function renameRules(rules, map) {
   return Object.fromEntries(
     Object.entries(rules).map(([key, value]) => {
-      if (key.startsWith(from))
-        return [to + key.slice(from.length), value];
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`))
+          return [to + key.slice(from.length), value];
+      }
       return [key, value];
     })
   );
 }
+function renamePluginInConfigs(configs, map) {
+  return configs.map((i) => {
+    const clone = { ...i };
+    if (clone.rules)
+      clone.rules = renameRules(clone.rules, map);
+    if (clone.plugins) {
+      clone.plugins = Object.fromEntries(
+        Object.entries(clone.plugins).map(([key, value]) => {
+          if (key in map)
+            return [map[key], value];
+          return [key, value];
+        })
+      );
+    }
+    return clone;
+  });
+}
 function getVueVersion() {
   const pkg = getPackageInfoSync("vue", { paths: [process.cwd()] });
   if (pkg && typeof pkg.version === "string" && !Number.isNaN(+pkg.version[0]))
@@ -720,6 +736,22 @@ async function sortPackageJson() {
           {
             order: ["types", "import", "require", "default"],
             pathPattern: "^exports.*$"
+          },
+          {
+            order: [
+              // client hooks only
+              "pre-commit",
+              "prepare-commit-msg",
+              "commit-msg",
+              "post-commit",
+              "pre-rebase",
+              "post-rewrite",
+              "post-checkout",
+              "post-merge",
+              "pre-push",
+              "pre-auto-gc"
+            ],
+            pathPattern: "^(?:gitHooks|husky|simple-git-hooks)$"
           }
         ]
       }
@@ -957,14 +989,11 @@ async function typescript(options = {}) {
       rules: {
         ...renameRules(
           pluginTs.configs["eslint-recommended"].overrides[0].rules,
-          "@typescript-eslint/",
-          "ts/"
-        ),
-        ...renameRules(
-          pluginTs.configs.strict.rules,
-          "@typescript-eslint/",
-          "ts/"
+          { "@typescript-eslint": "ts" }
         ),
+        ...renameRules(pluginTs.configs.strict.rules, {
+          "@typescript-eslint": "ts"
+        }),
         "no-dupe-class-members": "off",
         "no-loss-of-precision": "off",
         "no-redeclare": "off",
@@ -1472,12 +1501,19 @@ async function unocss(options = {}) {
 async function formatter(options = {}, prettierRules2 = {}) {
   const {
     css = true,
-    graphql,
+    graphql = false,
     html = true,
-    markdown,
-    toml,
-    yaml
-  } = options || {};
+    markdown = false,
+    toml = false,
+    yaml = false
+  } = typeof options === "object" ? options : {
+    css: true,
+    graphql: true,
+    html: true,
+    markdown: true,
+    toml: true,
+    yaml: true
+  };
   const pluginPrettier = await interopDefault(import("eslint-plugin-prettier"));
   function createPrettierFormatter(files, parser, plugins) {
     const rules = {
@@ -1664,6 +1700,7 @@ async function tailwindcss(options = {}) {
         "tailwindcss/no-arbitrary-value": "off",
         "tailwindcss/no-contradicting-classname": "error",
         "tailwindcss/no-custom-classname": "off",
+        "tailwindcss/no-unnecessary-arbitrary-value": "warn",
         ...overrides
       }
     }
@@ -1691,8 +1728,16 @@ var flatConfigProps = [
   "rules",
   "settings"
 ];
+var defaultPluginRenaming = {
+  "@typescript-eslint": "ts",
+  "import-x": "import",
+  n: "node",
+  vitest: "test",
+  yml: "yaml"
+};
 async function defineConfig(options = {}, ...userConfigs) {
   const {
+    autoRenamePlugins = true,
     componentExts = [],
     gitignore: enableGitignore = true,
     isInEditor: isInEditor2 = isInEditor,
@@ -1816,10 +1861,10 @@ async function defineConfig(options = {}, ...userConfigs) {
     );
     Object.assign(prettierRules2, prettierConfig);
   }
-  configs.push(
-    prettier(prettierRules2),
-    formatter(options.formatter, prettierRules2)
-  );
+  configs.push(prettier(options.formatter ? prettierRules2 : {}));
+  if (options.formatter) {
+    configs.push(formatter(options.formatter, prettierRules2));
+  }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
     if (key in options)
       acc[key] = options[key];
@@ -1827,9 +1872,23 @@ async function defineConfig(options = {}, ...userConfigs) {
   }, {});
   if (Object.keys(fusedConfig).length > 0)
     configs.push([fusedConfig]);
-  const merged = combine(...configs, ...userConfigs);
+  const merged = await combine(...configs, ...userConfigs);
+  if (autoRenamePlugins)
+    return renamePluginInConfigs(merged, defaultPluginRenaming);
   return merged;
 }
 export {
-  defineConfig
+  combine,
+  defaultPluginRenaming,
+  defineConfig,
+  ensurePackages,
+  getOverrides,
+  getVueVersion,
+  interopDefault,
+  loadPrettierConfig,
+  parserPlain,
+  renamePluginInConfigs,
+  renameRules,
+  resolveSubOptions,
+  toArray
 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@coderwyd/eslint-config",
   "type": "module",
-  "version": "2.2.2",
-  "packageManager": "pnpm@8.15.4",
+  "version": "2.3.1",
+  "packageManager": "pnpm@8.15.5",
   "description": "Donny's ESLint config",
   "author": "Donny Wang <donny526@outlook.com> (https://github.com/coderwyd/)",
   "license": "MIT",
@@ -68,29 +68,29 @@
   "dependencies": {
     "@antfu/eslint-define-config": "1.23.0-2",
     "@antfu/install-pkg": "^0.3.1",
-    "@eslint-types/jsdoc": "48.2.0",
-    "@eslint-types/typescript-eslint": "^7.0.2",
+    "@eslint-types/jsdoc": "48.2.1",
+    "@eslint-types/typescript-eslint": "^7.2.0",
     "@eslint-types/unicorn": "^51.0.1",
     "@toml-tools/parser": "^1.0.0",
-    "@typescript-eslint/eslint-plugin": "^7.1.1",
-    "@typescript-eslint/parser": "^7.1.1",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
     "eslint-config-flat-gitignore": "^0.1.3",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-i": "^2.29.1",
+    "eslint-plugin-import-x": "^0.4.4",
     "eslint-plugin-jsdoc": "^48.2.1",
-    "eslint-plugin-jsonc": "^2.13.0",
+    "eslint-plugin-jsonc": "^2.14.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-perfectionist": "^2.6.0",
+    "eslint-plugin-perfectionist": "^2.7.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-tailwindcss": "^3.14.3",
+    "eslint-plugin-tailwindcss": "^3.15.1",
     "eslint-plugin-unicorn": "^51.0.1",
     "eslint-plugin-unused-imports": "^3.1.0",
-    "eslint-plugin-vitest": "^0.3.25",
-    "eslint-plugin-vue": "^9.23.0",
-    "globals": "^14.0.0",
+    "eslint-plugin-vitest": "^0.4.0",
+    "eslint-plugin-vue": "^9.24.0",
+    "globals": "^15.0.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
     "parse-gitignore": "^2.0.0",
@@ -103,29 +103,29 @@
   },
   "devDependencies": {
     "@antfu/ni": "^0.21.12",
-    "@types/eslint": "^8.56.5",
+    "@types/eslint": "^8.56.6",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.25",
+    "@types/node": "^20.11.30",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.32",
-    "@unocss/eslint-plugin": "^0.58.5",
+    "@unocss/eslint-plugin": "^0.58.7",
     "bumpp": "^9.4.0",
-    "eslint": "^8.57.0",
-    "eslint-flat-config-viewer": "^0.1.11",
-    "eslint-plugin-react": "^7.34.0",
+    "eslint": "9.0.0-rc.0",
+    "eslint-flat-config-viewer": "^0.1.14",
+    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.5",
+    "eslint-plugin-react-refresh": "^0.4.6",
     "eslint-plugin-svelte": "^2.35.1",
     "execa": "^8.0.1",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "lint-staged": "^15.2.2",
     "rimraf": "^5.0.5",
-    "simple-git-hooks": "^2.10.0",
+    "simple-git-hooks": "^2.11.1",
     "svelte-eslint-parser": "^0.33.1",
     "tsup": "^8.0.2",
     "tsx": "^4.7.1",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.3"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpx nano-staged"