@antfu/eslint-config 2.2.1 → 2.3.0

package/README.md

@@ -120,7 +120,6 @@ Add the following settings to your `.vscode/settings.json`:
   // Silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
     { "rule": "style/*", "severity": "off" },
-    { "rule": "prettier/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
     { "rule": "*-spacing", "severity": "off" },
     { "rule": "*-spaces", "severity": "off" },
@@ -268,17 +267,17 @@ Check out the [configs](https://github.com/antfu/eslint-config/blob/main/src/con
 
 ### Plugins Renaming
 
-Since flat config requires us to explicitly provide the plugin names (instead of mandatory convention from npm package name), we renamed some plugins to make overall scope more consistent and easier to write.
+Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
 
-| New Prefix | Original Prefix | Source Plugin |
-| --- | --- | --- |
-| `import/*` | `i/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
-| `node/*` | `n/*` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) |
-| `yaml/*` | `yml/*` | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) |
-| `ts/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
-| `style/*` | `@stylistic/*` | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic) |
-| `test/*` | `vitest/*` | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest) |
-| `test/*` | `no-only-tests/*` | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests) |
+| New Prefix | Original Prefix        | Source Plugin                                                                              |
+| ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
+| `import/*` | `i/*`                  | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i)                                |
+| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                     |
+| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                        |
+| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
+| `test/*`   | `vitest/*`             | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)                    |
+| `test/*`   | `no-only-tests/*`      | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests)  |
 
 When you want to override rules, or disable them inline, you need to update to the new prefix:
 
@@ -338,9 +337,36 @@ export default antfu({
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.
 
+#### Formatters
+
+> [!WARNING]
+> Experimental feature, changes might not follow semver.
+
+Use external formatters to format files that ESLint cannot handle yet (`.css`, `.html`, etc). Powered by [`eslint-plugin-format`](https://github.com/antfu/eslint-plugin-format).
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  formatters: {
+    css: true, // by default use Prettier
+    html: true, // by default use Prettier
+    toml: 'dprint', // use dprint for TOML
+    markdown: 'prettier' // use prettier for markdown
+  }
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-format
+```
+
 #### React
 
-To enable React support  you need to explicitly turn it on:
+To enable React support, you need to explicitly turn it on:
 
 ```js
 // eslint.config.js
@@ -384,7 +410,7 @@ This config also provides some optional plugins/rules for extended usages.
 
 This plugin [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) allows you to sorted object keys, imports, etc, with auto-fix.
 
-The plugin is installed but no rules are enabled by default. 
+The plugin is installed but no rules are enabled by default.
 
 It's recommended to opt-in on each file individually using [configuration comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1).
 
@@ -477,15 +503,9 @@ If you enjoy this code style, and would like to mention it in your project, here
 
 [Why I don't use Prettier](https://antfu.me/posts/why-not-prettier)
 
-Well, on the other hand, you can [use still Prettier to handle CSS and HTML formatting](#prettier), which is not yet supported by ESLint.
-
 ### How to format CSS?
 
-~~This config does NOT lint CSS. I personally use [UnoCSS](https://github.com/unocss/unocss) so I don't write CSS.~~
-
-Yes, we do now! See [Prettier](#prettier) section for more details.
-
-For better linting, we recommend trying [stylelint](https://stylelint.io/).
+This config does NOT lint CSS. I personally use [UnoCSS](https://github.com/unocss/unocss) so I don't write CSS. For better linting, we recommend trying [stylelint](https://stylelint.io/).
 
 ### I prefer XXX...
 

package/dist/cli.cjs

@@ -46,7 +46,7 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "2.2.1";
+var version = "2.3.0";
 var devDependencies = {
   "@antfu/eslint-config": "workspace:*",
   "@antfu/eslint-plugin-prettier": "^5.0.1-1",
@@ -54,21 +54,22 @@ var devDependencies = {
   "@stylistic/eslint-plugin-migrate": "^1.4.1",
   "@types/eslint": "^8.44.8",
   "@types/fs-extra": "^11.0.4",
-  "@types/node": "^20.10.1",
+  "@types/node": "^20.10.3",
   "@types/prompts": "^2.4.9",
   "@types/yargs": "^17.0.32",
-  "@unocss/eslint-plugin": "^0.57.7",
+  "@unocss/eslint-plugin": "^0.58.0",
   bumpp: "^9.2.0",
-  eslint: "^8.54.0",
+  eslint: "^8.55.0",
   "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-format": "^0.0.1",
   "eslint-plugin-react": "^7.33.2",
   "eslint-plugin-react-hooks": "^4.6.0",
-  "eslint-plugin-react-refresh": "^0.4.4",
+  "eslint-plugin-react-refresh": "^0.4.5",
   esno: "^4.0.0",
   execa: "^8.0.1",
   "fast-glob": "^3.3.2",
   "fs-extra": "^11.2.0",
-  "lint-staged": "^15.1.0",
+  "lint-staged": "^15.2.0",
   rimraf: "^5.0.5",
   "simple-git-hooks": "^2.9.0",
   tsup: "^8.0.1",

package/dist/cli.js

@@ -17,7 +17,7 @@ import parse from "parse-gitignore";
 import c from "picocolors";
 
 // package.json
-var version = "2.2.1";
+var version = "2.3.0";
 var devDependencies = {
   "@antfu/eslint-config": "workspace:*",
   "@antfu/eslint-plugin-prettier": "^5.0.1-1",
@@ -25,21 +25,22 @@ var devDependencies = {
   "@stylistic/eslint-plugin-migrate": "^1.4.1",
   "@types/eslint": "^8.44.8",
   "@types/fs-extra": "^11.0.4",
-  "@types/node": "^20.10.1",
+  "@types/node": "^20.10.3",
   "@types/prompts": "^2.4.9",
   "@types/yargs": "^17.0.32",
-  "@unocss/eslint-plugin": "^0.57.7",
+  "@unocss/eslint-plugin": "^0.58.0",
   bumpp: "^9.2.0",
-  eslint: "^8.54.0",
+  eslint: "^8.55.0",
   "eslint-flat-config-viewer": "^0.1.3",
+  "eslint-plugin-format": "^0.0.1",
   "eslint-plugin-react": "^7.33.2",
   "eslint-plugin-react-hooks": "^4.6.0",
-  "eslint-plugin-react-refresh": "^0.4.4",
+  "eslint-plugin-react-refresh": "^0.4.5",
   esno: "^4.0.0",
   execa: "^8.0.1",
   "fast-glob": "^3.3.2",
   "fs-extra": "^11.2.0",
-  "lint-staged": "^15.1.0",
+  "lint-staged": "^15.2.0",
   rimraf: "^5.0.5",
   "simple-git-hooks": "^2.9.0",
   tsup: "^8.0.1",

package/dist/index.cjs

@@ -59,6 +59,7 @@ __export(src_exports, {
   comments: () => comments,
   default: () => src_default,
   ensurePackages: () => ensurePackages,
+  formatters: () => formatters,
   ignores: () => ignores,
   imports: () => imports,
   interopDefault: () => interopDefault,
@@ -68,7 +69,6 @@ __export(src_exports, {
   markdown: () => markdown,
   node: () => node,
   perfectionist: () => perfectionist,
-  prettier: () => prettier,
   react: () => react,
   renameRules: () => renameRules,
   sortPackageJson: () => sortPackageJson,
@@ -595,25 +595,47 @@ 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 ? baseProcessor : {
+    ...baseProcessor,
+    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
+        }
+      ];
+    }
+  };
   return [
     {
       name: "antfu:markdown:setup",
       plugins: {
-        // @ts-expect-error missing types
-        markdown: await interopDefault(import("eslint-plugin-markdown"))
+        markdown: markdown2
       }
     },
     {
       files,
       ignores: [GLOB_MARKDOWN_IN_MARKDOWN],
       name: "antfu:markdown:processor",
-      processor: "markdown/markdown"
+      processor
     },
     {
       files: [
@@ -629,7 +651,6 @@ async function markdown(options = {}) {
       },
       name: "antfu:markdown:disables",
       rules: {
-        "antfu/no-ts-export-equal": "off",
         "import/newline-after-import": "off",
         "no-alert": "off",
         "no-console": "off",
@@ -749,7 +770,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"]
       }
@@ -757,11 +777,10 @@ async function stylistic(options = {}) {
   ];
 }
 
-// src/configs/prettier.ts
-async function prettier(options = {}, stylistic2 = {}) {
-  console.warn("@antfu/eslint-config: `prettier` option is deprecated, please do not use it anymore. We will find better formatters to support that in the future.");
+// src/configs/formatters.ts
+async function formatters(options = {}, stylistic2 = {}) {
   await ensurePackages([
-    "@antfu/eslint-plugin-prettier"
+    "eslint-plugin-format"
   ]);
   const {
     indent,
@@ -771,9 +790,6 @@ async function prettier(options = {}, stylistic2 = {}) {
     ...StylisticConfigDefaults,
     ...stylistic2
   };
-  const {
-    usePrettierrc = false
-  } = options;
   const prettierOptions = Object.assign(
     {
       semi,
@@ -782,53 +798,137 @@ async function prettier(options = {}, stylistic2 = {}) {
       trailingComma: "all",
       useTabs: indent === "tab"
     },
-    options.options || {}
+    options.prettierOptions || {}
   );
-  const rules = {
-    ...options.customFiles || {}
-  };
-  if (options.css) {
-    rules.css || (rules.css = [GLOB_CSS, GLOB_POSTCSS]);
-    rules.less || (rules.less = [GLOB_LESS]);
-    rules.scss || (rules.scss = [GLOB_SCSS]);
-  }
-  if (options.html)
-    rules.html || (rules.html = ["**/*.html", "**/*.htm"]);
-  if (options.graphql)
-    rules.graphql || (rules.graphql = ["**/*.graphql", "**/*.gql"]);
-  if (!Object.keys(rules).length)
-    throw new Error("No languages specified for Prettier");
-  const pluginPrettier = await interopDefault(import("@antfu/eslint-plugin-prettier"));
-  const parserPlain = await interopDefault(import("eslint-parser-plain"));
-  return [
+  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: "antfu:prettier:setup",
+      name: "antfu:formatters:setup",
       plugins: {
-        prettier: pluginPrettier
+        format: pluginFormat
       }
-    },
-    ...Object.entries(rules).map(([name, files]) => ({
-      files,
+    }
+  ];
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:css",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "css"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:scss",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "scss"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:less",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "less"
+            }
+          ]
+        }
+      }
+    );
+  }
+  if (options.html) {
+    configs.push({
+      files: ["**/*.html"],
       languageOptions: {
-        parser: parserPlain
+        parser: pluginFormat.parserPlain
       },
-      name: `antfu:prettier:${name}`,
+      name: "antfu:formatter:html",
       rules: {
-        "prettier/prettier": [
+        "format/prettier": [
           "error",
           {
             ...prettierOptions,
-            embeddedLanguageFormatting: name === "html" ? "auto" : "off",
-            parser: name
-          },
+            parser: "html"
+          }
+        ]
+      }
+    });
+  }
+  if (options.toml) {
+    configs.push({
+      files: ["**/*.toml"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "antfu:formatter:toml",
+      rules: {
+        "format/dprint": [
+          "error",
           {
-            fullControl: true,
-            usePrettierrc
+            ...dprintOptions,
+            language: "toml"
           }
         ]
       }
-    }))
-  ];
+    });
+  }
+  if (options.markdown) {
+    const formater = options.markdown === true ? "prettier" : options.markdown;
+    configs.push({
+      files: ["**/*.__markdown_content__"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "antfu:formatter:markdown",
+      rules: {
+        [`format/${formater}`]: [
+          "error",
+          formater === "prettier" ? {
+            ...prettierOptions,
+            embeddedLanguageFormatting: "off",
+            parser: "markdown"
+          } : {
+            ...dprintOptions,
+            language: "markdown"
+          }
+        ]
+      }
+    });
+  }
+  return configs;
 }
 
 // src/configs/react.ts
