@antfu/eslint-config 2.9.1 → 2.10.0

package/README.md

@@ -21,53 +21,46 @@
 
 ## Usage
 
-### Wizard
+### Starter Wizard
 
-We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config.
+We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.
 
 ```bash
 npx @antfu/eslint-config@latest
 ```
 
-### Install
+### Manual Install
+
+If you prefer to set up manually:
 
 ```bash
 pnpm i -D eslint @antfu/eslint-config
 ```
 
-### Create config file
-
-With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+And create `eslint.config.mjs` in your project root:
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import antfu from '@antfu/eslint-config'
 
 export default antfu()
 ```
 
-With CJS:
-
-```js
-// eslint.config.js
-const antfu = require('@antfu/eslint-config').default
-
-module.exports = antfu()
-```
-
-> [!TIP]
-> ESLint only detects `eslint.config.js` as the flat config entry, meaning you need to put `type: module` in your `package.json` or you have to use CJS in `eslint.config.js`. If you want explicit extension like `.mjs` or `.cjs`, or even `eslint.config.ts`, you can install [`eslint-ts-patch`](https://github.com/antfu/eslint-ts-patch) to fix it.
-
+<details>
+<summary>
 Combined with legacy config:
+</summary>
+
+If you still use some configs from the legacy eslintrc format, you can use the [`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to convert them to the flat config.
 
 ```js
-// eslint.config.js
-const antfu = require('@antfu/eslint-config').default
-const { FlatCompat } = require('@eslint/eslintrc')
+// eslint.config.mjs
+import antfu from '@antfu/eslint-config'
+import { FlatCompat } from '@eslint/eslintrc'
 
 const compat = new FlatCompat()
 
-module.exports = antfu(
+export default antfu(
   {
     ignores: [],
   },
@@ -86,6 +79,8 @@ module.exports = antfu(
 
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
 
+</details>
+
 ### Add script for package.json
 
 For example:
@@ -99,7 +94,7 @@ For example:
 }
 ```
 
-## VS Code support (auto fix)
+## VS Code support (auto fix on save)
 
 Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
@@ -305,6 +300,8 @@ type foo = { bar: 2 }
 >
 > Feel free to open issues if you want to combine this config with some other config presets but faced naming collisions. I am happy to figure out a way to make them work. But at this moment I have no plan to revert the renaming.
 
+Since v2.9.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.
+
 ### Rules Overrides
 
 Certain rules would only be enabled in specific files, for example, `ts/*` rules would only be enabled in `.ts` files and `vue/*` rules would only be enabled in `.vue` files. If you want to override the rules, you need to specify the file extension:
