feat: introduce experimental pnpmCatalogs support

antfu · antfu · commit d410d143ed60 · 2025-03-06T19:30:40.000+08:00
diff --git a/package.json b/package.json
@@ -114,6 +114,7 @@
     "eslint-plugin-n": "^17.16.2",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-perfectionist": "^4.9.0",
+    "eslint-plugin-pnpm-catalogs": "^0.0.3",
     "eslint-plugin-regexp": "^2.7.0",
     "eslint-plugin-toml": "^0.12.0",
     "eslint-plugin-unicorn": "^57.0.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/configs/index.ts b/src/configs/index.ts
@@ -12,6 +12,7 @@ export * from './jsx'
 export * from './markdown'
 export * from './node'
 export * from './perfectionist'
+export * from './pnpm-catalogs'
 export * from './react'
 export * from './regexp'
 export * from './solid'
diff --git a/src/configs/pnpm-catalogs.ts b/src/configs/pnpm-catalogs.ts
@@ -0,0 +1,25 @@
+import type { TypedFlatConfigItem } from '../types'
+
+import { interopDefault } from '../utils'
+
+export async function pnpmCatalogs(): Promise<TypedFlatConfigItem[]> {
+  return [
+    {
+      files: [
+        'package.json',
+        '**/package.json',
+      ],
+      languageOptions: {
+        parser: await interopDefault(import('jsonc-eslint-parser')),
+      },
+      name: 'antfu/pnpm-catalogs/rules',
+      plugins: {
+        'pnpm-catalogs': await interopDefault(import('eslint-plugin-pnpm-catalogs')),
+      },
+      rules: {
+        'pnpm-catalogs/enforce-catalog': 'error',
+        'pnpm-catalogs/valid-catalog': 'error',
+      },
+    },
+  ]
+}
diff --git a/src/factory.ts b/src/factory.ts
@@ -18,6 +18,7 @@ import {
   markdown,
   node,
   perfectionist,
+  pnpmCatalogs,
   react,
   solid,
   sortPackageJson,
@@ -87,6 +88,7 @@ export function antfu(
     componentExts = [],
     gitignore: enableGitignore = true,
     jsx: enableJsx = true,
+    pnpmCatalogs: enablePnpmCatalogs = false, // TOD: smart detect
     react: enableReact = false,
     regexp: enableRegexp = true,
     solid: enableSolid = false,
@@ -253,6 +255,12 @@ export function antfu(
     )
   }
 
+  if (enablePnpmCatalogs) {
+    configs.push(
+      pnpmCatalogs(),
+    )
+  }
+
   if (options.yaml ?? true) {
     configs.push(yaml({
       overrides: getOverrides(options, 'yaml'),
diff --git a/src/types.ts b/src/types.ts
@@ -390,6 +390,18 @@ export interface OptionsConfig extends OptionsComponentExts, OptionsProjectType
    */
   unocss?: boolean | OptionsUnoCSS
 
+  /**
+   * Enable pnpm catalogs support.
+   *
+   * Currently it's disabled by default, as it's still experimental.
+   * In the future it will be smartly enabled based on the project catalog usage.
+   *
+   * @see https://github.com/antfu/pnpm-catalogs-utils
+   * @experimental
+   * @default false
+   */
+  pnpmCatalogs?: boolean
+
   /**
    * Use external formatters to format files.
    *
