feat: Make perfectionist configurable inside antfu() (#848)

* Make `perfectionist` configurable inside `antfu()`

* Update snapshot

* Add the `perfectionist` key in eslint config

* Switch position to match test snapshot

* Add perfectionist to`CONFIG_PRESET_FULL_ON` consistant

* Adjust `full-off` snapshot to reflect result when `perfectionist: false`

Author: oliver139

eslint.config.ts

@@ -19,6 +19,7 @@ export default antfu(
       },
     },
     formatters: true,
+    perfectionist: true,
     pnpm: true,
     type: 'lib',
     jsx: {

src/config-presets.ts

@@ -15,6 +15,7 @@ export const CONFIG_PRESET_FULL_ON: OptionsConfig = {
   markdown: true,
   nextjs: true,
   node: true,
+  perfectionist: true,
   pnpm: true,
   react: true,
   regexp: true,
@@ -49,6 +50,7 @@ export const CONFIG_PRESET_FULL_OFF: OptionsConfig = {
   markdown: false,
   nextjs: false,
   node: false,
+  perfectionist: false,
   pnpm: false,
   react: false,
   regexp: false,

src/configs/perfectionist.ts

@@ -1,4 +1,4 @@
-import type { TypedFlatConfigItem } from '../types'
+import type { OptionsOverrides, TypedFlatConfigItem } from '../types'
 
 import { pluginPerfectionist } from '../plugins'
 
@@ -7,7 +7,11 @@ import { pluginPerfectionist } from '../plugins'
  *
  * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-export async function perfectionist(): Promise<TypedFlatConfigItem[]> {
+export async function perfectionist(options: OptionsOverrides): Promise<TypedFlatConfigItem[]> {
+  const {
+    overrides = {},
+  } = options
+
   return [
     {
       name: 'antfu/perfectionist/setup',
@@ -36,6 +40,8 @@ export async function perfectionist(): Promise<TypedFlatConfigItem[]> {
         }],
         'perfectionist/sort-named-exports': ['error', { order: 'asc', type: 'natural' }],
         'perfectionist/sort-named-imports': ['error', { order: 'asc', type: 'natural' }],
+
+        ...overrides,
       },
     },
   ]

src/factory.ts

@@ -103,6 +103,7 @@ export function antfu(
     jsx: enableJsx = true,
     nextjs: enableNextjs = false,
     node: enableNode = true,
+    perfectionist: enablePerfectionist = true,
     pnpm: enableCatalogs = !!findUpSync('pnpm-workspace.yaml'),
     react: enableReact = false,
     regexp: enableRegexp = true,
@@ -165,11 +166,16 @@ export function antfu(
     }),
     comments(),
     command(),
-
-    // Optional plugins (installed but not enabled by default)
-    perfectionist(),
   )
 
+  if (enablePerfectionist) {
+    configs.push(
+      perfectionist({
+        overrides: getOverrides(options, 'perfectionist'),
+      }),
+    )
+  }
+
   if (enableNode) {
     configs.push(
       node(),

src/types.ts

@@ -425,6 +425,13 @@ export interface OptionsConfig extends OptionsComponentExts, OptionsProjectType
    */
   unicorn?: boolean | OptionsUnicorn
 
+  /**
+   * Options for eslint-plugin-perfectionist.
+   *
+   * @default true
+   */
+  perfectionist?: boolean | OptionsOverrides
+
   /**
    * Options for eslint-plugin-import-lite.
    *

test/__snapshots__/api/index.snapshot.d.ts

@@ -15,6 +15,7 @@ export interface OptionsConfig extends OptionsComponentExts, OptionsProjectType
   jsx?: boolean | OptionsJSX;
   e18e?: boolean | OptionsE18e;
   unicorn?: boolean | OptionsUnicorn;
+  perfectionist?: boolean | OptionsOverrides;
   imports?: boolean | OptionsOverrides;
   test?: boolean | OptionsOverrides;
   vue?: boolean | OptionsVue;
@@ -2006,7 +2007,7 @@ export declare function jsx(_?: OptionsJSX): Promise<TypedFlatConfigItem[]>;
 export declare function markdown(_?: OptionsFiles & OptionsComponentExts & OptionsMarkdown): Promise<TypedFlatConfigItem[]>;
 export declare function nextjs(_?: OptionsOverrides & OptionsFiles): Promise<TypedFlatConfigItem[]>;
 export declare function node(): Promise<TypedFlatConfigItem[]>;
-export declare function perfectionist(): Promise<TypedFlatConfigItem[]>;
+export declare function perfectionist(_: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
 export declare function pnpm(_: OptionsPnpm): Promise<TypedFlatConfigItem[]>;
 export declare function react(_?: OptionsTypeScriptParserOptions & OptionsTypeScriptWithTypes & OptionsReact & OptionsFiles): Promise<TypedFlatConfigItem[]>;
 export declare function regexp(_?: OptionsRegExp & OptionsOverrides): Promise<TypedFlatConfigItem[]>;

test/__snapshots__/api/index.snapshot.js

@@ -59,7 +59,7 @@ export async function markdown(_) {}
 export async function nextjs(_) {}
 export async function node() {}
 export var parserPlain /* const */
-export async function perfectionist() {}
+export async function perfectionist(_) {}
 export async function pnpm(_) {}
 export async function react(_) {}
 export async function regexp(_) {}

test/__snapshots__/factory/full-off.snap.js

@@ -139,18 +139,6 @@
       "command/command",
     ],
   },
-  {
-    "name": "antfu/perfectionist/setup",
-    "plugins": [
-      "perfectionist",
-    ],
-    "rules": [
-      "perfectionist/sort-exports",
-      "perfectionist/sort-imports",
-      "perfectionist/sort-named-exports",
-      "perfectionist/sort-named-imports",
-    ],
-  },
   {
     "name": "antfu/e18e/rules",
     "plugins": [