@pengzhanbo/eslint-config 1.2.5 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 pengzhanbo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -43,6 +43,8 @@ __export(src_exports, {
   GLOB_LESS: () => GLOB_LESS,
   GLOB_MARKDOWN: () => GLOB_MARKDOWN,
   GLOB_MARKDOWN_CODE: () => GLOB_MARKDOWN_CODE,
+  GLOB_MARKDOWN_IN_MARKDOWN: () => GLOB_MARKDOWN_IN_MARKDOWN,
+  GLOB_POSTCSS: () => GLOB_POSTCSS,
   GLOB_SCSS: () => GLOB_SCSS,
   GLOB_SRC: () => GLOB_SRC,
   GLOB_SRC_EXT: () => GLOB_SRC_EXT,
@@ -53,12 +55,13 @@ __export(src_exports, {
   GLOB_TSX: () => GLOB_TSX,
   GLOB_VUE: () => GLOB_VUE,
   GLOB_YAML: () => GLOB_YAML,
+  StylisticConfigDefaults: () => StylisticConfigDefaults,
   combine: () => combine,
   comments: () => comments,
   createConfig: () => createConfig,
   default: () => src_default,
   defaultPreset: () => defaultPreset,
-  html: () => html,
+  formatters: () => formatters,
   ignores: () => ignores,
   imports: () => imports,
   interopDefault: () => interopDefault,
@@ -150,12 +153,14 @@ var GLOB_TS = "**/*.?([cm])ts";
 var GLOB_TSX = "**/*.?([cm])tsx";
 var GLOB_STYLE = "**/*.{c,le,sc}ss";
 var GLOB_CSS = "**/*.css";
+var GLOB_POSTCSS = "**/*.{p,post}css";
 var GLOB_LESS = "**/*.less";
 var GLOB_SCSS = "**/*.scss";
 var GLOB_JSON = "**/*.json";
 var GLOB_JSON5 = "**/*.json5";
 var GLOB_JSONC = "**/*.jsonc";
 var GLOB_MARKDOWN = "**/*.md";
+var GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
 var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_HTML = "**/*.htm?(l)";
@@ -581,24 +586,56 @@ async function jsonc(options = {}) {
 }
 
 // src/configs/markdown.ts
-async function markdown(options = {}) {
+async function markdown(options = {}, formatMarkdown = false) {
   const {
     componentExts = [],
     files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
+  const markdown2 = await interopDefault(import("eslint-plugin-markdown"));
+  const baseProcessor = markdown2.processors.markdown;
+  const processor = !formatMarkdown ? {
+    meta: {
+      name: "markdown-processor"
+    },
+    supportsAutofix: true,
+    ...baseProcessor
+  } : {
+    meta: {
+      name: "markdown-processor-with-content"
+    },
+    postprocess(messages, filename) {
+      const markdownContent = messages.pop();
+      const codeSnippets = baseProcessor.postprocess(messages, filename);
+      return [
+        ...markdownContent || [],
+        ...codeSnippets || []
+      ];
+    },
+    preprocess(text, filename) {
+      const result = baseProcessor.preprocess(text, filename);
+      return [
+        ...result,
+        {
+          filename: ".__markdown_content__",
+          text
+        }
+      ];
+    },
+    supportsAutofix: true
+  };
   return [
     {
       name: "config:markdown:setup",
       plugins: {
-        // @ts-expect-error missing types
-        markdown: await interopDefault(import("eslint-plugin-markdown"))
+        markdown: markdown2
       }
     },
     {
       files,
+      ignores: [GLOB_MARKDOWN_IN_MARKDOWN],
       name: "config:markdown:processor",
-      processor: "markdown/markdown"
+      processor
     },
     {
       files: [
@@ -612,9 +649,8 @@ async function markdown(options = {}) {
           }
         }
       },
-      name: "config:markdown:rules",
+      name: "config:markdown:disables",
       rules: {
-        "antfu/no-ts-export-equal": "off",
         "import/newline-after-import": "off",
         "no-alert": "off",
         "no-console": "off",
@@ -902,13 +938,22 @@ function sortTsconfig() {
 }
 
 // src/configs/stylistic.ts
+var StylisticConfigDefaults = {
+  indent: 2,
+  jsx: true,
+  quotes: "single",
+  semi: false
+};
 async function stylistic(options = {}) {
   const {
-    indent = 2,
-    jsx = true,
-    quotes = "single",
-    semi = false
-  } = options;
+    indent,
+    jsx,
+    quotes,
+    semi
+  } = {
+    ...StylisticConfigDefaults,
+    ...options
+  };
   const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
   const config = pluginStylistic.configs.customize({
     flat: true,
@@ -929,7 +974,6 @@ async function stylistic(options = {}) {
         ...config.rules,
         "antfu/consistent-list-newline": "error",
         "antfu/if-newline": "error",
-        "antfu/indent-binary-ops": ["error", { indent }],
         "antfu/top-level-function": "error",
         "curly": ["error", "multi-or-nest", "consistent"]
       }
@@ -1013,8 +1057,6 @@ async function typescript(options = {}) {
           "@typescript-eslint/",
           "ts/"
         ),
-        "antfu/generic-spacing": "error",
-        "antfu/named-tuple-spacing": "error",
         "no-dupe-class-members": "off",
         "no-loss-of-precision": "off",
         "no-redeclare": "off",
@@ -1315,55 +1357,190 @@ async function tailwindcss(options = {}) {
   ];
 }
 
-// src/configs/html.ts
-async function html(options = {}) {
-  const {
-    files = [GLOB_HTML],
-    overrides = {},
-    stylistic: stylistic2 = true
-  } = options;
+// src/configs/formatters.ts
+var import_local_pkg3 = require("local-pkg");
+var formatterPackages = ["eslint-plugin-format"];
+async function formatters(options = {}, stylistic2 = {}, markdownEnabled = true) {
+  const unInstalled = formatterPackages.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,
+      toml: true
+    };
+  }
   const {
-    indent = 2
-  } = typeof stylistic2 === "boolean" ? {} : stylistic2;
-  const [
-    pluginHtml,
-    parserHtml
-  ] = await Promise.all([
-    interopDefault(import("@html-eslint/eslint-plugin")),
-    interopDefault(import("@html-eslint/parser"))
-  ]);
-  return [
+    indent,
+    quotes,
+    semi
+  } = {
+    ...StylisticConfigDefaults,
+    ...stylistic2
+  };
+  const prettierOptions = Object.assign(
     {
-      name: "config:html:setup",
-      plugins: {
-        html: pluginHtml
-      }
+      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 = [
     {
-      files,
-      name: "config:html:rules",
+      name: "antfu:formatters:setup",
+      plugins: {
+        format: pluginFormat
+      }
+    }
+  ];
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "config:formatter:css",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "css"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "config:formatter:scss",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "scss"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "config:formatter:less",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "less"
+            }
+          ]
+        }
+      }
+    );
+  }
+  if (options.html) {
+    configs.push({
+      files: ["**/*.html"],
       languageOptions: {
-        parser: parserHtml
+        parser: pluginFormat.parserPlain
       },
+      name: "config:formatter:html",
       rules: {
-        "html/require-lang": "error",
-        "html/require-img-alt": "error",
-        "html/require-doctype": "error",
-        "html/require-title": "error",
-        "html/no-extra-spacing-attrs": "error",
-        "html/no-duplicate-id": "error",
-        "html/indent": ["error", indent],
-        "html/require-li-container": "error",
-        "html/quotes": "error",
-        "html/require-closing-tags": "error",
-        "html/no-duplicate-attrs": "error",
-        "html/element-newline": ["error", {
-          skip: ["span", "i", "code", "pre"]
-        }],
-        ...overrides
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "html"
+          }
+        ]
       }
-    }
-  ];
+    });
+  }
+  if (options.toml) {
+    configs.push({
+      files: ["**/*.toml"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "config:formatter:toml",
+      rules: {
+        "format/dprint": [
+          "error",
+          {
+            ...dprintOptions,
+            language: "toml"
+          }
+        ]
+      }
+    });
+  }
+  if (options.markdown) {
+    const formatter = options.markdown === true ? "prettier" : options.markdown;
+    configs.push({
+      files: markdownEnabled ? ["**/*.__markdown_content__"] : [GLOB_MARKDOWN],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "config:formatter:markdown",
+      rules: {
+        [`format/${formatter}`]: [
+          "error",
+          formatter === "prettier" ? {
+            ...prettierOptions,
+            embeddedLanguageFormatting: "off",
+            parser: "markdown"
+          } : {
+            ...dprintOptions,
+            language: "markdown"
+          }
+        ]
+      }
+    });
+  }
+  if (options.graphql) {
+    configs.push({
+      files: ["**/*.graphql"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "config:formatter:graphql",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "graphql"
+          }
+        ]
+      }
+    });
+  }
+  return configs;
 }
 
 // src/preset.ts
