feat: add support for packageExtensions in yarn and pnpm (#1847)

trueberryless · web-flow · commit 61d3164cdac6 · 2026-07-04T16:48:21.000+02:00
diff --git a/packages/knip/fixtures/plugins/pnpm-workspace/.pnpmfile.cjs b/packages/knip/fixtures/plugins/pnpm-workspace/.pnpmfile.cjs
@@ -0,0 +1 @@
+module.exports = {};
diff --git a/packages/knip/fixtures/plugins/pnpm-workspace/package.json b/packages/knip/fixtures/plugins/pnpm-workspace/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@plugins/pnpm2",
+  "dependencies": {
+    "is-odd": "*"
+  }
+}
diff --git a/packages/knip/fixtures/plugins/pnpm-workspace/pnpm-lock.yaml b/packages/knip/fixtures/plugins/pnpm-workspace/pnpm-lock.yaml
diff --git a/packages/knip/fixtures/plugins/pnpm-workspace/pnpm-workspace.yaml b/packages/knip/fixtures/plugins/pnpm-workspace/pnpm-workspace.yaml
@@ -0,0 +1,6 @@
+packages:
+  - 'packages/*'
+packageExtensions:
+  react-csv@*:
+    peerDependencies:
+      is-odd: "*"
diff --git a/packages/knip/fixtures/plugins/pnpm/.pnpmfile.cjs b/packages/knip/fixtures/plugins/pnpm/.pnpmfile.cjs
@@ -0,0 +1 @@
+module.exports = {};
diff --git a/packages/knip/fixtures/plugins/pnpm/package.json b/packages/knip/fixtures/plugins/pnpm/package.json
@@ -1,3 +1,16 @@
 {
-  "packageManager": "pnpm@10.14.0"
+  "name": "@plugins/pnpm",
+  "packageManager": "pnpm@10.14.0",
+  "dependencies": {
+    "prop-types": "*"
+  },
+  "pnpm": {
+    "packageExtensions": {
+      "react-csv@*": {
+        "peerDependencies": {
+          "prop-types": "*"
+        }
+      }
+    }
+  }
 }
