@lincy/eslint-config 3.5.2 → 3.7.0

package/README.md

@@ -133,9 +133,9 @@ export default lincy({
     // 是否启用 stylistic 格式化规则
     stylistic: true, // 默认值: true, 可选: false | { indent: number | 'tab', quotes: 'single' | 'double', jsx: boolean}
     // 是否启用 typescript 规则
-    typescript: true, // 默认值: 检测是否安装typescript依赖, 可选: false
+    typescript: true, // 默认值: 检测是否安装typescript依赖, 可选: false | true
     // 是否启用 vue 规则
-    vue: true, // 默认值: 检测是否安装vue依赖, 可选: false
+    vue: true, // 默认值: 检测是否安装vue依赖, 可选: false | true
     // 是否启用 jsx 规则
     jsx: true, // 默认值: true, 可选: false
     // 是否启用 jsonc 规则
@@ -148,8 +148,6 @@ export default lincy({
     test: false, // 默认值: true, 可选: false
     // 是否启用 markdown 规则
     markdown: false, // 默认值: true, 可选: false
-    // 是否启用 eslint-plugin-sort-keys 规则
-    sortKeys: true, // 默认值: false, 可选: true
     // 覆盖规则
     overrides: {},
 
@@ -203,7 +201,9 @@ export default lincy(
     // 你还可以继续配置多个 ESLint Flat Configs
     {
         files: ['**/*.ts'],
-        rules: {},
+        rules: {
+            'perfectionist/sort-objects': 'error',
+        },
     },
 )
 ```
@@ -221,7 +221,7 @@ import {
     jsonc,
     markdown,
     node,
-    sortKeys,
+    perfectionist,
     sortPackageJson,
     sortTsconfig,
     stylistic,
@@ -232,20 +232,16 @@ import {
 } from '@lincy/eslint-config'
 
 export default [
-    ...comments(),
     ...ignores(),
-    ...imports(),
-    ...javascript(),
-    ...jsdoc(),
+    ...javascript(/* Options */),
+    ...comments(),
     ...node(),
-    ...sortKeys(),
-    ...sortPackageJson(),
-    ...sortTsconfig(),
+    ...jsdoc(),
+    ...imports(),
     ...unicorn(),
-
-    ...typescript(),
+    ...perfectionist(),
+    ...typescript(/* Options */),
     ...stylistic(),
-
     ...vue(),
     ...jsonc(),
     ...yaml(),
@@ -296,7 +292,6 @@ export default lincy(
         jsonc: true,
         yaml: true,
         markdown: true,
-        sortKeys: true,
         overrides: {}
     },
     {
@@ -354,6 +349,24 @@ export default lincy({
 })
 ```
 
+#### `perfectionist` (sorting)
+
+这个插件 [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) 允许你排序对象键名，导入，自动修复等。
+
+安装了插件，但默认情况下没有启用任何规则。
+
+建议使用[configuration comments]单独选择每个文件。(https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1).
+
+```js
+/* eslint perfectionist/sort-objects: "error" */
+const objectWantedToSort = {
+    a: 2,
+    b: 1,
+    c: 3,
+}
+/* eslint perfectionist/sort-objects: "off" */
+```
+
 ### 类型感知规则
 
 您可以选择通过将选项对象传递给“typescript”配置来启用[类型感知规则](https://typescript-eslint.io/linting/typed-linting/)：
@@ -365,6 +378,7 @@ import lincy from '@lincy/eslint-config'
 export default lincy({
     typescript: {
         tsconfigPath: 'tsconfig.json',
+        // tsconfigPath: ['tsconfig.json'], // 也可以是数组
     },
 })
 ```

package/dist/index.cjs

@@ -66,6 +66,7 @@ __export(src_exports, {
   parserTs: () => parserTs,
   parserVue: () => import_vue_eslint_parser.default,
   parserYaml: () => import_yaml_eslint_parser.default,
+  perfectionist: () => perfectionist,
   pluginAntfu: () => import_eslint_plugin_antfu.default,
   pluginComments: () => import_eslint_plugin_eslint_comments.default,
   pluginImport: () => pluginImport,
@@ -74,6 +75,7 @@ __export(src_exports, {
   pluginMarkdown: () => import_eslint_plugin_markdown.default,
   pluginNoOnlyTests: () => import_eslint_plugin_no_only_tests.default,
   pluginNode: () => import_eslint_plugin_n.default,
+  pluginPerfectionist: () => import_eslint_plugin_perfectionist.default,
   pluginSortKeys: () => import_eslint_plugin_sort_keys.default,
   pluginStylistic: () => import_eslint_plugin.default,
   pluginTs: () => import_eslint_plugin2.default,
@@ -82,11 +84,11 @@ __export(src_exports, {
   pluginVue: () => import_eslint_plugin_vue.default,
   pluginYaml: () => pluginYaml,
   renameRules: () => renameRules,
-  sortKeys: () => sortKeys,
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
   stylistic: () => stylistic,
   test: () => test,
+  toArray: () => toArray,
   typescript: () => typescript,
   unicorn: () => unicorn,
   vue: () => vue,
@@ -116,6 +118,7 @@ var import_eslint_plugin_vue = __toESM(require("eslint-plugin-vue"), 1);
 var pluginYaml = __toESM(require("eslint-plugin-yml"), 1);
 var import_eslint_plugin_no_only_tests = __toESM(require("eslint-plugin-no-only-tests"), 1);
 var import_eslint_plugin_sort_keys = __toESM(require("eslint-plugin-sort-keys"), 1);
+var import_eslint_plugin_perfectionist = __toESM(require("eslint-plugin-perfectionist"), 1);
 var parserTs = __toESM(require("@typescript-eslint/parser"), 1);
 var import_vue_eslint_parser = __toESM(require("vue-eslint-parser"), 1);
 var import_yaml_eslint_parser = __toESM(require("yaml-eslint-parser"), 1);
@@ -280,7 +283,6 @@ function javascript(options = {}) {
         "accessor-pairs": ["error", { enforceForClassMembers: true, setWithoutGet: true }],
         "antfu/top-level-function": "error",
         "array-callback-return": "error",
-        "arrow-parens": ["error", "as-needed", { requireForBlockBody: true }],
         "block-scoped-var": "error",
         "constructor-super": "error",
         "default-case-last": "error",
@@ -439,6 +441,7 @@ function javascript(options = {}) {
             memberSyntaxSortOrder: ["none", "all", "multiple", "single"]
           }
         ],
+        "style/arrow-parens": ["error", "as-needed", { requireForBlockBody: true }],
         "symbol-description": "error",
         "unicode-bom": ["error", "never"],
         "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
@@ -500,8 +503,8 @@ function jsdoc(options = {}) {
 // src/configs/jsonc.ts
 function jsonc(options = {}) {
   const {
-    stylistic: stylistic2 = true,
-    overrides = {}
+    overrides = {},
+    stylistic: stylistic2 = true
   } = options;
   return [
     {
@@ -876,8 +879,8 @@ function stylistic(options = {}) {
   } = options;
   const {
     indent = 4,
-    quotes = "single",
-    jsx = true
+    jsx = true,
+    quotes = "single"
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
   return [
     {
@@ -903,14 +906,9 @@ function stylistic(options = {}) {
         "style/indent": ["error", indent, {
           ArrayExpression: 1,
           CallExpression: { arguments: 1 },
+          flatTernaryExpressions: false,
           FunctionDeclaration: { body: 1, parameters: 1 },
           FunctionExpression: { body: 1, parameters: 1 },
-          ImportDeclaration: 1,
-          MemberExpression: 1,
-          ObjectExpression: 1,
-          SwitchCase: 1,
-          VariableDeclarator: 1,
-          flatTernaryExpressions: false,
           ignoreComments: false,
           ignoredNodes: [
             "TemplateLiteral *",
@@ -935,8 +933,13 @@ function stylistic(options = {}) {
             "FunctionExpression > .params > :matches(Decorator, :not(:first-child))",
             "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
           ],
+          ImportDeclaration: 1,
+          MemberExpression: 1,
+          ObjectExpression: 1,
           offsetTernaryExpressions: true,
-          outerIIFEBody: 1
+          outerIIFEBody: 1,
+          SwitchCase: 1,
+          VariableDeclarator: 1
         }],
         "style/key-spacing": ["error", { afterColon: true, beforeColon: false }],
         "style/keyword-spacing": ["error", { after: true, before: true }],
@@ -1032,7 +1035,7 @@ var import_node_process = __toESM(require("process"), 1);
 
 // src/utils.ts
 function combine(...configs) {
-  return configs.flatMap((config) => Array.isArray(config) ? config : [config]);
+  return configs.flat();
 }
 function renameRules(rules, from, to) {
   return Object.fromEntries(
@@ -1043,14 +1046,16 @@ function renameRules(rules, from, to) {
     })
   );
 }
+function toArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
 
 // src/configs/typescript.ts
 function typescript(options) {
   const {
     componentExts = [],
     overrides = {},
-    parserOptions = {},
-    tsconfigPath
+    parserOptions = {}
   } = options ?? {};
   const typeAwareRules = {
     "dot-notation": "off",
@@ -1073,6 +1078,7 @@ function typescript(options) {
     "ts/restrict-template-expressions": "error",
     "ts/unbound-method": "error"
   };
+  const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
   return [
     {
       // Install the plugins without globs, so they can be configured separately.
@@ -1093,7 +1099,7 @@ function typescript(options) {
           extraFileExtensions: componentExts.map((ext) => `.${ext}`),
           sourceType: "module",
           ...tsconfigPath ? {
-            project: [tsconfigPath],
+            project: tsconfigPath,
             tsconfigRootDir: import_node_process.default.cwd()
           } : {},
           ...parserOptions
@@ -1415,12 +1421,12 @@ function test(options = {}) {
   ];
 }
 
-// src/configs/sort-keys.ts
-function sortKeys() {
+// src/configs/perfectionist.ts
+function perfectionist() {
   return [
     {
       plugins: {
-        "sort-keys": import_eslint_plugin_sort_keys.default
+        perfectionist: import_eslint_plugin_perfectionist.default
       }
     }
   ];
@@ -1445,13 +1451,12 @@ var VuePackages = [
 ];
 function lincy(options = {}, ...userConfigs) {
   const {
-    isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE) && !import_node_process2.default.env.CI),
-    vue: enableVue = VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i)),
-    typescript: enableTypeScript = (0, import_local_pkg2.isPackageExists)("typescript"),
+    componentExts = [],
     gitignore: enableGitignore = true,
-    sortKeys: enableSortKeys = false,
+    isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE) && !import_node_process2.default.env.CI),
     overrides = {},
-    componentExts = []
+    typescript: enableTypeScript = (0, import_local_pkg2.isPackageExists)("typescript"),
+    vue: enableVue = VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i))
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions))
@@ -1481,10 +1486,10 @@ function lincy(options = {}, ...userConfigs) {
     imports({
       stylistic: stylisticOptions
     }),
-    unicorn()
+    unicorn(),
+    // Optional plugins (installed but not enabled by default)
+    perfectionist()
   );
-  if (enableSortKeys)
-    configs.push(sortKeys());
   if (enableVue)
     componentExts.push("vue");
   if (enableTypeScript) {
@@ -1588,6 +1593,7 @@ var src_default = lincy;
   parserTs,
   parserVue,
   parserYaml,
+  perfectionist,
   pluginAntfu,
   pluginComments,
   pluginImport,
@@ -1596,6 +1602,7 @@ var src_default = lincy;
   pluginMarkdown,
   pluginNoOnlyTests,
   pluginNode,
+  pluginPerfectionist,
   pluginSortKeys,
   pluginStylistic,
   pluginTs,
@@ -1604,11 +1611,11 @@ var src_default = lincy;
   pluginVue,
   pluginYaml,
   renameRules,
-  sortKeys,
   sortPackageJson,
   sortTsconfig,
   stylistic,
   test,
+  toArray,
   typescript,
   unicorn,
   vue,

package/dist/index.d.cts

@@ -2,9 +2,14 @@ import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
 import * as parser from '@typescript-eslint/parser';
 export { parser as parserTs };
-import { MergeIntersection, EslintRules, Unprefix, ReactRules, TypeScriptRules, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ImportRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, RuleConfig, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { RuleConfig, MergeIntersection, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ImportRules, EslintRules, JsoncRules, VueRules, EslintCommentsRules, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { RuleOptions as RuleOptions$1 } from '@eslint-types/jsdoc/types';
+import { RuleOptions } from '@eslint-types/typescript-eslint/types';
+import { RuleOptions as RuleOptions$2 } from '@eslint-types/unicorn/types';
 import { Rules as Rules$1 } from 'eslint-plugin-antfu';
 export { default as pluginAntfu } from 'eslint-plugin-antfu';
+import { UnprefixedRuleOptions } from '@stylistic/eslint-plugin';
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
 import * as eslintPluginI from 'eslint-plugin-i';
 export { eslintPluginI as pluginImport };
@@ -13,7 +18,6 @@ import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
 export { eslintPluginJsonc as pluginJsonc };
 export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginNode } from 'eslint-plugin-n';
-export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
@@ -22,16 +26,19 @@ import * as eslintPluginYml from 'eslint-plugin-yml';
 export { eslintPluginYml as pluginYaml };
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
 export { default as pluginSortKeys } from 'eslint-plugin-sort-keys';
+export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as parserVue } from 'vue-eslint-parser';
 export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
 
-type MergedRules = MergeIntersection<EslintRules & Unprefix<ReactRules, 'react/'> & Unprefix<TypeScriptRules, '@typescript-eslint/'>>;
-type StylisticRules = Pick<MergedRules, 'array-bracket-newline' | 'array-bracket-spacing' | 'array-element-newline' | 'arrow-spacing' | 'block-spacing' | 'brace-style' | 'comma-dangle' | 'comma-spacing' | 'comma-style' | 'computed-property-spacing' | 'dot-location' | 'eol-last' | 'func-call-spacing' | 'function-call-argument-newline' | 'function-paren-newline' | 'generator-star-spacing' | 'implicit-arrow-linebreak' | 'indent' | 'jsx-quotes' | 'key-spacing' | 'keyword-spacing' | 'linebreak-style' | 'lines-around-comment' | 'lines-around-directive' | 'lines-between-class-members' | 'max-len' | 'max-statements-per-line' | 'multiline-ternary' | 'new-parens' | 'newline-after-var' | 'newline-before-return' | 'newline-per-chained-call' | 'no-confusing-arrow' | 'no-extra-parens' | 'no-extra-semi' | 'no-floating-decimal' | 'no-mixed-operators' | 'no-mixed-spaces-and-tabs' | 'no-multi-spaces' | 'no-multiple-empty-lines' | 'no-spaced-func' | 'no-tabs' | 'no-trailing-spaces' | 'no-whitespace-before-property' | 'nonblock-statement-body-position' | 'object-curly-newline' | 'object-curly-spacing' | 'object-property-newline' | 'one-var-declaration-per-line' | 'operator-linebreak' | 'padded-blocks' | 'padding-line-between-statements' | 'quote-props' | 'quotes' | 'rest-spread-spacing' | 'semi' | 'semi-spacing' | 'semi-style' | 'space-before-blocks' | 'space-before-function-paren' | 'space-in-parens' | 'space-infix-ops' | 'space-unary-ops' | 'spaced-comment' | 'switch-colon-spacing' | 'template-curly-spacing' | 'template-tag-spacing' | 'wrap-iife' | 'wrap-regex' | 'yield-star-spacing' | 'block-spacing' | 'brace-style' | 'comma-dangle' | 'comma-spacing' | 'func-call-spacing' | 'indent' | 'key-spacing' | 'keyword-spacing' | 'lines-around-comment' | 'lines-between-class-members' | 'member-delimiter-style' | 'object-curly-spacing' | 'padding-line-between-statements' | 'quotes' | 'semi' | 'space-before-blocks' | 'space-before-function-paren' | 'space-infix-ops' | 'type-annotation-spacing'>;
-
-type Rules = MergeIntersection<RenamePrefix<TypeScriptRules, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<StylisticRules, 'style/'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & UnicornRules & EslintCommentsRules & {
+type WrapRuleConfig<T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
+};
+type Rules = WrapRuleConfig<MergeIntersection<RenamePrefix<RuleOptions, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, 'style/'> & Prefix<Rules$1, 'antfu/'> & RuleOptions$1 & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$2 & EslintCommentsRules & {
     'test/no-only-tests': RuleConfig<[]>;
-}>;
+}>>;
 type ConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     /**
      * Custom name of each config item
@@ -64,7 +71,7 @@ interface OptionsTypeScriptWithTypes {
      * When this options is provided, type aware rules will be enabled.
      * @see https://typescript-eslint.io/linting/typed-linting/
      */
-    tsconfigPath?: string;
+    tsconfigPath?: string | string[];
 }
 interface OptionsHasTypeScript {
     typescript?: boolean;
@@ -145,12 +152,6 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     markdown?: boolean;
-    /**
-     * Enable SortKeys support.
-     *
-     * @default false
-     */
-    sortKeys?: boolean;
     /**
      * Enable stylistic rules.
      *
@@ -225,11 +226,11 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): ConfigItem
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
 
 /**
- * Optional sort-keys plugin
+ * Optional perfectionist plugin for props and items sorting.
  *
- * @see https://github.com/namnm/eslint-plugin-sort-keys
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function sortKeys(): ConfigItem[];
+declare function perfectionist(): ConfigItem[];
 
 /**
  * Combine array and non-array configs into a single array.
@@ -238,6 +239,7 @@ declare function combine(...configs: (ConfigItem | ConfigItem[])[]): ConfigItem[
 declare function renameRules(rules: Record<string, any>, from: string, to: string): {
     [k: string]: any;
 };
+declare function toArray<T>(value: T | T[]): T[];
 
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -261,4 +263,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, StylisticOverridesConfig, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, renameRules, sortKeys, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };
+export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, StylisticOverridesConfig, WrapRuleConfig, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, vue, yaml };

package/dist/index.d.ts

@@ -2,9 +2,14 @@ import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
 import * as parser from '@typescript-eslint/parser';
 export { parser as parserTs };
-import { MergeIntersection, EslintRules, Unprefix, ReactRules, TypeScriptRules, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ImportRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, RuleConfig, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { RuleConfig, MergeIntersection, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ImportRules, EslintRules, JsoncRules, VueRules, EslintCommentsRules, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { RuleOptions as RuleOptions$1 } from '@eslint-types/jsdoc/types';
+import { RuleOptions } from '@eslint-types/typescript-eslint/types';
+import { RuleOptions as RuleOptions$2 } from '@eslint-types/unicorn/types';
 import { Rules as Rules$1 } from 'eslint-plugin-antfu';
 export { default as pluginAntfu } from 'eslint-plugin-antfu';
+import { UnprefixedRuleOptions } from '@stylistic/eslint-plugin';
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
 import * as eslintPluginI from 'eslint-plugin-i';
 export { eslintPluginI as pluginImport };
@@ -13,7 +18,6 @@ import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
 export { eslintPluginJsonc as pluginJsonc };
 export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginNode } from 'eslint-plugin-n';
-export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
@@ -22,16 +26,19 @@ import * as eslintPluginYml from 'eslint-plugin-yml';
 export { eslintPluginYml as pluginYaml };
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
 export { default as pluginSortKeys } from 'eslint-plugin-sort-keys';
+export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as parserVue } from 'vue-eslint-parser';
 export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
 
-type MergedRules = MergeIntersection<EslintRules & Unprefix<ReactRules, 'react/'> & Unprefix<TypeScriptRules, '@typescript-eslint/'>>;
-type StylisticRules = Pick<MergedRules, 'array-bracket-newline' | 'array-bracket-spacing' | 'array-element-newline' | 'arrow-spacing' | 'block-spacing' | 'brace-style' | 'comma-dangle' | 'comma-spacing' | 'comma-style' | 'computed-property-spacing' | 'dot-location' | 'eol-last' | 'func-call-spacing' | 'function-call-argument-newline' | 'function-paren-newline' | 'generator-star-spacing' | 'implicit-arrow-linebreak' | 'indent' | 'jsx-quotes' | 'key-spacing' | 'keyword-spacing' | 'linebreak-style' | 'lines-around-comment' | 'lines-around-directive' | 'lines-between-class-members' | 'max-len' | 'max-statements-per-line' | 'multiline-ternary' | 'new-parens' | 'newline-after-var' | 'newline-before-return' | 'newline-per-chained-call' | 'no-confusing-arrow' | 'no-extra-parens' | 'no-extra-semi' | 'no-floating-decimal' | 'no-mixed-operators' | 'no-mixed-spaces-and-tabs' | 'no-multi-spaces' | 'no-multiple-empty-lines' | 'no-spaced-func' | 'no-tabs' | 'no-trailing-spaces' | 'no-whitespace-before-property' | 'nonblock-statement-body-position' | 'object-curly-newline' | 'object-curly-spacing' | 'object-property-newline' | 'one-var-declaration-per-line' | 'operator-linebreak' | 'padded-blocks' | 'padding-line-between-statements' | 'quote-props' | 'quotes' | 'rest-spread-spacing' | 'semi' | 'semi-spacing' | 'semi-style' | 'space-before-blocks' | 'space-before-function-paren' | 'space-in-parens' | 'space-infix-ops' | 'space-unary-ops' | 'spaced-comment' | 'switch-colon-spacing' | 'template-curly-spacing' | 'template-tag-spacing' | 'wrap-iife' | 'wrap-regex' | 'yield-star-spacing' | 'block-spacing' | 'brace-style' | 'comma-dangle' | 'comma-spacing' | 'func-call-spacing' | 'indent' | 'key-spacing' | 'keyword-spacing' | 'lines-around-comment' | 'lines-between-class-members' | 'member-delimiter-style' | 'object-curly-spacing' | 'padding-line-between-statements' | 'quotes' | 'semi' | 'space-before-blocks' | 'space-before-function-paren' | 'space-infix-ops' | 'type-annotation-spacing'>;
-
-type Rules = MergeIntersection<RenamePrefix<TypeScriptRules, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<StylisticRules, 'style/'> & Prefix<Rules$1, 'antfu/'> & ImportRules & EslintRules & JsoncRules & VueRules & UnicornRules & EslintCommentsRules & {
+type WrapRuleConfig<T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
+};
+type Rules = WrapRuleConfig<MergeIntersection<RenamePrefix<RuleOptions, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, 'style/'> & Prefix<Rules$1, 'antfu/'> & RuleOptions$1 & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$2 & EslintCommentsRules & {
     'test/no-only-tests': RuleConfig<[]>;
-}>;
+}>>;
 type ConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     /**
      * Custom name of each config item
@@ -64,7 +71,7 @@ interface OptionsTypeScriptWithTypes {
      * When this options is provided, type aware rules will be enabled.
      * @see https://typescript-eslint.io/linting/typed-linting/
      */
-    tsconfigPath?: string;
+    tsconfigPath?: string | string[];
 }
 interface OptionsHasTypeScript {
     typescript?: boolean;
@@ -145,12 +152,6 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     markdown?: boolean;
-    /**
-     * Enable SortKeys support.
-     *
-     * @default false
-     */
-    sortKeys?: boolean;
     /**
      * Enable stylistic rules.
      *
@@ -225,11 +226,11 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): ConfigItem
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
 
 /**
- * Optional sort-keys plugin
+ * Optional perfectionist plugin for props and items sorting.
  *
- * @see https://github.com/namnm/eslint-plugin-sort-keys
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function sortKeys(): ConfigItem[];
+declare function perfectionist(): ConfigItem[];
 
 /**
  * Combine array and non-array configs into a single array.
@@ -238,6 +239,7 @@ declare function combine(...configs: (ConfigItem | ConfigItem[])[]): ConfigItem[
 declare function renameRules(rules: Record<string, any>, from: string, to: string): {
     [k: string]: any;
 };
+declare function toArray<T>(value: T | T[]): T[];
 
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -261,4 +263,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, StylisticOverridesConfig, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, renameRules, sortKeys, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };
+export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, StylisticOverridesConfig, WrapRuleConfig, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, vue, yaml };

package/dist/index.js

@@ -20,10 +20,11 @@ import { default as default11 } from "eslint-plugin-vue";
 import * as pluginYaml from "eslint-plugin-yml";
 import { default as default12 } from "eslint-plugin-no-only-tests";
 import { default as default13 } from "eslint-plugin-sort-keys";
+import { default as default14 } from "eslint-plugin-perfectionist";
 import * as parserTs from "@typescript-eslint/parser";
-import { default as default14 } from "vue-eslint-parser";
-import { default as default15 } from "yaml-eslint-parser";
-import { default as default16 } from "jsonc-eslint-parser";
+import { default as default15 } from "vue-eslint-parser";
+import { default as default16 } from "yaml-eslint-parser";
+import { default as default17 } from "jsonc-eslint-parser";
 
 // src/configs/comments.ts
 function comments() {
@@ -184,7 +185,6 @@ function javascript(options = {}) {
         "accessor-pairs": ["error", { enforceForClassMembers: true, setWithoutGet: true }],
         "antfu/top-level-function": "error",
         "array-callback-return": "error",
-        "arrow-parens": ["error", "as-needed", { requireForBlockBody: true }],
         "block-scoped-var": "error",
         "constructor-super": "error",
         "default-case-last": "error",
@@ -343,6 +343,7 @@ function javascript(options = {}) {
             memberSyntaxSortOrder: ["none", "all", "multiple", "single"]
           }
         ],
+        "style/arrow-parens": ["error", "as-needed", { requireForBlockBody: true }],
         "symbol-description": "error",
         "unicode-bom": ["error", "never"],
         "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
@@ -404,8 +405,8 @@ function jsdoc(options = {}) {
 // src/configs/jsonc.ts
 function jsonc(options = {}) {
   const {
-    stylistic: stylistic2 = true,
-    overrides = {}
+    overrides = {},
+    stylistic: stylistic2 = true
   } = options;
   return [
     {
@@ -416,7 +417,7 @@ function jsonc(options = {}) {
     {
       files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
       languageOptions: {
-        parser: default16
+        parser: default17
       },
       rules: {
         "jsonc/no-bigint-literals": "error",
@@ -780,8 +781,8 @@ function stylistic(options = {}) {
   } = options;
   const {
     indent = 4,
-    quotes = "single",
-    jsx = true
+    jsx = true,
+    quotes = "single"
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
   return [
     {
@@ -807,14 +808,9 @@ function stylistic(options = {}) {
         "style/indent": ["error", indent, {
           ArrayExpression: 1,
           CallExpression: { arguments: 1 },
+          flatTernaryExpressions: false,
           FunctionDeclaration: { body: 1, parameters: 1 },
           FunctionExpression: { body: 1, parameters: 1 },
-          ImportDeclaration: 1,
-          MemberExpression: 1,
-          ObjectExpression: 1,
-          SwitchCase: 1,
-          VariableDeclarator: 1,
-          flatTernaryExpressions: false,
           ignoreComments: false,
           ignoredNodes: [
             "TemplateLiteral *",
@@ -839,8 +835,13 @@ function stylistic(options = {}) {
             "FunctionExpression > .params > :matches(Decorator, :not(:first-child))",
             "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
           ],
+          ImportDeclaration: 1,
+          MemberExpression: 1,
+          ObjectExpression: 1,
           offsetTernaryExpressions: true,
-          outerIIFEBody: 1
+          outerIIFEBody: 1,
+          SwitchCase: 1,
+          VariableDeclarator: 1
         }],
         "style/key-spacing": ["error", { afterColon: true, beforeColon: false }],
         "style/keyword-spacing": ["error", { after: true, before: true }],
@@ -936,7 +937,7 @@ import process from "process";
 
 // src/utils.ts
 function combine(...configs) {
-  return configs.flatMap((config) => Array.isArray(config) ? config : [config]);
+  return configs.flat();
 }
 function renameRules(rules, from, to) {
   return Object.fromEntries(
@@ -947,14 +948,16 @@ function renameRules(rules, from, to) {
     })
   );
 }
+function toArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
 
 // src/configs/typescript.ts
 function typescript(options) {
   const {
     componentExts = [],
     overrides = {},
-    parserOptions = {},
-    tsconfigPath
+    parserOptions = {}
   } = options ?? {};
   const typeAwareRules = {
     "dot-notation": "off",
@@ -977,6 +980,7 @@ function typescript(options) {
     "ts/restrict-template-expressions": "error",
     "ts/unbound-method": "error"
   };
+  const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
   return [
     {
       // Install the plugins without globs, so they can be configured separately.
@@ -997,7 +1001,7 @@ function typescript(options) {
           extraFileExtensions: componentExts.map((ext) => `.${ext}`),
           sourceType: "module",
           ...tsconfigPath ? {
-            project: [tsconfigPath],
+            project: tsconfigPath,
             tsconfigRootDir: process.cwd()
           } : {},
           ...parserOptions
@@ -1139,7 +1143,7 @@ function vue(options = {}) {
     {
       files: [GLOB_VUE],
       languageOptions: {
-        parser: default14,
+        parser: default15,
         parserOptions: {
           ecmaFeatures: {
             jsx: true
@@ -1267,7 +1271,7 @@ function yaml(options = {}) {
     {
       files: [GLOB_YAML],
       languageOptions: {
-        parser: default15
+        parser: default16
       },
       rules: {
         "style/spaced-comment": "off",
@@ -1319,12 +1323,12 @@ function test(options = {}) {
   ];
 }
 
-// src/configs/sort-keys.ts
-function sortKeys() {
+// src/configs/perfectionist.ts
+function perfectionist() {
   return [
     {
       plugins: {
-        "sort-keys": default13
+        perfectionist: default14
       }
     }
   ];
@@ -1349,13 +1353,12 @@ var VuePackages = [
 ];
 function lincy(options = {}, ...userConfigs) {
   const {
-    isInEditor = !!((process2.env.VSCODE_PID || process2.env.JETBRAINS_IDE) && !process2.env.CI),
-    vue: enableVue = VuePackages.some((i) => isPackageExists(i)),
-    typescript: enableTypeScript = isPackageExists("typescript"),
+    componentExts = [],
     gitignore: enableGitignore = true,
-    sortKeys: enableSortKeys = false,
+    isInEditor = !!((process2.env.VSCODE_PID || process2.env.JETBRAINS_IDE) && !process2.env.CI),
     overrides = {},
-    componentExts = []
+    typescript: enableTypeScript = isPackageExists("typescript"),
+    vue: enableVue = VuePackages.some((i) => isPackageExists(i))
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions))
@@ -1385,10 +1388,10 @@ function lincy(options = {}, ...userConfigs) {
     imports({
       stylistic: stylisticOptions
     }),
-    unicorn()
+    unicorn(),
+    // Optional plugins (installed but not enabled by default)
+    perfectionist()
   );
-  if (enableSortKeys)
-    configs.push(sortKeys());
   if (enableVue)
     componentExts.push("vue");
   if (enableTypeScript) {
@@ -1488,10 +1491,11 @@ export {
   lincy,
   markdown,
   node,
-  default16 as parserJsonc,
+  default17 as parserJsonc,
   parserTs,
-  default14 as parserVue,
-  default15 as parserYaml,
+  default15 as parserVue,
+  default16 as parserYaml,
+  perfectionist,
   default2 as pluginAntfu,
   default3 as pluginComments,
   pluginImport,
@@ -1500,6 +1504,7 @@ export {
   default5 as pluginMarkdown,
   default12 as pluginNoOnlyTests,
   default6 as pluginNode,
+  default14 as pluginPerfectionist,
   default13 as pluginSortKeys,
   default7 as pluginStylistic,
   default8 as pluginTs,
@@ -1508,11 +1513,11 @@ export {
   default11 as pluginVue,
   pluginYaml,
   renameRules,
-  sortKeys,
   sortPackageJson,
   sortTsconfig,
   stylistic,
   test,
+  toArray,
   typescript,
   unicorn,
   vue,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lincy/eslint-config",
   "type": "module",
-  "version": "3.5.2",
+  "version": "3.7.0",
   "packageManager": "pnpm@8.7.6",
   "description": "LinCenYing's ESLint config",
   "author": "LinCenYing <lincenying@gmail.com> (https://github.com/lincenying/)",
@@ -26,13 +26,13 @@
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --shims --clean --dts",
     "stub": "tsup src/index.ts --format esm",
-    "lint": "pnpm run stub && eslint .",
-    "lint:fix": "eslint . --fix",
     "postpublish": "simple-open-url https://npmmirror.com/package/@lincy/eslint-config",
     "prepublishOnly": "nr build",
     "release": "bumpp && npm publish -r --access public",
     "test": "vitest",
-    "typecheck": "tsc --noEmit",
+    "lint": "pnpm run stub && eslint .",
+    "lint:fix": "eslint . --fix",
+    "lint:ts": "tsc --noEmit",
     "prepare": "sh simple-git-hooks.sh"
   },
   "peerDependencies": {
@@ -40,22 +40,23 @@
   },
   "dependencies": {
     "@antfu/eslint-define-config": "1.23.0-2",
-    "@stylistic/eslint-plugin": "0.1.2",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
+    "@stylistic/eslint-plugin": "1.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "eslint-config-flat-gitignore": "^0.1.1",
-    "eslint-plugin-antfu": "^1.0.1",
+    "eslint-plugin-antfu": "^1.0.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-i": "^2.29.0",
-    "eslint-plugin-jsdoc": "^46.8.2",
+    "eslint-plugin-jsdoc": "^46.9.0",
     "eslint-plugin-jsonc": "^2.10.0",
     "eslint-plugin-markdown": "^3.0.1",
-    "eslint-plugin-n": "^16.2.0",
+    "eslint-plugin-n": "^16.3.1",
     "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-perfectionist": "^2.3.0",
     "eslint-plugin-sort-keys": "^2.3.5",
     "eslint-plugin-unicorn": "^49.0.0",
     "eslint-plugin-unused-imports": "^3.0.0",
-    "eslint-plugin-vitest": "^0.3.8",
+    "eslint-plugin-vitest": "^0.3.9",
     "eslint-plugin-vue": "^9.18.1",
     "eslint-plugin-yml": "^1.10.0",
     "globals": "^13.23.0",
@@ -65,16 +66,19 @@
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "@antfu/ni": "^0.21.8",
+    "@antfu/ni": "^0.21.9",
+    "@eslint-types/jsdoc": "46.8.2-1",
+    "@eslint-types/typescript-eslint": "^6.9.1",
+    "@eslint-types/unicorn": "^49.0.0",
     "@lincy/eslint-config": "workspace:*",
-    "@stylistic/eslint-plugin-migrate": "^0.1.2",
-    "@types/eslint": "^8.44.6",
-    "@types/node": "^20.8.9",
+    "@stylistic/eslint-plugin-migrate": "^1.2.0",
+    "@types/eslint": "^8.44.7",
+    "@types/node": "^20.9.0",
     "bumpp": "^9.2.0",
-    "eslint": "^8.52.0",
-    "eslint-flat-config-viewer": "^0.1.0",
-    "esno": "^0.17.0",
-    "lint-staged": "^15.0.2",
+    "eslint": "^8.53.0",
+    "eslint-flat-config-viewer": "^0.1.1",
+    "esno": "^4.0.0",
+    "lint-staged": "^15.1.0",
     "rimraf": "^5.0.5",
     "simple-git-hooks": "^2.9.0",
     "simple-open-url": "^3.0.1",