@@ -1433,12 +1610,6 @@ var defaultPreset = (options) => {
       sortTsconfig()
     );
   }
-  if (options.html) {
-    configs.push(html({
-      overrides: overrides.html,
-      stylistic: stylisticOptions
-    }));
-  }
   if (options.yaml) {
     configs.push(yaml({
       overrides: overrides.yaml,
@@ -1453,14 +1624,21 @@ var defaultPreset = (options) => {
     configs.push(markdown({
       componentExts,
       overrides: overrides.markdown
-    }));
+    }, options.formatters === true || !!(options.formatters || {})?.markdown));
+  }
+  if (options.formatters) {
+    configs.push(formatters(
+      options.formatters,
+      typeof stylisticOptions === "boolean" ? {} : stylisticOptions,
+      options.markdown !== false
+    ));
   }
   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",
@@ -1474,13 +1652,13 @@ function resolveOptions(options = {}) {
     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"),
+    typescript: typescript2 = (0, import_local_pkg4.isPackageExists)("typescript"),
     jsx = true,
     test: test2 = true,
     jsonc: jsonc2 = true,
     yaml: yaml2 = true,
     markdown: markdown2 = true,
-    html: html2 = true,
+    formatters: formatters2 = false,
     unocss: enableUnocss = false,
     tailwindcss: enableTailwindcss = false
   } = options;
@@ -1489,11 +1667,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,
@@ -1511,7 +1689,7 @@ function resolveOptions(options = {}) {
     markdown: markdown2,
     unocss: unocss2,
     tailwindcss: tailwindcss2,
-    html: html2
+    formatters: formatters2
   };
 }
 
@@ -1572,6 +1750,8 @@ var src_default = eslintFlatConfig;
   GLOB_LESS,
   GLOB_MARKDOWN,
   GLOB_MARKDOWN_CODE,
+  GLOB_MARKDOWN_IN_MARKDOWN,
+  GLOB_POSTCSS,
   GLOB_SCSS,
   GLOB_SRC,
   GLOB_SRC_EXT,
@@ -1582,11 +1762,12 @@ var src_default = eslintFlatConfig;
   GLOB_TSX,
   GLOB_VUE,
   GLOB_YAML,
+  StylisticConfigDefaults,
   combine,
   comments,
   createConfig,
   defaultPreset,
-  html,
+  formatters,
   ignores,
   imports,
   interopDefault,