feat(composer): add .removePlugins()

antfu · antfu · commit 8522f69c559f · 2025-05-21T16:26:16.000+09:00
diff --git a/package.json b/package.json
@@ -59,6 +59,7 @@
     "@types/node": "^22.15.21",
     "bumpp": "^10.1.1",
     "eslint": "^9.27.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
     "esno": "^4.8.0",
     "jsr": "^0.13.4",
     "lint-staged": "^16.0.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/composer.ts b/src/composer.ts
@@ -266,6 +266,42 @@ export class FlatConfigComposer<
     ) as any)
   }
 
+  /**
+   * Remove plugins by name and all the rules referenced by them.
+   *
+   * @example
+   * ```ts
+   * composer
+   *   .removePlugins(
+   *     'node'
+   *   )
+   * ```
+   *
+   * The `plugins: { node }` and `rules: { 'node/xxx': 'error' }` will be removed from all configs.
+   */
+  public removePlugins(
+    ...names: string[]
+  ): this {
+    this._operationsOverrides.push(async (configs) => {
+      for (const config of configs) {
+        if ('plugins' in config && typeof config.plugins === 'object' && config.plugins) {
+          for (const name of names) {
+            if (name in config.plugins)
+              delete (config.plugins as any)[name]
+          }
+        }
+        if ('rules' in config && typeof config.rules === 'object' && config.rules) {
+          for (const key of Object.keys(config.rules)) {
+            if (names.some(n => key.startsWith(`${n}/`)))
+              delete (config.rules as any)[key]
+          }
+        }
+      }
+      return configs
+    })
+    return this
+  }
+
   /**
    * Remove a specific config by name or index.
    */
diff --git a/test/composer.test.ts b/test/composer.test.ts
@@ -177,6 +177,63 @@ it('override rules', async () => {
   `)
 })
 
+it('remove plugins', async () => {
+  const p = composer([
+    {
+      name: 'init',
+      plugins: {
+        node: {},
+      },
+      rules: {
+        'no-console': 'error',
+        'no-unused-vars': 'error',
+      },
+    },
+    {
+      rules: {
+        'node/no-console': 'error',
+        'node/no-unused-vars': 'error',
+      },
+    },
+    {
+      plugins: {
+        node: {},
+        node2: {},
+      },
+      rules: {
+        'node/no-console': 'off',
+        'node/no-unused-vars': 'error',
+        'node2/no-unused-vars': 'error',
+      },
+    },
+  ])
+    .removePlugins('node')
+
+  expect(await p).toMatchInlineSnapshot(`
+    [
+      {
+        "name": "init",
+        "plugins": {},
+        "rules": {
+          "no-console": "error",
+          "no-unused-vars": "error",
+        },
+      },
+      {
+        "rules": {},
+      },
+      {
+        "plugins": {
+          "node2": {},
+        },
+        "rules": {
+          "node2/no-unused-vars": "error",
+        },
+      },
+    ]
+  `)
+})
+
 describe('error', () => {
   it('error in config', async () => {
     const p = composer([{ name: 'init' }])