@@ -1263,8 +1363,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",
@@ -1690,14 +1788,19 @@ async function antfu(options = {}, ...userConfigs) {
     }));
   }
   if (options.markdown ?? true) {
-    configs.push(markdown({
-      componentExts,
-      overrides: overrides.markdown
-    }));
+    configs.push(
+      markdown(
+        {
+          componentExts,
+          overrides: overrides.markdown
+        },
+        !!options.formatters?.markdown
+      )
+    );
   }
-  if (options.prettier) {
-    configs.push(prettier(
-      options.prettier,
+  if (options.formatters) {
+    configs.push(formatters(
+      options.formatters,
       typeof stylisticOptions === "boolean" ? {} : stylisticOptions
     ));
   }
@@ -1747,6 +1850,7 @@ var src_default = antfu;
   combine,
   comments,
   ensurePackages,
+  formatters,
   ignores,
   imports,
   interopDefault,
@@ -1756,7 +1860,6 @@ var src_default = antfu;
   markdown,
   node,
   perfectionist,
-  prettier,
   react,
   renameRules,
   sortPackageJson,

package/dist/index.d.cts

@@ -130,37 +130,45 @@ interface OptionsFiles {
      */
     files?: string[];
 }
-interface OptionsPrettier {
+interface OptionsFormatters {
     /**
-     * Enable Prettier support for CSS, Less, Sass, and SCSS.
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
      */
-    css?: boolean;
+    css?: 'prettier' | boolean;
     /**
-     * Enable Prettier support for HTML.
+     * Enable formatting support for HTML.
+     *
+     * Currently only support Prettier.
      */
-    html?: boolean;
+    html?: 'prettier' | boolean;
     /**
-     * Enable Prettier support for GraphQL.
+     * Enable formatting support for TOML.
+     *
+     * Currently only support dprint.
      */
-    graphql?: boolean;
+    toml?: 'dprint' | boolean;
     /**
-     * Custom files to apply Prettier.
+     * Enable formatting support for Markdown.
+     *
+     * Support both Prettier and dprint.
      *
-     * The key is the parser in prettier, the value is the glob pattern.
+     * When set to `true`, it will use Prettier.
      */
-    customFiles?: Record<string, string[]>;
+    markdown?: 'prettier' | 'dprint' | boolean;
     /**
      * Custom options for Prettier.
      *
      * By default it's controlled by our own config.
      */
-    options?: VendoredPrettierOptions;
+    prettierOptions?: VendoredPrettierOptions;
     /**
-     * Use the prettierrc file.
+     * Custom options for dprint.
      *
-     * @default false
+     * By default it's controlled by our own config.
      */
-    usePrettierrc?: boolean;
+    dprintOptions?: boolean;
 }
 interface OptionsComponentExts {
     /**
@@ -293,14 +301,14 @@ interface OptionsConfig extends OptionsComponentExts {
      */
     unocss?: boolean | OptionsUnoCSS;
     /**
-     * Use Prettier to format files that not supported by ESLint.
+     * Use external formatters to format files.
      *
      * Requires installing:
-     * - `eslint-plugin-prettier`
+     * - `eslint-plugin-format`
      *
      * @default false
      */
-    prettier?: OptionsPrettier;
+    formatters?: OptionsFormatters;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -338,7 +346,7 @@ declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
 
 declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides, formatMarkdown?: boolean): Promise<FlatConfigItem[]>;
 
 declare function node(): Promise<FlatConfigItem[]>;
 
@@ -349,10 +357,7 @@ declare function node(): Promise<FlatConfigItem[]>;
  */
 declare function perfectionist(): Promise<FlatConfigItem[]>;
 
-/**
- * @deprecated
- */
-declare function prettier(options?: OptionsPrettier, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
+declare function formatters(options?: OptionsFormatters, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
 
 declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;
 
@@ -421,4 +426,4 @@ declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
 } ? U : T>;
 declare function ensurePackages(packages: string[]): Promise<void>;
 
-export { type Awaitable, type FlatConfigItem, 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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrettier, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, antfu, combine, comments, antfu as default, ensurePackages, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, prettier, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vue, yaml };
+export { type Awaitable, type FlatConfigItem, 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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, antfu, combine, comments, antfu as default, ensurePackages, formatters, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vue, yaml };

package/dist/index.d.ts

@@ -130,37 +130,45 @@ interface OptionsFiles {
      */
     files?: string[];
 }
-interface OptionsPrettier {
+interface OptionsFormatters {
     /**
-     * Enable Prettier support for CSS, Less, Sass, and SCSS.
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
      */
-    css?: boolean;
+    css?: 'prettier' | boolean;
     /**
-     * Enable Prettier support for HTML.
+     * Enable formatting support for HTML.
+     *
+     * Currently only support Prettier.
      */
-    html?: boolean;
+    html?: 'prettier' | boolean;
     /**
-     * Enable Prettier support for GraphQL.
+     * Enable formatting support for TOML.
+     *
+     * Currently only support dprint.
      */
-    graphql?: boolean;
+    toml?: 'dprint' | boolean;
     /**
-     * Custom files to apply Prettier.
+     * Enable formatting support for Markdown.
+     *
+     * Support both Prettier and dprint.
      *
-     * The key is the parser in prettier, the value is the glob pattern.
+     * When set to `true`, it will use Prettier.
      */
-    customFiles?: Record<string, string[]>;
+    markdown?: 'prettier' | 'dprint' | boolean;
     /**
      * Custom options for Prettier.
      *
      * By default it's controlled by our own config.
      */
-    options?: VendoredPrettierOptions;
+    prettierOptions?: VendoredPrettierOptions;
     /**
-     * Use the prettierrc file.
+     * Custom options for dprint.
      *
-     * @default false
+     * By default it's controlled by our own config.
      */
-    usePrettierrc?: boolean;
+    dprintOptions?: boolean;
 }
 interface OptionsComponentExts {
     /**
@@ -293,14 +301,14 @@ interface OptionsConfig extends OptionsComponentExts {
      */
     unocss?: boolean | OptionsUnoCSS;
     /**
-     * Use Prettier to format files that not supported by ESLint.
+     * Use external formatters to format files.
      *
      * Requires installing:
-     * - `eslint-plugin-prettier`
+     * - `eslint-plugin-format`
      *
      * @default false
      */
-    prettier?: OptionsPrettier;
+    formatters?: OptionsFormatters;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -338,7 +346,7 @@ declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
 
 declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides, formatMarkdown?: boolean): Promise<FlatConfigItem[]>;
 
 declare function node(): Promise<FlatConfigItem[]>;
 
@@ -349,10 +357,7 @@ declare function node(): Promise<FlatConfigItem[]>;
  */
 declare function perfectionist(): Promise<FlatConfigItem[]>;
 
-/**
- * @deprecated
- */
-declare function prettier(options?: OptionsPrettier, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
+declare function formatters(options?: OptionsFormatters, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
 
 declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;
 
@@ -421,4 +426,4 @@ declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
 } ? U : T>;
 declare function ensurePackages(packages: string[]): Promise<void>;
 
-export { type Awaitable, type FlatConfigItem, 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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrettier, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, antfu, combine, comments, antfu as default, ensurePackages, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, prettier, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vue, yaml };
+export { type Awaitable, type FlatConfigItem, 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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, antfu, combine, comments, antfu as default, ensurePackages, formatters, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vue, yaml };

package/dist/index.js

@@ -509,25 +509,47 @@ 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 ? baseProcessor : {
+    ...baseProcessor,
+    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
+        }
+      ];
+    }
+  };
   return [
     {
       name: "antfu:markdown:setup",
       plugins: {
-        // @ts-expect-error missing types
-        markdown: await interopDefault(import("eslint-plugin-markdown"))
+        markdown: markdown2
       }
     },
     {
       files,
       ignores: [GLOB_MARKDOWN_IN_MARKDOWN],
       name: "antfu:markdown:processor",
-      processor: "markdown/markdown"
+      processor
     },
     {
       files: [
@@ -543,7 +565,6 @@ async function markdown(options = {}) {
       },
       name: "antfu:markdown:disables",
       rules: {
-        "antfu/no-ts-export-equal": "off",
         "import/newline-after-import": "off",
         "no-alert": "off",
         "no-console": "off",
@@ -663,7 +684,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"]
       }
@@ -671,11 +691,10 @@ async function stylistic(options = {}) {
   ];
 }
 
-// src/configs/prettier.ts
-async function prettier(options = {}, stylistic2 = {}) {
-  console.warn("@antfu/eslint-config: `prettier` option is deprecated, please do not use it anymore. We will find better formatters to support that in the future.");
+// src/configs/formatters.ts
+async function formatters(options = {}, stylistic2 = {}) {
   await ensurePackages([
-    "@antfu/eslint-plugin-prettier"
+    "eslint-plugin-format"
   ]);
   const {
     indent,
@@ -685,9 +704,6 @@ async function prettier(options = {}, stylistic2 = {}) {
     ...StylisticConfigDefaults,
     ...stylistic2
   };
-  const {
-    usePrettierrc = false
-  } = options;
   const prettierOptions = Object.assign(
     {
       semi,
@@ -696,53 +712,137 @@ async function prettier(options = {}, stylistic2 = {}) {
       trailingComma: "all",
       useTabs: indent === "tab"
     },
-    options.options || {}
+    options.prettierOptions || {}
   );
-  const rules = {
-    ...options.customFiles || {}
-  };
-  if (options.css) {
-    rules.css || (rules.css = [GLOB_CSS, GLOB_POSTCSS]);
-    rules.less || (rules.less = [GLOB_LESS]);
-    rules.scss || (rules.scss = [GLOB_SCSS]);
-  }
-  if (options.html)
-    rules.html || (rules.html = ["**/*.html", "**/*.htm"]);
-  if (options.graphql)
-    rules.graphql || (rules.graphql = ["**/*.graphql", "**/*.gql"]);
-  if (!Object.keys(rules).length)
-    throw new Error("No languages specified for Prettier");
-  const pluginPrettier = await interopDefault(import("@antfu/eslint-plugin-prettier"));
-  const parserPlain = await interopDefault(import("eslint-parser-plain"));
-  return [
+  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: "antfu:prettier:setup",
+      name: "antfu:formatters:setup",
       plugins: {
-        prettier: pluginPrettier
+        format: pluginFormat
       }
-    },
-    ...Object.entries(rules).map(([name, files]) => ({
-      files,
+    }
+  ];
+  if (options.css) {
+    configs.push(
+      {
+        files: [GLOB_CSS, GLOB_POSTCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:css",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "css"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_SCSS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:scss",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "scss"
+            }
+          ]
+        }
+      },
+      {
+        files: [GLOB_LESS],
+        languageOptions: {
+          parser: pluginFormat.parserPlain
+        },
+        name: "antfu:formatter:less",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              ...prettierOptions,
+              parser: "less"
+            }
+          ]
+        }
+      }
+    );
+  }
+  if (options.html) {
+    configs.push({
+      files: ["**/*.html"],
       languageOptions: {
-        parser: parserPlain
+        parser: pluginFormat.parserPlain
       },
-      name: `antfu:prettier:${name}`,
+      name: "antfu:formatter:html",
       rules: {
-        "prettier/prettier": [
+        "format/prettier": [
           "error",
           {
             ...prettierOptions,
-            embeddedLanguageFormatting: name === "html" ? "auto" : "off",
-            parser: name
-          },
+            parser: "html"
+          }
+        ]
+      }
+    });
+  }
+  if (options.toml) {
+    configs.push({
+      files: ["**/*.toml"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "antfu:formatter:toml",
+      rules: {
+        "format/dprint": [
+          "error",
           {
-            fullControl: true,
-            usePrettierrc
+            ...dprintOptions,
+            language: "toml"
           }
         ]
       }
-    }))
-  ];
+    });
+  }
+  if (options.markdown) {
+    const formater = options.markdown === true ? "prettier" : options.markdown;
+    configs.push({
+      files: ["**/*.__markdown_content__"],
+      languageOptions: {
+        parser: pluginFormat.parserPlain
+      },
+      name: "antfu:formatter:markdown",
+      rules: {
+        [`format/${formater}`]: [
+          "error",
+          formater === "prettier" ? {
+            ...prettierOptions,
+            embeddedLanguageFormatting: "off",
+            parser: "markdown"
+          } : {
+            ...dprintOptions,
+            language: "markdown"
+          }
+        ]
+      }
+    });
+  }
+  return configs;
 }
 
 // src/configs/react.ts
@@ -1177,8 +1277,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",
@@ -1604,14 +1702,19 @@ async function antfu(options = {}, ...userConfigs) {
     }));
   }
   if (options.markdown ?? true) {
-    configs.push(markdown({
-      componentExts,
-      overrides: overrides.markdown
-    }));
+    configs.push(
+      markdown(
+        {
+          componentExts,
+          overrides: overrides.markdown
+        },
+        !!options.formatters?.markdown
+      )
+    );
   }