diff --git a/packages/knip/fixtures/plugins/pnpm2/.pnpmfile.cjs b/packages/knip/fixtures/plugins/pnpm2/.pnpmfile.cjs
diff --git a/packages/knip/fixtures/plugins/pnpm2/package.json b/packages/knip/fixtures/plugins/pnpm2/package.json
diff --git a/packages/knip/fixtures/plugins/pnpm2/pnpm-workspace.yaml b/packages/knip/fixtures/plugins/pnpm2/pnpm-workspace.yaml
diff --git a/packages/knip/fixtures/plugins/yarn/.yarnrc.yml b/packages/knip/fixtures/plugins/yarn/.yarnrc.yml
@@ -0,0 +1,4 @@
+packageExtensions:
+  react-csv@*:
+    peerDependencies:
+      prop-types: "*"
diff --git a/packages/knip/fixtures/plugins/yarn/package.json b/packages/knip/fixtures/plugins/yarn/package.json
@@ -1,5 +1,9 @@
 {
   "name": "@plugins/yarn",
+  "packageManager": "yarn@4.0.0",
+  "dependencies": {
+    "prop-types": "*"
+  },
   "devDependencies": {
     "@yarnpkg/types": "latest"
   }
diff --git a/packages/knip/src/plugins/pnpm/index.ts b/packages/knip/src/plugins/pnpm/index.ts
@@ -1,22 +1,51 @@
-import type { IsPluginEnabled, Plugin } from '../../types/config.ts';
+import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.ts';
 import { isFile } from '../../util/fs.ts';
+import type { Input } from '../../util/input.ts';
+import { toDependency, toEntry } from '../../util/input.ts';
+import type { PnpmConfig } from './types.ts';
 
-// https://pnpm.io/pnpmfile
+// https://pnpm.io/
 
 const title = 'pnpm';
 
+const enablers =
+  'This plugin is enabled when a `pnpm-lock.yaml` or `pnpm-workspace.yaml` file is found in the root directory, or when `pnpm@` is specified in the `packageManager` field of `package.json`.';
+
 const isEnabled: IsPluginEnabled = async ({ cwd, manifest }) =>
   manifest.packageManager?.startsWith('pnpm@') || isFile(cwd, 'pnpm-lock.yaml') || isFile(cwd, 'pnpm-workspace.yaml');
 
 const isRootOnly = true;
 
-const config: string[] = ['.pnpmfile.cjs'];
+const entry: string[] = ['.pnpmfile.{cjs,mjs}'];
+
+const config: string[] = ['package.json', 'pnpm-workspace.yaml'];
+
+const resolveConfig: ResolveConfig<PnpmConfig> = config => {
+  const inputs: Input[] = entry.map(toEntry);
+
+  const packageExtensions = config?.pnpm?.packageExtensions || config?.packageExtensions;
+
+  if (packageExtensions) {
+    for (const extension of Object.values(packageExtensions)) {
+      if (extension.peerDependencies) {
+        for (const dep of Object.keys(extension.peerDependencies)) {
+          inputs.push(toDependency(dep));
+        }
+      }
+    }
+  }
+
+  return inputs;
+};
 
 const plugin: Plugin = {
   title,
+  enablers,
   isEnabled,
   isRootOnly,
+  entry,
   config,
+  resolveConfig,
 };
 
 export default plugin;
diff --git a/packages/knip/src/plugins/pnpm/types.ts b/packages/knip/src/plugins/pnpm/types.ts
@@ -0,0 +1,10 @@
+import type { Dependencies, PackageJson } from '../../types/package-json.ts';
+
+export type PnpmConfig = PackageJson & {
+  packageExtensions?: Record<
+    string,
+    {
+      peerDependencies?: Dependencies;
+    }
+  >;
+};
diff --git a/packages/knip/src/plugins/yarn/index.ts b/packages/knip/src/plugins/yarn/index.ts
@@ -1,29 +1,27 @@
 import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.ts';
 import { isFile } from '../../util/fs.ts';
 import type { Input } from '../../util/input.ts';
-import { toEntry } from '../../util/input.ts';
+import { toDependency, toEntry } from '../../util/input.ts';
+import type { YarnConfig } from './types.ts';
 
-// https://yarnpkg.com/features/constraints
+// https://yarnpkg.com
 
 const title = 'Yarn';
 
-const enablers = 'This plugin is enabled when a `yarn.lock` file is found in the root folder.';
+const enablers =
+  'This plugin is enabled when a `yarn.lock` file is found in the root directory, or when `yarn@` is specified in the `packageManager` field of `package.json`.';
 
-const isEnabled: IsPluginEnabled = ({ cwd }) => isFile(cwd, 'yarn.lock');
+const isEnabled: IsPluginEnabled = async ({ cwd, manifest }) =>
+  manifest.packageManager?.startsWith('yarn@') || isFile(cwd, 'yarn.lock');
 
 const isRootOnly = true;
 
 const config = ['.yarnrc.yml'];
 
 const entry = ['yarn.config.cjs'];
 
-type YarnConfig = {
-  plugins?: Array<string | { path?: string }>;
-  yarnPath?: string;
-};
-
 const resolveConfig: ResolveConfig<YarnConfig> = config => {
-  const inputs: Input[] = entry.map(id => toEntry(id));
+  const inputs: Input[] = entry.map(toEntry);
 
   if (Array.isArray(config.plugins)) {
     for (const plugin of config.plugins) {
@@ -36,6 +34,16 @@ const resolveConfig: ResolveConfig<YarnConfig> = config => {
     inputs.push(toEntry(config.yarnPath));
   }
 
+  if (config.packageExtensions) {
+    for (const extension of Object.values(config.packageExtensions)) {
+      if (extension.peerDependencies) {
+        for (const dep of Object.keys(extension.peerDependencies)) {
+          inputs.push(toDependency(dep));
+        }
+      }
+    }
+  }
+
   return inputs;
 };
 
diff --git a/packages/knip/src/plugins/yarn/types.ts b/packages/knip/src/plugins/yarn/types.ts
@@ -0,0 +1,12 @@
+import type { Dependencies } from '../../types/package-json.ts';
+
+export type YarnConfig = {
+  plugins?: Array<string | { path?: string }>;
+  yarnPath?: string;
+  packageExtensions?: Record<
+    string,
+    {
+      peerDependencies?: Dependencies;
+    }
+  >;
+};
diff --git a/packages/knip/src/types/package-json.ts b/packages/knip/src/types/package-json.ts
@@ -4,8 +4,6 @@ type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
 type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
 
-type Dependencies = Record<string, string>;
-
 type C = 'import' | 'require' | 'node' | 'node-addons' | 'deno' | 'browser' | 'electron' | 'react-native' | 'default';
 type ExportCondition = LiteralUnion<C, string>;
 type Exports = null | string | string[] | { [key in ExportCondition]: Exports } | { [key: string]: Exports };
@@ -31,6 +29,8 @@ export type Scripts = Record<string, string>;
 export type Catalog = Record<string, string>;
 export type Catalogs = Record<string, Catalog>;
 
+export type Dependencies = Record<string, string>;
+
 export type PackageJson = {
   name?: string;
   main?: string;
@@ -57,6 +57,12 @@ export type PackageJson = {
   engines?: Record<string, string>;
   pnpm?: {
     overrides?: Dependencies;
+    packageExtensions?: Record<
+      string,
+      {
+        peerDependencies?: Dependencies;
+      }
+    >;
   };
   knip?: WorkspaceConfiguration;
 } & Plugins;
diff --git a/packages/knip/test/plugins/pnpm.test.ts b/packages/knip/test/plugins/pnpm.test.ts
@@ -1,13 +1,24 @@
 import assert from 'node:assert/strict';
-import { test } from 'node:test';
+import test from 'node:test';
 import { main } from '../../src/index.ts';
 import baseCounters from '../helpers/baseCounters.ts';
 import { createOptions } from '../helpers/create-options.ts';
 import { resolve } from '../helpers/resolve.ts';
 
-const cwd = resolve('fixtures/plugins/pnpm');
-
 test('Find dependencies with the pnpm plugin', async () => {
+  const cwd = resolve('fixtures/plugins/pnpm');
+  const options = await createOptions({ cwd });
+  const { counters } = await main(options);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 1,
+    total: 1,
+  });
+});
+
+test('Find dependencies with the pnpm plugin in pnpm-workspace.yaml', async () => {
+  const cwd = resolve('fixtures/plugins/pnpm-workspace');
   const options = await createOptions({ cwd });
   const { counters } = await main(options);
 
diff --git a/packages/knip/test/plugins/pnpm2.test.ts b/packages/knip/test/plugins/pnpm2.test.ts
diff --git a/packages/knip/test/plugins/yarn-berry.test.ts b/packages/knip/test/plugins/yarn-berry.test.ts
diff --git a/packages/knip/test/plugins/yarn.test.ts b/packages/knip/test/plugins/yarn.test.ts
@@ -5,17 +5,26 @@ import baseCounters from '../helpers/baseCounters.ts';
 import { createOptions } from '../helpers/create-options.ts';
 import { resolve } from '../helpers/resolve.ts';
 
-const cwd = resolve('fixtures/plugins/yarn');
-
 test('Find dependencies with the yarn plugin', async () => {
+  const cwd = resolve('fixtures/plugins/yarn');
   const options = await createOptions({ cwd });
-  const { issues, counters } = await main(options);
-
-  assert(Object.keys(issues.files).length === 0);
+  const { counters } = await main(options);
 
   assert.deepEqual(counters, {
     ...baseCounters,
     processed: 1,
     total: 1,
   });
 });
+
+test('Find dependencies with the yarn plugin (Berry)', async () => {
+  const cwd = resolve('fixtures/plugins/yarn-berry');
+  const options = await createOptions({ cwd });
+  const { counters } = await main(options);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 4,
+    total: 4,
+  });
+});
