feat: pnpm plugin (#1219)

Co-authored-by: Lars Kappert <[email protected]>

Author: lishaduck

packages/knip/fixtures/plugins/pnpm/.pnpmfile.cjs

@@ -0,0 +1,3 @@
+{
+  "packageManager": "[email protected]"
+}

packages/knip/fixtures/plugins/pnpm/package.json

@@ -547,6 +547,10 @@
           "title": "playwright-test plugin configuration (https://knip.dev/reference/plugins/playwright-test)",
           "$ref": "#/definitions/plugin"
         },
+        "pnpm": {
+          "title": "pnpm plugin configuration (https://knip.dev/reference/plugins/pnpm)",
+          "$ref": "#/definitions/plugin"
+        },
         "postcss": {
           "title": "PostCSS plugin configuration (https://knip.dev/reference/plugins/postcss)",
           "$ref": "#/definitions/plugin"

packages/knip/schema.json

@@ -62,6 +62,7 @@ import { default as playwrightCt } from './playwright-ct/index.js';
 import { default as playwrightTest } from './playwright-test/index.js';
 import { default as playwright } from './playwright/index.js';
 import { default as plop } from './plop/index.js';
+import { default as pnpm } from './pnpm/index.js';
 import { default as postcss } from './postcss/index.js';
 import { default as preconstruct } from './preconstruct/index.js';
 import { default as prettier } from './prettier/index.js';
@@ -175,6 +176,7 @@ export const Plugins = {
   'playwright-ct': playwrightCt,
   'playwright-test': playwrightTest,
   plop,
+  pnpm,
   postcss,
   preconstruct,
   prettier,

packages/knip/src/plugins/index.ts

@@ -0,0 +1,15 @@
+import type { IsPluginEnabled, Plugin } from '../../types/config.js';
+
+// https://pnpm.io/pnpmfile
+
+const title = 'pnpm';
+
+const isEnabled: IsPluginEnabled = ({ manifest }) => Boolean(manifest.packageManager?.startsWith('pnpm@'));
+
+const config: string[] = ['.pnpmfile.cjs'];
+
+export default {
+  title,
+  isEnabled,
+  config,
+} satisfies Plugin;

packages/knip/src/plugins/pnpm/index.ts

@@ -76,6 +76,7 @@ export const pluginsSchema = z.object({
   'playwright-ct': pluginSchema,
   'playwright-test': pluginSchema,
   plop: pluginSchema,
+  pnpm: pluginSchema,
   postcss: pluginSchema,
   preconstruct: pluginSchema,
   prettier: pluginSchema,

packages/knip/src/schema/plugins.ts

@@ -63,6 +63,7 @@ export type PluginName =
   | 'playwright-ct'
   | 'playwright-test'
   | 'plop'
+  | 'pnpm'
   | 'postcss'
   | 'preconstruct'
   | 'prettier'
@@ -176,6 +177,7 @@ export const pluginNames = [
   'playwright-ct',
   'playwright-test',
   'plop',
+  'pnpm',
   'postcss',
   'preconstruct',
   'prettier',

packages/knip/src/types/PluginNames.ts

@@ -46,6 +46,7 @@ export type PackageJson = {
   browser?: string;
   types?: string;
   typings?: string;
+  packageManager?: string;
 } & Plugins;
 
 export type WorkspacePackage = {

packages/knip/src/types/package-json.ts

@@ -0,0 +1,19 @@
+import { test } from 'bun:test';
+import assert from 'node:assert/strict';
+import { main } from '../../src/index.js';
+import { createOptions } from '../../src/util/create-options.js';
+import baseCounters from '../helpers/baseCounters.js';
+import { resolve } from '../helpers/resolve.js';
+
+const cwd = resolve('fixtures/plugins/pnpm');
+
+test('Find dependencies with the pnpm plugin', async () => {
+  const options = await createOptions({ cwd });
+  const { counters } = await main(options);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 1,
+    total: 1,
+  });
+});