-  if (options.prettier) {
-    configs.push(prettier(
-      options.prettier,
+  if (options.formatters) {
+    configs.push(formatters(
+      options.formatters,
       typeof stylisticOptions === "boolean" ? {} : stylisticOptions
     ));
   }
@@ -1661,6 +1764,7 @@ export {
   comments,
   src_default as default,
   ensurePackages,
+  formatters,
   ignores,
   imports,
   interopDefault,
@@ -1670,7 +1774,6 @@ export {
   markdown,
   node,
   perfectionist,
-  prettier,
   react,
   renameRules,
   sortPackageJson,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antfu/eslint-config",
   "type": "module",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "packageManager": "pnpm@8.11.0",
   "description": "Anthony's ESLint config",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
@@ -25,15 +25,15 @@
     "dist"
   ],
   "peerDependencies": {
-    "@antfu/eslint-plugin-prettier": "^5.0.1-1",
     "@unocss/eslint-plugin": ">=0.50.0",
     "eslint": ">=8.40.0",
+    "eslint-plugin-format": "^0.0.1",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4"
   },
   "peerDependenciesMeta": {
-    "@antfu/eslint-plugin-prettier": {
+    "eslint-plugin-format": {
       "optional": true
     },
     "@unocss/eslint-plugin": {
@@ -51,16 +51,15 @@
   },
   "dependencies": {
     "@antfu/eslint-define-config": "^1.23.0-2",
-    "@antfu/install-pkg": "^0.3.0",
+    "@antfu/install-pkg": "^0.3.1",
     "@eslint-types/jsdoc": "46.8.2-1",
     "@eslint-types/typescript-eslint": "^6.12.0",
     "@eslint-types/unicorn": "^49.0.0",
-    "@stylistic/eslint-plugin": "^1.4.1",
+    "@stylistic/eslint-plugin": "^1.5.0-beta.0",
     "@typescript-eslint/eslint-plugin": "^6.13.1",
     "@typescript-eslint/parser": "^6.13.1",
-    "eslint-config-flat-gitignore": "^0.1.1",
-    "eslint-parser-plain": "^0.1.0",
-    "eslint-plugin-antfu": "^1.0.11",
+    "eslint-config-flat-gitignore": "^0.1.2",
+    "eslint-plugin-antfu": "^2.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-i": "^2.29.0",
     "eslint-plugin-jsdoc": "^46.9.0",
@@ -72,7 +71,7 @@
     "eslint-plugin-unicorn": "^49.0.0",
     "eslint-plugin-unused-imports": "^3.0.0",
     "eslint-plugin-vitest": "^0.3.10",
-    "eslint-plugin-vue": "^9.19.1",
+    "eslint-plugin-vue": "^9.19.2",
     "eslint-plugin-yml": "^1.10.0",
     "globals": "^13.23.0",
     "jsonc-eslint-parser": "^2.4.0",
@@ -90,27 +89,28 @@
     "@stylistic/eslint-plugin-migrate": "^1.4.1",
     "@types/eslint": "^8.44.8",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.10.1",
+    "@types/node": "^20.10.3",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.32",
-    "@unocss/eslint-plugin": "^0.57.7",
+    "@unocss/eslint-plugin": "^0.58.0",
     "bumpp": "^9.2.0",
-    "eslint": "^8.54.0",
+    "eslint": "^8.55.0",
     "eslint-flat-config-viewer": "^0.1.3",
+    "eslint-plugin-format": "^0.0.1",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.4",
+    "eslint-plugin-react-refresh": "^0.4.5",
     "esno": "^4.0.0",
     "execa": "^8.0.1",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
-    "lint-staged": "^15.1.0",
+    "lint-staged": "^15.2.0",
     "rimraf": "^5.0.5",
     "simple-git-hooks": "^2.9.0",
     "tsup": "^8.0.1",
     "typescript": "^5.3.2",
     "vitest": "^0.34.6",
-    "@antfu/eslint-config": "2.2.1"
+    "@antfu/eslint-config": "2.3.0"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"