@@ -359,6 +356,35 @@ export default antfu({
 })
 ```
 
+### Pipeline
+
+Since v2.10.0, the factory function `antfu()` returns a [pipeline object from `eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils#pipe) where you can chain the methods to compose the config even more flexibly.
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu()
+  .prepend(
+    // some configs before the main config
+  )
+  // overrides any named configs
+  .override(
+    'antfu:imports',
+    {
+      rules: {
+        'import/order': ['error', { 'newlines-between': 'always' }],
+      }
+    }
+  )
+  // rename plugin prefixes
+  .renamePlugins({
+    'old-prefix': 'new-prefix',
+    // ...
+  })
+// ...
+```
+
 ### Optional Configs
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.

package/dist/cli.cjs

@@ -48,7 +48,7 @@ var import_picocolors = __toESM(require("picocolors"), 1);
 var package_default = {
   name: "@antfu/eslint-config",
   type: "module",
-  version: "2.9.1",
+  version: "2.10.0",
   packageManager: "pnpm@8.15.5",
   description: "Anthony's ESLint config",
   author: "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
@@ -143,6 +143,7 @@ var package_default = {
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
     "eslint-config-flat-gitignore": "^0.1.3",
+    "eslint-flat-config-utils": "0.0.4",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",

package/dist/cli.js

@@ -19,7 +19,7 @@ import c from "picocolors";
 var package_default = {
   name: "@antfu/eslint-config",
   type: "module",
-  version: "2.9.1",
+  version: "2.10.0",
   packageManager: "pnpm@8.15.5",
   description: "Anthony's ESLint config",
   author: "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
@@ -114,6 +114,7 @@ var package_default = {
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
     "eslint-config-flat-gitignore": "^0.1.3",
+    "eslint-flat-config-utils": "0.0.4",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",

package/dist/index.cjs

@@ -100,6 +100,7 @@ module.exports = __toCommonJS(src_exports);
 var import_node_process3 = __toESM(require("process"), 1);
 var import_node_fs = __toESM(require("fs"), 1);
 var import_local_pkg4 = require("local-pkg");
+var import_eslint_flat_config_utils = require("eslint-flat-config-utils");
 
 // src/plugins.ts
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
@@ -2101,7 +2102,7 @@ var defaultPluginRenaming = {
   "vitest": "test",
   "yml": "yaml"
 };
-async function antfu(options = {}, ...userConfigs) {
+function antfu(options = {}, ...userConfigs) {
   const {
     astro: enableAstro = false,
     autoRenamePlugins = true,
@@ -2243,13 +2244,15 @@ async function antfu(options = {}, ...userConfigs) {
   }, {});
   if (Object.keys(fusedConfig).length)
     configs.push([fusedConfig]);
-  const merged = await combine(
+  let pipeline = new import_eslint_flat_config_utils.FlatConfigPipeline();
+  pipeline = pipeline.append(
     ...configs,
     ...userConfigs
   );
-  if (autoRenamePlugins)
-    return renamePluginInConfigs(merged, defaultPluginRenaming);
-  return merged;
+  if (autoRenamePlugins) {
+    pipeline = pipeline.renamePlugins(defaultPluginRenaming);
+  }
+  return pipeline;
 }
 function resolveSubOptions(options, key) {
   return typeof options[key] === "boolean" ? {} : options[key] || {};

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import { FlatConfigPipeline } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
 import { Options } from 'eslint-processor-vue-blocks';
@@ -432,7 +433,7 @@ declare const defaultPluginRenaming: {
  * @returns {Promise<UserConfigItem[]>}
  *  The merged ESLint configurations.
  */
-declare function antfu(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+declare function antfu(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): FlatConfigPipeline<UserConfigItem>;
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
 declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): any;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { FlatConfigPipeline } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
 import { Options } from 'eslint-processor-vue-blocks';
@@ -432,7 +433,7 @@ declare const defaultPluginRenaming: {
  * @returns {Promise<UserConfigItem[]>}
  *  The merged ESLint configurations.
  */
-declare function antfu(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+declare function antfu(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): FlatConfigPipeline<UserConfigItem>;
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
 declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): any;

package/dist/index.js

@@ -2,6 +2,7 @@
 import process3 from "process";
 import fs from "fs";
 import { isPackageExists as isPackageExists4 } from "local-pkg";
+import { FlatConfigPipeline } from "eslint-flat-config-utils";
 
 // src/plugins.ts
 import { default as default2 } from "eslint-plugin-antfu";
@@ -2003,7 +2004,7 @@ var defaultPluginRenaming = {
   "vitest": "test",
   "yml": "yaml"
 };
-async function antfu(options = {}, ...userConfigs) {
+function antfu(options = {}, ...userConfigs) {
   const {
     astro: enableAstro = false,
     autoRenamePlugins = true,
@@ -2145,13 +2146,15 @@ async function antfu(options = {}, ...userConfigs) {
   }, {});
   if (Object.keys(fusedConfig).length)
     configs.push([fusedConfig]);
-  const merged = await combine(
+  let pipeline = new FlatConfigPipeline();
+  pipeline = pipeline.append(
     ...configs,
     ...userConfigs
   );
-  if (autoRenamePlugins)
-    return renamePluginInConfigs(merged, defaultPluginRenaming);
-  return merged;
+  if (autoRenamePlugins) {
+    pipeline = pipeline.renamePlugins(defaultPluginRenaming);
+  }
+  return pipeline;
 }
 function resolveSubOptions(options, key) {
   return typeof options[key] === "boolean" ? {} : options[key] || {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antfu/eslint-config",
   "type": "module",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "packageManager": "pnpm@8.15.5",
   "description": "Anthony's ESLint config",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
@@ -84,6 +84,7 @@
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
     "eslint-config-flat-gitignore": "^0.1.3",
+    "eslint-flat-config-utils": "0.0.4",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
@@ -146,7 +147,7 @@
     "typescript": "^5.4.3",
     "vitest": "^1.4.0",
     "vue": "^3.4.21",
-    "@antfu/eslint-config": "2.9.1"
+    "@antfu/eslint-config": "2.10.0"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"