@pengzhanbo/eslint-config 1.3.4 → 1.5.0

package/dist/index.cjs

@@ -62,6 +62,8 @@ __export(src_exports, {
   createConfig: () => createConfig,
   default: () => src_default,
   defaultPreset: () => defaultPreset,
+  formatters: () => formatters,
+  getOverrides: () => getOverrides,
   html: () => html,
   ignores: () => ignores,
   imports: () => imports,
@@ -71,6 +73,7 @@ __export(src_exports, {
   jsonc: () => jsonc,
   markdown: () => markdown,
   node: () => node,
+  parserPlain: () => parserPlain,
   perfectionist: () => perfectionist,
   pluginAntfu: () => import_eslint_plugin_antfu.default,
   pluginComments: () => import_eslint_plugin_eslint_comments.default,
@@ -80,6 +83,7 @@ __export(src_exports, {
   pluginUnicorn: () => import_eslint_plugin_unicorn.default,
   pluginUnusedImports: () => import_eslint_plugin_unused_imports.default,
   renameRules: () => renameRules,
+  resolveSubOptions: () => resolveSubOptions,
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
   stylistic: () => stylistic,
@@ -95,6 +99,26 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/utils.ts
+var parserPlain = {
+  meta: {
+    name: "parser-plain"
+  },
+  parseForESLint: (code) => ({
+    ast: {
+      body: [],
+      comments: [],
+      loc: { end: code.length, start: 0 },
+      range: [0, code.length],
+      tokens: [],
+      type: "Program"
+    },
+    scopeManager: null,
+    services: { isPlain: true },
+    visitorKeys: {
+      Program: []
+    }
+  })
+};
 async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
@@ -243,6 +267,7 @@ async function imports(options = {}) {
       },
       rules: {
         "antfu/import-dedupe": "error",
+        "antfu/no-import-dist": "error",
         "antfu/no-import-node-modules-by-path": "error",
         "import/first": "error",
         "import/no-duplicates": "error",
@@ -255,6 +280,14 @@ async function imports(options = {}) {
           "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
         } : {}
       }
+    },
+    {
+      files: ["**/bin/**/*", `**/bin.${GLOB_SRC_EXT}`],
+      name: "antfu:imports:bin",
+      rules: {
+        "antfu/no-import-dist": "off",
+        "antfu/no-import-node-modules-by-path": "off"
+      }
     }
   ];
 }
@@ -589,6 +622,7 @@ async function jsonc(options = {}) {
 }
 
 // src/configs/markdown.ts
+var import_eslint_merge_processors = require("eslint-merge-processors");
 async function markdown(options = {}) {
   const {
     componentExts = [],
@@ -606,7 +640,20 @@ async function markdown(options = {}) {
     {
       files,
       name: "config:markdown:processor",
-      processor: "markdown/markdown"
+      // `eslint-plugin-markdown` only creates virtual files for code blocks,
+      // but not the markdown file itself. We use `eslint-merge-processors` to
+      // add a pass-through processor for the markdown file itself.
+      processor: (0, import_eslint_merge_processors.mergeProcessors)([
+        markdown2.processors.markdown,
+        import_eslint_merge_processors.processorPassThrough
+      ])
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "config:markdown:parser"
     },
     {
       files: [
@@ -758,15 +805,11 @@ async function sortPackageJson() {
           },
           {
             order: { type: "asc" },
-            pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies$"
-          },
-          {
-            order: { type: "asc" },
-            pathPattern: "^resolutions$"
+            pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies(Meta)?$"
           },
           {
             order: { type: "asc" },
-            pathPattern: "^pnpm.overrides$"
+            pathPattern: "^(?:resolutions|overrides|pnpm.overrides)$"
           },
           {
             order: [
@@ -919,6 +962,7 @@ async function stylistic(options = {}) {
   const {
     indent,
     jsx,
+    overrides = {},
     quotes,
     semi
   } = {
@@ -946,7 +990,8 @@ async function stylistic(options = {}) {
         "antfu/consistent-list-newline": "error",
         "antfu/if-newline": "error",
         "antfu/top-level-function": "error",
-        "curly": ["error", "multi-or-nest", "consistent"]
+        "curly": ["error", "multi-or-nest", "consistent"],
+        ...overrides
       }
     }
   ];
@@ -964,6 +1009,7 @@ async function typescript(options = {}) {
     GLOB_SRC,
     ...componentExts.map((ext) => `**/*.${ext}`)
   ];
+  const filesTypeAware = options.filesTypeAware ?? [GLOB_TS, GLOB_TSX];
   const typeAwareRules = {
     "dot-notation": "off",
     "no-implied-eval": "off",
@@ -1053,6 +1099,13 @@ async function typescript(options = {}) {
         "ts/prefer-ts-expect-error": "error",
         "ts/triple-slash-reference": "off",
         "ts/unified-signatures": "off",
+        ...overrides
+      }
+    },
+    {
+      files: filesTypeAware,
+      name: "config:typescript:rules-type-aware",
+      rules: {
         ...tsconfigPath ? typeAwareRules : {},
         ...overrides
       }
@@ -1220,6 +1273,7 @@ async function test(options = {}) {
         "node/prefer-global/process": "off",
         "test/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
         "test/no-identical-title": "error",
+        "test/no-import-node-test": "error",
         "test/no-only-tests": isInEditor ? "off" : "error",
         "test/prefer-hooks-in-order": "error",
         "test/prefer-lowercase-title": "error",
@@ -1410,11 +1464,27 @@ async function toml(options = {}) {
       },
       name: "config:toml:rules",
       rules: {
-        ...pluginToml.configs.standard.rules,
-        ...pluginToml.configs.recommended.rules,
         "style/spaced-comment": "off",
+        "toml/comma-style": "error",
+        "toml/keys-order": "error",
+        "toml/no-space-dots": "error",
+        "toml/no-unreadable-number-separator": "error",
+        "toml/precision-of-fractional-seconds": "error",
+        "toml/precision-of-integer": "error",
+        "toml/tables-order": "error",
+        "toml/vue-custom-block/no-parsing-error": "error",
         ...stylistic2 ? {
-          "toml/indent": ["error", indent === "tab" ? 2 : indent]
+          "toml/array-bracket-newline": "error",
+          "toml/array-bracket-spacing": "error",
+          "toml/array-element-newline": "error",
+          "toml/indent": ["error", indent === "tab" ? 2 : indent],
+          "toml/inline-table-curly-spacing": "error",
+          "toml/key-spacing": "error",
+          "toml/padding-line-between-pairs": "error",
+          "toml/padding-line-between-tables": "error",
+          "toml/quoted-keys": "error",
+          "toml/spaced-comment": "error",
+          "toml/table-bracket-spacing": "error"
         } : {},
         ...overrides
       }
@@ -1422,13 +1492,181 @@ async function toml(options = {}) {
   ];
 }
 
+// src/configs/formatters.ts
+var import_local_pkg3 = require("local-pkg");
+var formatPackages = ["eslint-plugin-format"];
+async function formatters(options = {}, stylistic2 = {}) {
+  const unInstalled = formatPackages.filter((i) => !(0, import_local_pkg3.isPackageExists)(i));
+  if (unInstalled.length > 0) {
+    console.warn(`${unInstalled.join(", ")} is not installed, please install it first.
+ Run \`npm install -D ${unInstalled.join(" ")}\``);
+    return [];
+  }
+  if (options === true) {
+    options = {
+      css: true,
+      graphql: true,
+      html: true,
+      markdown: true
+    };
+  }
+  const {
+    indent,
+    quotes,
+    semi
+  } = {
+    ...StylisticConfigDefaults,
+    ...stylistic2
+  };
+  const prettierOptions = Object.assign(
+    {
+      endOfLine: "auto",
+      semi,
+      singleQuote: quotes === "single",
+      tabWidth: typeof indent === "number" ? indent : 2,
+      trailingComma: "all",
+      useTabs: indent === "tab"
+    },
+    options.prettierOptions || {}
+  );
+  const dprintOptions = Object.assign(
+    {
+      indentWidth: typeof indent === "number" ? indent : 2,
+      quoteStyle: quotes === "single" ? "preferSingle" : "preferDouble",
+      useTabs: indent === "tab"
+    },
+    options.dprintOptions || {}
+  );
+  const pluginFormat = await interopDefault(import("eslint-plugin-format"));
+  const configs = [
+    {
+      name: "config:formatters:setup",
+      plugins: {
+        format: pluginFormat
+      }
+    }
+  ];
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "config:formatter:css",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "css"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "config:formatter:scss",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "scss"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "config:formatter:less",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "less"
+            }
+          ]
+        }
+      }
+    );
+  }
+  if (options.html) {
+    configs.push({
+      files: ["**/*.html"],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "config:formatter:html",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "html"
+          }
+        ]
+      }
+    });
+  }
+  if (options.markdown) {
+    const formater = options.markdown === true ? "prettier" : options.markdown;
+    configs.push({
+      files: [GLOB_MARKDOWN],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "config:formatter:markdown",
+      rules: {
+        [`format/${formater}`]: [
+          "error",
+          formater === "prettier" ? {
+            printWidth: 120,
+            ...prettierOptions,
+            embeddedLanguageFormatting: "off",
+            parser: "markdown"
+          } : {
+            ...dprintOptions,
+            language: "markdown"
+          }
+        ]
+      }
+    });
+  }
+  if (options.graphql) {
+    configs.push({
+      files: ["**/*.graphql"],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "config:formatter:graphql",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "graphql"
+          }
+        ]
+      }
+    });
+  }
+  return configs;
+}
+
 // src/preset.ts
 var defaultPreset = (options) => {
   const {
     componentExts,
     gitignore: enableGitignore,
     isInEditor,
-    overrides,
     typescript: enableTypeScript,
     stylistic: stylisticOptions
   } = options;
@@ -1450,7 +1688,7 @@ var defaultPreset = (options) => {
     ignores(),
     javascript({
       isInEditor,
-      overrides: overrides.javascript
+      overrides: getOverrides(options, "javascript")
     }),
     comments(),
     node(),
@@ -1466,23 +1704,26 @@ var defaultPreset = (options) => {
   );
   if (enableTypeScript) {
     configs.push(typescript({
-      ...typeof enableTypeScript !== "boolean" ? enableTypeScript : {},
-      componentExts,
-      overrides: overrides.typescript
+      ...resolveSubOptions(options, "typescript"),
+      componentExts
+    }));
+  }
+  if (stylisticOptions) {
+    configs.push(stylistic({
+      ...typeof stylisticOptions === "boolean" ? {} : stylisticOptions,
+      overrides: getOverrides(options, "stylistic")
     }));
   }
-  if (stylisticOptions)
-    configs.push(stylistic(stylisticOptions));
   if (options.test) {
     configs.push(test({
       isInEditor,
-      overrides: overrides.test
+      overrides: getOverrides(options, "test")
     }));
   }
   if (options.jsonc) {
     configs.push(
       jsonc({
-        overrides: overrides.jsonc,
+        overrides: getOverrides(options, "jsonc"),
         stylistic: stylisticOptions
       }),
       sortPackageJson(),
@@ -1491,40 +1732,54 @@ var defaultPreset = (options) => {
   }
   if (options.yaml) {
     configs.push(yaml({
-      overrides: overrides.yaml,
+      overrides: getOverrides(options, "yaml"),
       stylistic: stylisticOptions
     }));
   }
   if (options.toml) {
     configs.push(toml({
-      overrides: overrides.toml,
+      overrides: getOverrides(options, "toml"),
       stylistic: stylisticOptions
     }));
   }
   if (options.html) {
     configs.push(html({
-      overrides: overrides.html,
+      overrides: getOverrides(options, "html"),
       stylistic: stylisticOptions
     }));
   }
-  if (options.unocss)
-    configs.push(unocss(options.unocss === true ? {} : options.unocss));
-  if (options.tailwindcss)
-    configs.push(tailwindcss(options.tailwindcss === true ? {} : options.tailwindcss));
+  if (options.unocss) {
+    configs.push(unocss({
+      ...resolveSubOptions(options, "unocss"),
+      overrides: getOverrides(options, "unocss")
+    }));
+  }
+  if (options.tailwindcss) {
+    configs.push(tailwindcss({
+      ...resolveSubOptions(options, "tailwindcss"),
+      overrides: getOverrides(options, "tailwindcss")
+    }));
+  }
   if (options.markdown) {
     configs.push(
       markdown({
         componentExts,
-        overrides: overrides.markdown
+        overrides: getOverrides(options, "markdown")
       })
     );
   }
+  if (options.formatters) {
+    configs.push(formatters(
+      options.formatters,
+      typeof stylisticOptions === "boolean" ? {} : stylisticOptions
+    ));
+  }
   return configs;
 };
 
 // src/resolvedOptions.ts
 var import_node_process2 = __toESM(require("process"), 1);
-var import_local_pkg3 = require("local-pkg");
+var import_local_pkg4 = require("local-pkg");
 var VuePackages = [
   "vue",
   "nuxt",
@@ -1536,9 +1791,8 @@ function resolveOptions(options = {}) {
     componentExts = [],
     preset = [],
     gitignore = true,
-    isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE) && !import_node_process2.default.env.CI),
-    overrides = {},
-    typescript: typescript2 = (0, import_local_pkg3.isPackageExists)("typescript"),
+    isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE || import_node_process2.default.env.VIM) && !import_node_process2.default.env.CI),
+    typescript: typescript2 = (0, import_local_pkg4.isPackageExists)("typescript"),
     jsx = true,
     test: test2 = true,
     jsonc: jsonc2 = true,
@@ -1546,6 +1800,7 @@ function resolveOptions(options = {}) {
     toml: toml2 = true,
     markdown: markdown2 = true,
     html: html2 = true,
+    formatters: formatters2 = false,
     unocss: enableUnocss = false,
     tailwindcss: enableTailwindcss = false
   } = options;
@@ -1554,11 +1809,11 @@ function resolveOptions(options = {}) {
     stylistic2.jsx = options.jsx ?? true;
   const unocss2 = enableUnocss === false ? false : typeof enableUnocss === "object" ? enableUnocss : {};
   const tailwindcss2 = enableTailwindcss === false ? false : typeof enableTailwindcss === "object" ? enableTailwindcss : {};
-  if (VuePackages.some((i) => (0, import_local_pkg3.isPackageExists)(i)))
+  if (VuePackages.some((i) => (0, import_local_pkg4.isPackageExists)(i)))
     componentExts.push("vue");
-  if ((0, import_local_pkg3.isPackageExists)("astro"))
+  if ((0, import_local_pkg4.isPackageExists)("astro"))
     componentExts.push("astro");
-  if ((0, import_local_pkg3.isPackageExists)("svelte"))
+  if ((0, import_local_pkg4.isPackageExists)("svelte"))
     componentExts.push("svelte");
   return {
     ...options,
@@ -1566,7 +1821,6 @@ function resolveOptions(options = {}) {
     preset,
     gitignore,
     isInEditor,
-    overrides,
     typescript: typescript2,
     stylistic: stylistic2,
     jsx,
@@ -1577,7 +1831,8 @@ function resolveOptions(options = {}) {
     markdown: markdown2,
     unocss: unocss2,
     tailwindcss: tailwindcss2,
-    html: html2
+    html: html2,
+    formatters: formatters2
   };
 }
 
@@ -1620,6 +1875,16 @@ function createConfig(preset) {
     return eslintFlatConfig(options, ...userConfigs);
   };
 }
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+function getOverrides(options, key) {
+  const sub = resolveSubOptions(options, key);
+  return {
+    ...options.overrides?.[key],
+    ..."overrides" in sub ? sub.overrides || {} : {}
+  };
+}
 
 // src/index.ts
 var src_default = eslintFlatConfig;
@@ -1656,6 +1921,8 @@ var src_default = eslintFlatConfig;
   comments,
   createConfig,
   defaultPreset,
+  formatters,
+  getOverrides,
   html,
   ignores,
   imports,
@@ -1665,6 +1932,7 @@ var src_default = eslintFlatConfig;
   jsonc,
   markdown,
   node,
+  parserPlain,
   perfectionist,
   pluginAntfu,
   pluginComments,
@@ -1674,6 +1942,7 @@ var src_default = eslintFlatConfig;
   pluginUnicorn,
   pluginUnusedImports,
   renameRules,
+  resolveSubOptions,
   sortPackageJson,
   sortTsconfig,
   stylistic,