Flag undeclared sibling imports in published workspaces (resolve #1792)

webpro · webpro · commit aeabff789071 · 2026-06-15T11:29:04.000+02:00
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/package.json b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "@fixtures/workspace-sibling-undeclared",
+  "private": true,
+  "workspaces": ["packages/*"]
+}
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/consumer/index.ts b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/consumer/index.ts
@@ -0,0 +1,2 @@
+import { apple } from '@scope/fruit';
+export const x = apple;
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/consumer/package.json b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/consumer/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@scope/consumer"
+}
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/fruit/index.ts b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/fruit/index.ts
@@ -0,0 +1 @@
+export const apple = 'apple';
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/fruit/package.json b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/fruit/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "@scope/fruit"
+}
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/internal/index.ts b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/internal/index.ts
@@ -0,0 +1,2 @@
+import { apple } from '@scope/fruit';
+export const y = apple;
diff --git a/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/internal/package.json b/packages/knip/fixtures/workspaces/workspace-sibling-undeclared/packages/internal/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "@scope/internal",
+  "private": true
+}
diff --git a/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/package.json b/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "published-app"
+}
diff --git a/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/src/index.ts b/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/src/index.ts
@@ -0,0 +1,2 @@
+import { apple } from '@scope/fruit';
+export const y = apple;
diff --git a/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/tsconfig.json b/packages/knip/fixtures/workspaces/workspace-tspaths-undeclared/projects/published-app/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts"]
+}
diff --git a/packages/knip/src/DependencyDeputy.ts b/packages/knip/src/DependencyDeputy.ts
@@ -130,6 +130,7 @@ export class DependencyDeputy {
       requiredPeerDependencies,
       allDependencies: new Set(allDependencies),
       engines: manifest.engines ?? {},
+      isPrivate: Boolean(manifest.private),
     });
   }
 
