Don't flag undeclared sibling workspace imports as unlisted (#1742)

webpro · webpro · commit e7122a1ae74d · 2026-05-13T10:12:22.000+02:00
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/package.json b/packages/knip/fixtures/workspace-tspaths-undeclared/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "@fixtures/workspace-tspaths-undeclared",
+  "private": true,
+  "workspaces": ["projects/*"]
+}
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/package.json b/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "demo",
+  "private": true
+}
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/src/index.ts b/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/src/index.ts
@@ -0,0 +1,2 @@
+import { apple } from '@scope/fruit';
+export const x = apple;
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/tsconfig.json b/packages/knip/fixtures/workspace-tspaths-undeclared/projects/demo/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts"]
+}
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/projects/lib-fruit/package.json b/packages/knip/fixtures/workspace-tspaths-undeclared/projects/lib-fruit/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "@scope/fruit",
+  "private": true
+}
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/projects/lib-fruit/src/index.ts b/packages/knip/fixtures/workspace-tspaths-undeclared/projects/lib-fruit/src/index.ts
@@ -0,0 +1 @@
+export const apple = 'apple';
diff --git a/packages/knip/fixtures/workspace-tspaths-undeclared/tsconfig.json b/packages/knip/fixtures/workspace-tspaths-undeclared/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./",
+    "paths": {
+      "@scope/fruit": ["projects/lib-fruit/src/index"],
+      "@scope/fruit/*": ["projects/lib-fruit/src/*"]
+    }
+  }
+}
diff --git a/packages/knip/src/DependencyDeputy.ts b/packages/knip/src/DependencyDeputy.ts
@@ -43,6 +43,7 @@ export class DependencyDeputy {
   isStrict;
   isReportDependencies;
   _manifests: WorkspaceManifests = new Map();
+  workspacePkgNames: Set<string> = new Set();
   referencedDependencies: Map<string, Set<string>>;
   referencedBinaries: Map<string, Set<string>>;
   hostDependencies: Map<string, HostDependencies>;
@@ -140,6 +141,10 @@ export class DependencyDeputy {
     return this._manifests.get(workspaceName);
   }
 
+  public setWorkspacePkgNames(pkgNames: Iterable<string>) {
+    this.workspacePkgNames = new Set(pkgNames);
+  }
+
   getProductionDependencies(workspaceName: string): DependencyArray {
     const manifest = this._manifests.get(workspaceName);
     if (!manifest) return [];
@@ -236,6 +241,11 @@ export class DependencyDeputy {
 
     if (this._manifests.get(workspace.name)?.engines[packageName]) return true;
 
+    if (!this.isStrict && this.workspacePkgNames.has(packageName)) {
+      this.addReferencedDependency(workspace.name, packageName);
+      return true;
+    }
+
     if (!this.isStrict) {
       for (const name of workspaceNames) {
         const hosts = this.getHostDependenciesFor(name, packageName);
diff --git a/packages/knip/src/graph/build.ts b/packages/knip/src/graph/build.ts
@@ -98,6 +98,8 @@ export async function build({
     counselor.addWorkspace(manifest);
   }
 
+  deputy.setWorkspacePkgNames(chief.availableWorkspacePkgNames);
+
   collector.addIgnorePatterns(chief.config.ignore.map(id => ({ pattern: prependDir(options.cwd, id), id })));
   collector.addIgnoreFilesPatterns(chief.config.ignoreFiles.map(id => ({ pattern: prependDir(options.cwd, id), id })));
 
diff --git a/packages/knip/test/module-resolution-non-std-absolute.test.ts b/packages/knip/test/module-resolution-non-std-absolute.test.ts
@@ -11,12 +11,18 @@ test('Resolve non-standard absolute specifiers', async () => {
   const options = await createOptions({ cwd });
   const { issues, counters } = await main(options);
 
-  assert(issues.unlisted['x-self/index.ts']['x-other']);
+  assert(!issues.unlisted['x-self/index.ts']?.['x-other']);
 
   assert.deepEqual(counters, {
     ...baseCounters,
-    unlisted: 1,
     processed: 1,
     total: 1,
   });
 });
+
+test('Resolve non-standard absolute specifiers (strict flags sibling workspace)', async () => {
+  const options = await createOptions({ cwd, isStrict: true, isProduction: false });
+  const { issues } = await main(options);
+
+  assert(issues.unlisted['x-self/index.ts']['x-other']);
+});
diff --git a/packages/knip/test/workspace-selectors.test.ts b/packages/knip/test/workspace-selectors.test.ts
@@ -53,7 +53,7 @@ test('Select workspaces by package name with wildcard', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 2,
-    unlisted: 4,
+    unlisted: 3,
     exports: 1,
     types: 1,
     processed: 7,
@@ -118,7 +118,6 @@ test('Exclude workspaces by directory glob pattern', async () => {
   assert.deepEqual(counters, {
     ...baseCounters,
     files: 1,
-    unlisted: 1,
     exports: 1,
     types: 1,
     processed: 7,
@@ -137,7 +136,7 @@ test('Exclude workspace by directory path', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 2,
-    unlisted: 3,
+    unlisted: 2,
     exports: 1,
     types: 1,
     processed: 7,
@@ -158,7 +157,7 @@ test('Only negation selector: exclude workspace from all', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 4,
-    unlisted: 3,
+    unlisted: 2,
     exports: 1,
     types: 1,
     processed: 7,
diff --git a/packages/knip/test/workspace-tspaths-undeclared.test.ts b/packages/knip/test/workspace-tspaths-undeclared.test.ts
@@ -0,0 +1,28 @@
+import assert from 'node:assert/strict';
+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';
+
+test('import of sibling workspace via tsconfig paths is not unlisted', async () => {
+  const cwd = resolve('fixtures/workspace-tspaths-undeclared');
+  const options = await createOptions({ cwd });
+  const { issues, counters } = await main(options);
+
+  assert(!issues.unlisted['projects/demo/src/index.ts']?.['@scope/fruit']);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 2,
+    total: 2,
+  });
+});
+
+test('strict mode still flags undeclared sibling workspace as unlisted', async () => {
+  const cwd = resolve('fixtures/workspace-tspaths-undeclared');
+  const options = await createOptions({ cwd, isStrict: true, isProduction: false });
+  const { issues } = await main(options);
+
+  assert(issues.unlisted['projects/demo/src/index.ts']?.['@scope/fruit']);
+});
diff --git a/packages/knip/test/workspaces.test.ts b/packages/knip/test/workspaces.test.ts
@@ -21,11 +21,10 @@ test('Find unused dependencies, exports and files in workspaces (default)', asyn
   assert(issues.dependencies['apps/backend/package.json']['next']);
   assert(issues.dependencies['apps/backend/package.json']['picomatch']);
 
-  assert.equal(Object.keys(issues.unlisted).length, 3);
+  assert.equal(Object.keys(issues.unlisted).length, 2);
   assert(issues.unlisted['apps/frontend/index.ts']['vanilla-js']);
   assert(issues.unlisted['apps/backend/index.ts']['globby']);
   assert(issues.unlisted['apps/backend/index.ts']['js-yaml']);
-  assert(issues.unlisted['packages/tools/tsconfig.json']['@fixtures/workspaces__tsconfig']);
 
   assert(issues.types['packages/shared/types.ts']['UnusedEnum']);
 
@@ -35,7 +34,7 @@ test('Find unused dependencies, exports and files in workspaces (default)', asyn
     exports: 1,
     types: 1,
     dependencies: 4,
-    unlisted: 4,
+    unlisted: 3,
     processed: 7,
     total: 7,
   });

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "demo",
 +  "private": true
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import { apple } from '@scope/fruit';`
	`2`	`+export const x = apple;`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,8 @@ export async function build({`
`98`	`98`	`counselor.addWorkspace(manifest);`
`99`	`99`	`}`
`100`	`100`
	`101`	`+ deputy.setWorkspacePkgNames(chief.availableWorkspacePkgNames);`
	`102`	`+`
`101`	`103`	`collector.addIgnorePatterns(chief.config.ignore.map(id => ({ pattern: prependDir(options.cwd, id), id })));`
`102`	`104`	`collector.addIgnoreFilesPatterns(chief.config.ignoreFiles.map(id => ({ pattern: prependDir(options.cwd, id), id })));`
`103`	`105`