@lincy/eslint-config 3.5.1 → 3.6.0

package/README.md

@@ -148,6 +148,8 @@ export default lincy({
     test: false, // 默认值: true, 可选: false
     // 是否启用 markdown 规则
     markdown: false, // 默认值: true, 可选: false
+    // 是否启用 eslint-plugin-sort-keys 规则
+    sortKeys: true, // 默认值: false, 可选: true
     // 覆盖规则
     overrides: {},
 
@@ -219,6 +221,7 @@ import {
     jsonc,
     markdown,
     node,
+    sortKeys,
     sortPackageJson,
     sortTsconfig,
     stylistic,
@@ -229,12 +232,15 @@ import {
 } from '@lincy/eslint-config'
 
 export default [
+    ...comments(),
     ...ignores(),
+    ...imports(),
     ...javascript(),
-    ...comments(),
-    ...node(),
     ...jsdoc(),
-    ...imports(),
+    ...node(),
+    ...sortKeys(),
+    ...sortPackageJson(),
+    ...sortTsconfig(),
     ...unicorn(),
 
     ...typescript(),
@@ -290,6 +296,7 @@ export default lincy(
         jsonc: true,
         yaml: true,
         markdown: true,
+        sortKeys: true,
         overrides: {}
     },
     {
@@ -358,6 +365,7 @@ import lincy from '@lincy/eslint-config'
 export default lincy({
     typescript: {
         tsconfigPath: 'tsconfig.json',
+        // tsconfigPath: ['tsconfig.json'], // 也可以是数组
     },
 })
 ```

package/dist/index.cjs

@@ -74,6 +74,7 @@ __export(src_exports, {
   pluginMarkdown: () => import_eslint_plugin_markdown.default,
   pluginNoOnlyTests: () => import_eslint_plugin_no_only_tests.default,
   pluginNode: () => import_eslint_plugin_n.default,
+  pluginSortKeys: () => import_eslint_plugin_sort_keys.default,
   pluginStylistic: () => import_eslint_plugin.default,
   pluginTs: () => import_eslint_plugin2.default,
   pluginUnicorn: () => import_eslint_plugin_unicorn.default,
@@ -81,10 +82,12 @@ __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,
@@ -113,6 +116,7 @@ var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-
 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 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);
@@ -1040,14 +1044,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",
@@ -1070,6 +1076,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.
@@ -1087,9 +1094,10 @@ function typescript(options) {
       languageOptions: {
         parser: parserTs,
         parserOptions: {
+          extraFileExtensions: componentExts.map((ext) => `.${ext}`),
           sourceType: "module",
           ...tsconfigPath ? {
-            project: [tsconfigPath],
+            project: tsconfigPath,
             tsconfigRootDir: import_node_process.default.cwd()
           } : {},
           ...parserOptions
@@ -1411,6 +1419,17 @@ function test(options = {}) {
   ];
 }
 
+// src/configs/sort-keys.ts
+function sortKeys() {
+  return [
+    {
+      plugins: {
+        "sort-keys": import_eslint_plugin_sort_keys.default
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -1434,6 +1453,7 @@ function lincy(options = {}, ...userConfigs) {
     vue: enableVue = VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i)),
     typescript: enableTypeScript = (0, import_local_pkg2.isPackageExists)("typescript"),
     gitignore: enableGitignore = true,
+    sortKeys: enableSortKeys = false,
     overrides = {},
     componentExts = []
   } = options;
@@ -1467,6 +1487,8 @@ function lincy(options = {}, ...userConfigs) {
     }),
     unicorn()
   );
+  if (enableSortKeys)
+    configs.push(sortKeys());
   if (enableVue)
     componentExts.push("vue");
   if (enableTypeScript) {
@@ -1578,6 +1600,7 @@ var src_default = lincy;
   pluginMarkdown,
   pluginNoOnlyTests,
   pluginNode,
+  pluginSortKeys,
   pluginStylistic,
   pluginTs,
   pluginUnicorn,
@@ -1585,10 +1608,12 @@ var src_default = lincy;
   pluginVue,
   pluginYaml,
   renameRules,
+  sortKeys,
   sortPackageJson,
   sortTsconfig,
   stylistic,
   test,
+  toArray,
   typescript,
   unicorn,
   vue,

package/dist/index.d.cts

@@ -21,6 +21,7 @@ export { default as pluginVue } from 'eslint-plugin-vue';
 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 parserVue } from 'vue-eslint-parser';
 export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
@@ -63,7 +64,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;
@@ -105,7 +106,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean | OptionsTypeScriptWithTypes;
+    typescript?: boolean | OptionsTypeScriptWithTypes | OptionsTypeScriptParserOptions;
     /**
      * Enable JSX related rules.
      *
@@ -144,6 +145,12 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     markdown?: boolean;
+    /**
+     * Enable SortKeys support.
+     *
+     * @default false
+     */
+    sortKeys?: boolean;
     /**
      * Enable stylistic rules.
      *
@@ -217,6 +224,13 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): ConfigItem
 
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
 
+/**
+ * Optional sort-keys plugin
+ *
+ * @see https://github.com/namnm/eslint-plugin-sort-keys
+ */
+declare function sortKeys(): ConfigItem[];
+
 /**
  * Combine array and non-array configs into a single array.
  */
@@ -224,6 +238,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)";
@@ -247,4 +262,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, 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, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, renameRules, sortKeys, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, vue, yaml };

package/dist/index.d.ts

@@ -21,6 +21,7 @@ export { default as pluginVue } from 'eslint-plugin-vue';
 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 parserVue } from 'vue-eslint-parser';
 export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
@@ -63,7 +64,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;
@@ -105,7 +106,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean | OptionsTypeScriptWithTypes;
+    typescript?: boolean | OptionsTypeScriptWithTypes | OptionsTypeScriptParserOptions;
     /**
      * Enable JSX related rules.
      *
@@ -144,6 +145,12 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     markdown?: boolean;
+    /**
+     * Enable SortKeys support.
+     *
+     * @default false
+     */
+    sortKeys?: boolean;
     /**
      * Enable stylistic rules.
      *
@@ -217,6 +224,13 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): ConfigItem
 
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
 
+/**
+ * Optional sort-keys plugin
+ *
+ * @see https://github.com/namnm/eslint-plugin-sort-keys
+ */
+declare function sortKeys(): ConfigItem[];
+
 /**
  * Combine array and non-array configs into a single array.
  */
@@ -224,6 +238,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)";
@@ -247,4 +262,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, 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, combine, comments, lincy as default, ignores, imports, javascript, jsdoc, jsonc, lincy, markdown, node, renameRules, sortKeys, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, vue, yaml };

package/dist/index.js

@@ -19,10 +19,11 @@ import { default as default10 } from "eslint-plugin-unused-imports";
 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 * as parserTs from "@typescript-eslint/parser";
-import { default as default13 } from "vue-eslint-parser";
-import { default as default14 } from "yaml-eslint-parser";
-import { default as default15 } from "jsonc-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";
 
 // src/configs/comments.ts
 function comments() {
@@ -415,7 +416,7 @@ function jsonc(options = {}) {
     {
       files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
       languageOptions: {
-        parser: default15
+        parser: default16
       },
       rules: {
         "jsonc/no-bigint-literals": "error",
@@ -946,14 +947,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",
@@ -976,6 +979,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.
@@ -993,9 +997,10 @@ function typescript(options) {
       languageOptions: {
         parser: parserTs,
         parserOptions: {
+          extraFileExtensions: componentExts.map((ext) => `.${ext}`),
           sourceType: "module",
           ...tsconfigPath ? {
-            project: [tsconfigPath],
+            project: tsconfigPath,
             tsconfigRootDir: process.cwd()
           } : {},
           ...parserOptions
@@ -1137,7 +1142,7 @@ function vue(options = {}) {
     {
       files: [GLOB_VUE],
       languageOptions: {
-        parser: default13,
+        parser: default14,
         parserOptions: {
           ecmaFeatures: {
             jsx: true
@@ -1265,7 +1270,7 @@ function yaml(options = {}) {
     {
       files: [GLOB_YAML],
       languageOptions: {
-        parser: default14
+        parser: default15
       },
       rules: {
         "style/spaced-comment": "off",
@@ -1317,6 +1322,17 @@ function test(options = {}) {
   ];
 }
 
+// src/configs/sort-keys.ts
+function sortKeys() {
+  return [
+    {
+      plugins: {
+        "sort-keys": default13
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -1340,6 +1356,7 @@ function lincy(options = {}, ...userConfigs) {
     vue: enableVue = VuePackages.some((i) => isPackageExists(i)),
     typescript: enableTypeScript = isPackageExists("typescript"),
     gitignore: enableGitignore = true,
+    sortKeys: enableSortKeys = false,
     overrides = {},
     componentExts = []
   } = options;
@@ -1373,6 +1390,8 @@ function lincy(options = {}, ...userConfigs) {
     }),
     unicorn()
   );
+  if (enableSortKeys)
+    configs.push(sortKeys());
   if (enableVue)
     componentExts.push("vue");
   if (enableTypeScript) {
@@ -1472,10 +1491,10 @@ export {
   lincy,
   markdown,
   node,
-  default15 as parserJsonc,
+  default16 as parserJsonc,
   parserTs,
-  default13 as parserVue,
-  default14 as parserYaml,
+  default14 as parserVue,
+  default15 as parserYaml,
   default2 as pluginAntfu,
   default3 as pluginComments,
   pluginImport,
@@ -1484,6 +1503,7 @@ export {
   default5 as pluginMarkdown,
   default12 as pluginNoOnlyTests,
   default6 as pluginNode,
+  default13 as pluginSortKeys,
   default7 as pluginStylistic,
   default8 as pluginTs,
   default9 as pluginUnicorn,
@@ -1491,10 +1511,12 @@ 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.1",
+  "version": "3.6.0",
   "packageManager": "pnpm@8.7.6",
   "description": "LinCenYing's ESLint config",
   "author": "LinCenYing <lincenying@gmail.com> (https://github.com/lincenying/)",
@@ -39,26 +39,27 @@
     "eslint": ">=8.0.0"
   },
   "dependencies": {
-    "@antfu/eslint-define-config": "^1.23.0-1",
-    "@stylistic/eslint-plugin": "0.0.8",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "@typescript-eslint/parser": "^6.7.5",
-    "eslint-config-flat-gitignore": "^0.1.0",
-    "eslint-plugin-antfu": "^1.0.0-beta.12",
+    "@antfu/eslint-define-config": "1.23.0-2",
+    "@stylistic/eslint-plugin": "0.1.2",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "eslint-config-flat-gitignore": "^0.1.1",
+    "eslint-plugin-antfu": "^1.0.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-i": "^2.28.1",
+    "eslint-plugin-i": "^2.29.0",
     "eslint-plugin-jsdoc": "^46.8.2",
     "eslint-plugin-jsonc": "^2.10.0",
     "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-n": "^16.2.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-unicorn": "^48.0.1",
+    "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.2",
-    "eslint-plugin-vue": "^9.17.0",
+    "eslint-plugin-vitest": "^0.3.8",
+    "eslint-plugin-vue": "^9.18.1",
     "eslint-plugin-yml": "^1.10.0",
     "globals": "^13.23.0",
-    "jsonc-eslint-parser": "^2.3.0",
+    "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
     "vue-eslint-parser": "^9.3.2",
     "yaml-eslint-parser": "^1.2.2"
@@ -66,15 +67,14 @@
   "devDependencies": {
     "@antfu/ni": "^0.21.8",
     "@lincy/eslint-config": "workspace:*",
-    "@stylistic/eslint-plugin-migrate": "^0.0.8",
-    "@types/eslint": "^8.44.4",
-    "@types/node": "^20.8.4",
+    "@stylistic/eslint-plugin-migrate": "^0.1.2",
+    "@types/eslint": "^8.44.6",
+    "@types/node": "^20.8.10",
     "bumpp": "^9.2.0",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.0",
     "eslint-flat-config-viewer": "^0.1.0",
-    "eslint-plugin-sort-keys": "^2.3.5",
     "esno": "^0.17.0",
-    "lint-staged": "^14.0.1",
+    "lint-staged": "^15.0.2",
     "rimraf": "^5.0.5",
     "simple-git-hooks": "^2.9.0",
     "simple-open-url": "^3.0.1",