@@ -226,7 +227,7 @@ export class DependencyDeputy {
 
     if (this._manifests.get(workspace.name)?.engines[packageName]) return true;
 
-    if (!this.isStrict && this.workspacePkgNames.has(packageName)) {
+    if (!this.isStrict && this.workspacePkgNames.has(packageName) && this._manifests.get(workspace.name)?.isPrivate) {
       this.addReferencedDependency(workspace.name, packageName);
       return true;
     }
diff --git a/packages/knip/src/types/package-json.ts b/packages/knip/src/types/package-json.ts
@@ -36,6 +36,7 @@ export type PackageJson = {
   main?: string;
   bin?: string | Record<string, string>;
   version?: string;
+  private?: boolean;
   workspaces?: string[] | { packages?: string[]; catalog?: Catalog; catalogs?: Catalogs };
   exports?: Exports;
   imports?: Imports;
diff --git a/packages/knip/src/types/workspace.ts b/packages/knip/src/types/workspace.ts
@@ -12,6 +12,7 @@ type WorkspaceManifest = {
   requiredPeerDependencies: DependencyArray;
   allDependencies: DependencySet;
   engines: Record<string, string>;
+  isPrivate: boolean;
   ignoreDependencies: (string | RegExp)[];
   ignoreBinaries: (string | RegExp)[];
   ignoreUnresolved: (string | RegExp)[];
diff --git a/packages/knip/test/cli/cli-reporter-github-actions.test.ts b/packages/knip/test/cli/cli-reporter-github-actions.test.ts
@@ -62,10 +62,11 @@ Unused dependencies (4)
 ::error file=apps/backend/package.json,line=8,endLine=8,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::next in apps/backend/package.json
 ::error file=package.json,line=11,endLine=11,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::minimist in package.json
 ::error file=package.json,line=13,endLine=13,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::zod in package.json
-Unlisted dependencies (3)
+Unlisted dependencies (4)
 ::error file=apps/backend/index.ts,line=3,endLine=3,col=24,endColumn=24,title=✂️ Knip / Unlisted dependencies::globby in apps/backend/index.ts
 ::error file=apps/backend/index.ts,line=4,endLine=4,col=18,endColumn=18,title=✂️ Knip / Unlisted dependencies::js-yaml in apps/backend/index.ts
 ::error file=apps/frontend/index.ts,line=3,endLine=3,col=19,endColumn=19,title=✂️ Knip / Unlisted dependencies::vanilla-js in apps/frontend/index.ts
+::error file=packages/tools/tsconfig.json,line=1,endLine=1,col=1,endColumn=1,title=✂️ Knip / Unlisted dependencies::@fixtures/workspaces__tsconfig in packages/tools/tsconfig.json
 Unused exports (1)
 ::error file=packages/tools/utils.ts,line=3,endLine=3,col=14,endColumn=14,title=✂️ Knip / Unused exports::helperFn in packages/tools/utils.ts
 Unused exported types (1)
@@ -88,10 +89,11 @@ Unused dependencies (4)
 ::error file=apps/backend/package.json,line=8,endLine=8,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::next in apps/backend/package.json
 ::error file=package.json,line=11,endLine=11,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::minimist in package.json
 ::error file=package.json,line=13,endLine=13,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::zod in package.json
-Unlisted dependencies (3)
+Unlisted dependencies (4)
 ::error file=apps/backend/index.ts,line=3,endLine=3,col=24,endColumn=24,title=✂️ Knip / Unlisted dependencies::globby in apps/backend/index.ts
 ::error file=apps/backend/index.ts,line=4,endLine=4,col=18,endColumn=18,title=✂️ Knip / Unlisted dependencies::js-yaml in apps/backend/index.ts
 ::error file=apps/frontend/index.ts,line=3,endLine=3,col=19,endColumn=19,title=✂️ Knip / Unlisted dependencies::vanilla-js in apps/frontend/index.ts
+::error file=packages/tools/tsconfig.json,line=1,endLine=1,col=1,endColumn=1,title=✂️ Knip / Unlisted dependencies::@fixtures/workspaces__tsconfig in packages/tools/tsconfig.json
 Unused exports (1)
 ::error file=packages/tools/utils.ts,line=3,endLine=3,col=14,endColumn=14,title=✂️ Knip / Unused exports::helperFn in packages/tools/utils.ts
 Unused exported types (1)
@@ -109,10 +111,11 @@ Unused dependencies (4)
 ::error file=apps/backend/package.json,line=8,endLine=8,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::next in apps/backend/package.json
 ::error file=package.json,line=11,endLine=11,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::minimist in package.json
 ::error file=package.json,line=13,endLine=13,col=6,endColumn=6,title=✂️ Knip / Unused dependencies::zod in package.json
-Unlisted dependencies (3)
+Unlisted dependencies (4)
 ::error file=apps/backend/index.ts,line=3,endLine=3,col=24,endColumn=24,title=✂️ Knip / Unlisted dependencies::globby in apps/backend/index.ts
 ::error file=apps/backend/index.ts,line=4,endLine=4,col=18,endColumn=18,title=✂️ Knip / Unlisted dependencies::js-yaml in apps/backend/index.ts
 ::error file=apps/frontend/index.ts,line=3,endLine=3,col=19,endColumn=19,title=✂️ Knip / Unlisted dependencies::vanilla-js in apps/frontend/index.ts
+::error file=packages/tools/tsconfig.json,line=1,endLine=1,col=1,endColumn=1,title=✂️ Knip / Unlisted dependencies::@fixtures/workspaces__tsconfig in packages/tools/tsconfig.json
 Unused exports (1)
 ::error file=packages/tools/utils.ts,line=3,endLine=3,col=14,endColumn=14,title=✂️ Knip / Unused exports::helperFn in packages/tools/utils.ts
 Unused exported types (1)
diff --git a/packages/knip/test/resolution/module-resolution-non-std-absolute.test.ts b/packages/knip/test/resolution/module-resolution-non-std-absolute.test.ts
@@ -11,18 +11,12 @@ 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/workspaces/basic.test.ts b/packages/knip/test/workspaces/basic.test.ts
@@ -21,10 +21,11 @@ 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, 2);
+  assert.equal(Object.keys(issues.unlisted).length, 3);
   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']);
 
@@ -34,7 +35,7 @@ test('Find unused dependencies, exports and files in workspaces (default)', asyn
     exports: 1,
     types: 1,
     dependencies: 4,
-    unlisted: 3,
+    unlisted: 4,
     processed: 7,
     total: 7,
   });
diff --git a/packages/knip/test/workspaces/workspace-selectors.test.ts b/packages/knip/test/workspaces/workspace-selectors.test.ts
@@ -53,7 +53,7 @@ test('Select workspaces by package name with wildcard', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 2,
-    unlisted: 3,
+    unlisted: 4,
     exports: 1,
     types: 1,
     processed: 7,
@@ -118,6 +118,7 @@ test('Exclude workspaces by directory glob pattern', async () => {
   assert.deepEqual(counters, {
     ...baseCounters,
     files: 1,
+    unlisted: 1,
     exports: 1,
     types: 1,
     processed: 7,
@@ -136,7 +137,7 @@ test('Exclude workspace by directory path', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 2,
-    unlisted: 2,
+    unlisted: 3,
     exports: 1,
     types: 1,
     processed: 7,
@@ -157,7 +158,7 @@ test('Only negation selector: exclude workspace from all', async () => {
     ...baseCounters,
     files: 1,
     dependencies: 4,
-    unlisted: 2,
+    unlisted: 3,
     exports: 1,
     types: 1,
     processed: 7,
diff --git a/packages/knip/test/workspaces/workspace-sibling-undeclared.test.ts b/packages/knip/test/workspaces/workspace-sibling-undeclared.test.ts
@@ -0,0 +1,38 @@
+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';
+
+const cwd = resolve('fixtures/workspaces/workspace-sibling-undeclared');
+
+test('Undeclared sibling import is unlisted in a published workspace, suppressed in a private one', async () => {
+  const options = await createOptions({ cwd });
+  const { issues, counters } = await main(options);
+
+  assert(issues.unlisted['packages/consumer/index.ts']['@scope/fruit']);
+  assert(!issues.unlisted['packages/internal/index.ts']?.['@scope/fruit']);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    unlisted: 1,
+    processed: 3,
+    total: 3,
+  });
+});
+
+test('strict mode flags undeclared sibling workspace regardless of visibility', async () => {
+  const options = await createOptions({ cwd, isStrict: true });
+  const { issues, counters } = await main(options);
+
+  assert(issues.unlisted['packages/consumer/index.ts']['@scope/fruit']);
+  assert(issues.unlisted['packages/internal/index.ts']?.['@scope/fruit']);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    unlisted: 2,
+    processed: 3,
+    total: 3,
+  });
+});
diff --git a/packages/knip/test/workspaces/workspace-tspaths-undeclared.test.ts b/packages/knip/test/workspaces/workspace-tspaths-undeclared.test.ts
@@ -5,24 +5,27 @@ 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 () => {
+test('undeclared sibling import is unlisted in a published workspace, not in a private one', async () => {
   const cwd = resolve('fixtures/workspaces/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(issues.unlisted['projects/published-app/src/index.ts']['@scope/fruit']);
 
   assert.deepEqual(counters, {
     ...baseCounters,
-    processed: 2,
-    total: 2,
+    unlisted: 1,
+    processed: 3,
+    total: 3,
   });
 });
 
-test('strict mode still flags undeclared sibling workspace as unlisted', async () => {
+test('strict mode flags undeclared sibling workspace regardless of visibility', async () => {
   const cwd = resolve('fixtures/workspaces/workspace-tspaths-undeclared');
-  const options = await createOptions({ cwd, isStrict: true, isProduction: false });
+  const options = await createOptions({ cwd, isStrict: true });
   const { issues } = await main(options);
 
   assert(issues.unlisted['projects/demo/src/index.ts']?.['@scope/fruit']);
+  assert(issues.unlisted['projects/published-app/src/index.ts']['@scope/fruit']);
 });

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
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "name": "@scope/consumer"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "name": "@scope/fruit"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import { apple } from '@scope/fruit';`
	`2`	`+export const y = apple;`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "@scope/internal",
 +  "private": true
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "name": "published-app"`
	`3`	`+}`