@lincy/eslint-config 5.1.1 → 5.2.0

package/README.md

@@ -261,6 +261,27 @@ export default lincy({
         unocss: {
             // unocss 规则
         },
+        comments: {
+            // comments 规则
+        },
+        imports: {
+            // imports 规则
+        },
+        jsdoc: {
+            // jsdoc 规则
+        },
+        node: {
+            // node 规则
+        },
+        perfectionist: {
+            // perfectionist 规则
+        },
+        sort: {
+            // sort 规则
+        },
+        unicorn: {
+            // unicorn 规则
+        },
         regexp: {
             // regexp 规则
         }
@@ -325,11 +346,14 @@ export default lincy(
 import {
     combine,
     comments,
+    disables,
+    formatters,
     ignores,
     imports,
     javascript,
     jsdoc,
     jsonc,
+    jsx,
     markdown,
     node,
     perfectionist,
@@ -338,6 +362,7 @@ import {
     sortPackageJson,
     sortTsconfig,
     stylistic,
+    test,
     toml,
     typescript,
     unicorn,
@@ -350,6 +375,8 @@ export default combine(
     ignores(),
     javascript(/* Options */),
     comments(),
+    disables(),
+    formatters(),
     node(),
     jsdoc(),
     imports(),
@@ -361,8 +388,10 @@ export default combine(
     react(/* Options */),
     unocss(/* Options */),
     jsonc(),
+    jsx(),
     yaml(),
     toml(),
+    test(),
     markdown(),
     regexp(),
 )

package/dist/index.cjs

@@ -117,7 +117,10 @@ var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
 var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-imports"), 1);
 
 // src/configs/comments.ts
-async function comments() {
+async function comments(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/comments/rules",
@@ -128,7 +131,8 @@ async function comments() {
         "eslint-comments/no-aggregating-enable": "error",
         "eslint-comments/no-duplicate-disable": "error",
         "eslint-comments/no-unlimited-disable": "error",
-        "eslint-comments/no-unused-enable": "error"
+        "eslint-comments/no-unused-enable": "error",
+        ...overrides
       }
     }
   ];
@@ -628,6 +632,7 @@ async function ignores(options = {}) {
 // src/configs/imports.ts
 async function imports(options = {}) {
   const {
+    overrides = {},
     stylistic: stylistic2 = true
   } = options;
   return [
@@ -649,7 +654,8 @@ async function imports(options = {}) {
         "import/no-webpack-loader-syntax": "error",
         ...stylistic2 ? {
           "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
-        } : {}
+        } : {},
+        ...overrides
       }
     }
   ];
@@ -864,6 +870,7 @@ async function javascript(options = {}) {
 // src/configs/jsdoc.ts
 async function jsdoc(options = {}) {
   const {
+    overrides = {},
     stylistic: stylistic2 = true
   } = options;
   return [
@@ -891,7 +898,8 @@ async function jsdoc(options = {}) {
         ...stylistic2 ? {
           "jsdoc/check-alignment": "warn",
           "jsdoc/multiline-blocks": "warn"
-        } : {}
+        } : {},
+        ...overrides
       }
     }
   ];
@@ -1081,7 +1089,10 @@ async function markdown(options = {}) {
 }
 
 // src/configs/node.ts
-async function node() {
+async function node(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/node/rules",
@@ -1096,14 +1107,18 @@ async function node() {
         "node/no-path-concat": "error",
         "node/prefer-global/buffer": ["error", "never"],
         "node/prefer-global/process": ["error", "never"],
-        "node/process-exit-as-throw": "error"
+        "node/process-exit-as-throw": "error",
+        ...overrides
       }
     }
   ];
 }
 
 // src/configs/perfectionist.ts
-async function perfectionist() {
+async function perfectionist(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/perfectionist/setup",
@@ -1115,10 +1130,10 @@ async function perfectionist() {
         "perfectionist/sort-imports": ["error", {
           groups: [
             "type",
-            ["parent-type", "sibling-type", "index-type"],
+            ["parent-type", "sibling-type", "index-type", "internal-type"],
             "builtin",
             "external",
-            ["internal", "internal-type"],
+            ["internal"],
             ["parent", "sibling", "index"],
             "side-effect",
             "object",
@@ -1129,7 +1144,8 @@ async function perfectionist() {
           type: "natural"
         }],
         "perfectionist/sort-named-exports": ["error", { order: "asc", type: "natural" }],
-        "perfectionist/sort-named-imports": ["error", { order: "asc", type: "natural" }]
+        "perfectionist/sort-named-imports": ["error", { order: "asc", type: "natural" }],
+        ...overrides
       }
     }
   ];
@@ -1801,7 +1817,8 @@ async function unicorn(options = {}) {
           "unicorn/prefer-string-starts-ends-with": "error",
           "unicorn/prefer-type-error": "error",
           "unicorn/throw-new-error": "error"
-        }
+        },
+        ...options.overrides
       }
     }
   ];
@@ -2156,19 +2173,30 @@ function lincy(options = {}, ...userConfigs) {
       isInEditor,
       overrides: overrides.javascript
     }),
-    comments(),
-    node(),
+    comments({
+      overrides: overrides.comments
+    }),
+    node({
+      overrides: overrides.node
+    }),
     jsdoc({
+      overrides: overrides.jsdoc,
       stylistic: stylisticOptions
     }),
     imports({
+      overrides: overrides.imports,
       stylistic: stylisticOptions
     }),
     // Optional plugins (installed but not enabled by default)
-    perfectionist()
+    perfectionist({
+      overrides: overrides.perfectionist
+    })
   );
   if (enableUnicorn) {
-    configs2.push(unicorn(enableUnicorn === true ? {} : enableUnicorn));
+    configs2.push(unicorn({
+      ...enableUnicorn === true ? {} : enableUnicorn,
+      overrides: overrides.unicorn
+    }));
   }
   if (enableVue) {
     componentExts.push("vue");

package/dist/index.d.cts

@@ -14665,6 +14665,12 @@ interface OptionsConfig extends OptionsComponentExts, OptionsProjectType {
         yaml?: TypedFlatConfigItem['rules'];
         toml?: TypedFlatConfigItem['rules'];
         unocss?: TypedFlatConfigItem['rules'];
+        perfectionist?: TypedFlatConfigItem['rules'];
+        unicorn?: TypedFlatConfigItem['rules'];
+        comments?: TypedFlatConfigItem['rules'];
+        node?: TypedFlatConfigItem['rules'];
+        imports?: TypedFlatConfigItem['rules'];
+        jsdoc?: TypedFlatConfigItem['rules'];
         ignores?: string[];
     };
 }
@@ -14686,7 +14692,7 @@ declare const defaultPluginRenaming: {
  */
 declare function lincy(options?: OptionsConfig & Omit<TypedFlatConfigItem, 'files'>, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]): FlatConfigComposer<TypedFlatConfigItem>;
 
-declare function comments(): Promise<TypedFlatConfigItem[]>;
+declare function comments(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function disables(): Promise<TypedFlatConfigItem[]>;
 
@@ -14694,11 +14700,11 @@ declare function formatters(options?: OptionsFormatters | true, stylistic?: Styl
 
 declare function ignores(options?: OptionsIgnores): Promise<TypedFlatConfigItem[]>;
 
-declare function imports(options?: OptionsStylistic): Promise<TypedFlatConfigItem[]>;
+declare function imports(options?: OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
-declare function jsdoc(options?: OptionsStylistic): Promise<TypedFlatConfigItem[]>;
+declare function jsdoc(options?: OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
@@ -14706,14 +14712,14 @@ declare function jsx(): Promise<TypedFlatConfigItem[]>;
 
 declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
-declare function node(): Promise<TypedFlatConfigItem[]>;
+declare function node(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 /**
  * Optional perfectionist plugin for props and items sorting.
  *
  * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function perfectionist(): Promise<TypedFlatConfigItem[]>;
+declare function perfectionist(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function react(options?: OptionsFiles & OptionsReact & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
@@ -14741,7 +14747,7 @@ declare function toml(options?: OptionsOverrides & OptionsStylistic & OptionsFil
 
 declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsProjectType): Promise<TypedFlatConfigItem[]>;
 
-declare function unicorn(options?: OptionsUnicorn): Promise<TypedFlatConfigItem[]>;
+declare function unicorn(options?: OptionsUnicorn & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function unocss(options?: OptionsUnoCSS & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 

package/dist/index.d.ts

@@ -14665,6 +14665,12 @@ interface OptionsConfig extends OptionsComponentExts, OptionsProjectType {
         yaml?: TypedFlatConfigItem['rules'];
         toml?: TypedFlatConfigItem['rules'];
         unocss?: TypedFlatConfigItem['rules'];
+        perfectionist?: TypedFlatConfigItem['rules'];
+        unicorn?: TypedFlatConfigItem['rules'];
+        comments?: TypedFlatConfigItem['rules'];
+        node?: TypedFlatConfigItem['rules'];
+        imports?: TypedFlatConfigItem['rules'];
+        jsdoc?: TypedFlatConfigItem['rules'];
         ignores?: string[];
     };
 }
@@ -14686,7 +14692,7 @@ declare const defaultPluginRenaming: {
  */
 declare function lincy(options?: OptionsConfig & Omit<TypedFlatConfigItem, 'files'>, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]): FlatConfigComposer<TypedFlatConfigItem>;
 
-declare function comments(): Promise<TypedFlatConfigItem[]>;
+declare function comments(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function disables(): Promise<TypedFlatConfigItem[]>;
 
@@ -14694,11 +14700,11 @@ declare function formatters(options?: OptionsFormatters | true, stylistic?: Styl
 
 declare function ignores(options?: OptionsIgnores): Promise<TypedFlatConfigItem[]>;
 
-declare function imports(options?: OptionsStylistic): Promise<TypedFlatConfigItem[]>;
+declare function imports(options?: OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
-declare function jsdoc(options?: OptionsStylistic): Promise<TypedFlatConfigItem[]>;
+declare function jsdoc(options?: OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
@@ -14706,14 +14712,14 @@ declare function jsx(): Promise<TypedFlatConfigItem[]>;
 
 declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
-declare function node(): Promise<TypedFlatConfigItem[]>;
+declare function node(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 /**
  * Optional perfectionist plugin for props and items sorting.
  *
  * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function perfectionist(): Promise<TypedFlatConfigItem[]>;
+declare function perfectionist(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function react(options?: OptionsFiles & OptionsReact & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
@@ -14741,7 +14747,7 @@ declare function toml(options?: OptionsOverrides & OptionsStylistic & OptionsFil
 
 declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsProjectType): Promise<TypedFlatConfigItem[]>;
 
-declare function unicorn(options?: OptionsUnicorn): Promise<TypedFlatConfigItem[]>;
+declare function unicorn(options?: OptionsUnicorn & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 
 declare function unocss(options?: OptionsUnoCSS & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 

package/dist/index.js

@@ -12,7 +12,10 @@ import { default as default6 } from "eslint-plugin-unicorn";
 import { default as default7 } from "eslint-plugin-unused-imports";
 
 // src/configs/comments.ts
-async function comments() {
+async function comments(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/comments/rules",
@@ -23,7 +26,8 @@ async function comments() {
         "eslint-comments/no-aggregating-enable": "error",
         "eslint-comments/no-duplicate-disable": "error",
         "eslint-comments/no-unlimited-disable": "error",
-        "eslint-comments/no-unused-enable": "error"
+        "eslint-comments/no-unused-enable": "error",
+        ...overrides
       }
     }
   ];
@@ -523,6 +527,7 @@ async function ignores(options = {}) {
 // src/configs/imports.ts
 async function imports(options = {}) {
   const {
+    overrides = {},
     stylistic: stylistic2 = true
   } = options;
   return [
@@ -544,7 +549,8 @@ async function imports(options = {}) {
         "import/no-webpack-loader-syntax": "error",
         ...stylistic2 ? {
           "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
-        } : {}
+        } : {},
+        ...overrides
       }
     }
   ];
@@ -759,6 +765,7 @@ async function javascript(options = {}) {
 // src/configs/jsdoc.ts
 async function jsdoc(options = {}) {
   const {
+    overrides = {},
     stylistic: stylistic2 = true
   } = options;
   return [
@@ -786,7 +793,8 @@ async function jsdoc(options = {}) {
         ...stylistic2 ? {
           "jsdoc/check-alignment": "warn",
           "jsdoc/multiline-blocks": "warn"
-        } : {}
+        } : {},
+        ...overrides
       }
     }
   ];
@@ -976,7 +984,10 @@ async function markdown(options = {}) {
 }
 
 // src/configs/node.ts
-async function node() {
+async function node(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/node/rules",
@@ -991,14 +1002,18 @@ async function node() {
         "node/no-path-concat": "error",
         "node/prefer-global/buffer": ["error", "never"],
         "node/prefer-global/process": ["error", "never"],
-        "node/process-exit-as-throw": "error"
+        "node/process-exit-as-throw": "error",
+        ...overrides
       }
     }
   ];
 }
 
 // src/configs/perfectionist.ts
-async function perfectionist() {
+async function perfectionist(options = {}) {
+  const {
+    overrides = {}
+  } = options;
   return [
     {
       name: "eslint/perfectionist/setup",
@@ -1010,10 +1025,10 @@ async function perfectionist() {
         "perfectionist/sort-imports": ["error", {
           groups: [
             "type",
-            ["parent-type", "sibling-type", "index-type"],
+            ["parent-type", "sibling-type", "index-type", "internal-type"],
             "builtin",
             "external",
-            ["internal", "internal-type"],
+            ["internal"],
             ["parent", "sibling", "index"],
             "side-effect",
             "object",
@@ -1024,7 +1039,8 @@ async function perfectionist() {
           type: "natural"
         }],
         "perfectionist/sort-named-exports": ["error", { order: "asc", type: "natural" }],
-        "perfectionist/sort-named-imports": ["error", { order: "asc", type: "natural" }]
+        "perfectionist/sort-named-imports": ["error", { order: "asc", type: "natural" }],
+        ...overrides
       }
     }
   ];
@@ -1696,7 +1712,8 @@ async function unicorn(options = {}) {
           "unicorn/prefer-string-starts-ends-with": "error",
           "unicorn/prefer-type-error": "error",
           "unicorn/throw-new-error": "error"
-        }
+        },
+        ...options.overrides
       }
     }
   ];
@@ -2051,19 +2068,30 @@ function lincy(options = {}, ...userConfigs) {
       isInEditor,
       overrides: overrides.javascript
     }),
-    comments(),
-    node(),
+    comments({
+      overrides: overrides.comments
+    }),
+    node({
+      overrides: overrides.node
+    }),
     jsdoc({
+      overrides: overrides.jsdoc,
       stylistic: stylisticOptions
     }),
     imports({
+      overrides: overrides.imports,
       stylistic: stylisticOptions
     }),
     // Optional plugins (installed but not enabled by default)
-    perfectionist()
+    perfectionist({
+      overrides: overrides.perfectionist
+    })
   );
   if (enableUnicorn) {
-    configs2.push(unicorn(enableUnicorn === true ? {} : enableUnicorn));
+    configs2.push(unicorn({
+      ...enableUnicorn === true ? {} : enableUnicorn,
+      overrides: overrides.unicorn
+    }));
   }
   if (enableVue) {
     componentExts.push("vue");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lincy/eslint-config",
   "type": "module",
-  "version": "5.1.1",
+  "version": "5.2.0",
   "packageManager": "pnpm@9.1.0",
   "description": "LinCenYing's ESLint config",
   "author": "LinCenYing <lincenying@gmail.com> (https://github.com/lincenying/)",