fix: respect root package.json during pruning (#54)

MKruschke · web-flow · commit 5256b3c70da7 · 2026-03-20T12:09:06.000+01:00
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
   "name": "update-ts-references",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Updates TypeScript references automatically while using workspaces",
   "bin": "src/index.js",
   "scripts": {
     "lint": "eslint src tests",
-    "test": "scripts/prepareTests.sh && vitest run",
-    "vitest": "vitest run"
+    "test": "scripts/prepareTests.sh && vitest run --no-file-parallelism",
+    "vitest": "vitest run --no-file-parallelism"
   },
   "contributors": [
     {
diff --git a/src/update-ts-references.js b/src/update-ts-references.js
@@ -41,7 +41,9 @@ const getAllPackageJsons = async (workspaces, cwd) => {
     });
 
     return Promise.all(
-        workspaceGlobs.map((workspace) => fastGlob(`${workspace}/${PACKAGE_JSON}`, { cwd, onlyFiles: true }))
+        workspaceGlobs.map((workspace) =>
+            fastGlob(`${workspace}/${PACKAGE_JSON}`, { cwd, onlyFiles: true }).then((files) => files.sort())
+        )
     )
         .then((allPackages) =>
             allPackages.reduce(
@@ -109,6 +111,16 @@ const getPackageNamesAndPackageDir = (packageFilePaths, cwd) =>
         return map;
     }, new Map());
 
+const getDependencyNamesFromPackageJson = ({
+    dependencies = {},
+    peerDependencies = {},
+    devDependencies = {},
+} = {}) => Object.keys({
+    ...dependencies,
+    ...peerDependencies,
+    ...devDependencies,
+});
+
 const getReferencesFromDependencies = (
     configName,
     { packageDir },
@@ -325,8 +337,8 @@ const execute = async ({
 
     let tsconfigMap = {}
     let jsconfigMap = {}
-    const referencesMap = {}
     const referencedPackageNames = new Set()
+    const explicitRootReferenceNames = new Set(getDependencyNamesFromPackageJson(packageJson))
     const rootReferenceCandidates = []
     packagesMap.forEach((packageEntry, packageName) => {
         const detectedConfig = detectTSConfig(packageEntry.packageDir, configName, packageEntry.hasTsEntry && createTsConfig, cwd)
@@ -379,7 +391,6 @@ const execute = async ({
                 packagesMap,
                 verbose
             ) || []).map(ensurePosixPathStyle);
-            referencesMap[packageName] = references
             references.forEach(({ name }) => referencedPackageNames.add(name))
 
             const paths = getPathsFromReferences(references, tsconfigMap, jsconfigMap, ignorePathMappings)
@@ -406,7 +417,9 @@ const execute = async ({
         }
     });
 
-    const rootReferences = rootReferenceCandidates.filter(({ name }) => !referencedPackageNames.has(name));
+    const rootReferences = rootReferenceCandidates.filter(({ name }) =>
+        explicitRootReferenceNames.has(name) || !referencedPackageNames.has(name)
+    );
     const rootPaths = getPathsFromReferences(rootReferences, tsconfigMap, {}, ignorePathMappings)
 
     if (verbose) {
diff --git a/test-scenarios/prune-minimal/package.json b/test-scenarios/prune-minimal/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "prune-minimal-workspace",
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "workspace-a",
+    "workspace-b"
+  ],
+  "devDependencies": {
+    "typescript": "latest"
+  }
+}
diff --git a/test-scenarios/prune-minimal/tsconfig.json b/test-scenarios/prune-minimal/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "files": [],
+  "compilerOptions": {
+    "composite": true
+  }
+}
diff --git a/test-scenarios/prune-minimal/workspace-a/package.json b/test-scenarios/prune-minimal/workspace-a/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "workspace-a",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  }
+}
diff --git a/test-scenarios/prune-minimal/workspace-a/tsconfig.json b/test-scenarios/prune-minimal/workspace-a/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/test-scenarios/prune-minimal/workspace-b/package.json b/test-scenarios/prune-minimal/workspace-b/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "workspace-b",
+  "version": "1.0.0"
+}
diff --git a/test-scenarios/prune-minimal/workspace-b/tsconfig.json b/test-scenarios/prune-minimal/workspace-b/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  }
+}
diff --git a/test-scenarios/ts-paths/package.json b/test-scenarios/ts-paths/package.json
@@ -8,7 +8,14 @@
     "shared/*",
     "utils/**/"
   ],
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
   "devDependencies": {
+    "foo-a": "1.0.0",
     "typescript": "latest"
+  },
+  "peerDependencies": {
+    "foo-b": "1.0.0"
   }
 }
diff --git a/test-scenarios/yarn-ws-check-no-changes/package.json b/test-scenarios/yarn-ws-check-no-changes/package.json
@@ -8,7 +8,14 @@
     "shared/*",
     "utils/**"
   ],
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
   "devDependencies": {
+    "foo-a": "1.0.0",
     "typescript": "latest"
+  },
+  "peerDependencies": {
+    "workspace-c": "1.0.0"
   }
 }
diff --git a/test-scenarios/yarn-ws-check-no-changes/tsconfig.json b/test-scenarios/yarn-ws-check-no-changes/tsconfig.json
@@ -7,8 +7,17 @@
     {
       "path": "workspace-a"
     },
+    {
+      "path": "workspace-b"
+    },
+    {
+      "path": "shared/workspace-c"
+    },
     {
       "path": "shared/workspace-d"
+    },
+    {
+      "path": "utils/foos/foo-a"
     }
   ]
 }
diff --git a/test-scenarios/yarn-ws/package.json b/test-scenarios/yarn-ws/package.json
@@ -8,7 +8,14 @@
     "shared/*",
     "utils/**"
   ],
+  "dependencies": {
+    "workspace-b": "1.0.0"
+  },
   "devDependencies": {
+    "foo-a": "1.0.0",
     "typescript": "latest"
+  },
+  "peerDependencies": {
+    "workspace-c": "1.0.0"
   }
 }
diff --git a/tests/update-ts-references.check.test.js b/tests/update-ts-references.check.test.js
@@ -49,6 +49,33 @@ const rootTsConfig = [
     },
 ];
 
+const rootTsConfigWithRootDependencies = [
+    '.',
+    {
+        compilerOptions: {
+            composite: true,
+        },
+        files: [],
+        references: [
+            {
+                path: 'workspace-a',
+            },
+            {
+                path: 'workspace-b',
+            },
+            {
+                path: 'shared/workspace-c',
+            },
+            {
+                path: 'shared/workspace-d',
+            },
+            {
+                path: 'utils/foos/foo-a',
+            },
+        ],
+    },
+];
+
 const wsATsConfig = [
     './workspace-a',
     {
@@ -133,6 +160,16 @@ const tsconfigs = [
     fooBTsConfig,
 ];
 
+const tsconfigsWithRootDependencies = [
+    rootTsConfigWithRootDependencies,
+    wsATsConfig,
+    wsBTsConfig,
+    wsCTsConfig,
+    wsDTsConfig,
+    fooATsConfig,
+    fooBTsConfig,
+];
+
 
 test('Detect changes in references with the --check option', async () => {
     let errorCode = 0;
@@ -169,7 +206,7 @@ test('No changes in references detected with the --check option', async () => {
 
     expect(errorCode).toBe(0);
 
-    tsconfigs.forEach((tsconfig) => {
+    tsconfigsWithRootDependencies.forEach((tsconfig) => {
         const [configPath, config] = tsconfig;
 
         expect(
diff --git a/tests/update-ts-references.test.js b/tests/update-ts-references.test.js
@@ -20,6 +20,7 @@ const rootFolderYarnCreate = path.join(
 const rootFolderPnpm = path.join(process.cwd(), 'test-run', 'pnpm');
 const rootFolderTsPaths = path.join(process.cwd(), 'test-run', 'ts-paths');
 const rootFolderTsPathsIgnore = path.join(process.cwd(), 'test-run', 'ts-paths-ignore');
+const rootFolderPruneMinimal = path.join(process.cwd(), 'test-run', 'prune-minimal');
 
 const rootFolderLerna = path.join(process.cwd(), 'test-run', 'lerna');
 const rootFolderConfigName = path.join(
@@ -49,6 +50,33 @@ const rootTsConfig = [
     },
 ];
 
+const rootTsConfigWithRootDependencies = [
+    '.',
+    {
+        compilerOptions: {
+            composite: true,
+        },
+        files: [],
+        references: [
+            {
+                path: 'workspace-a',
+            },
+            {
+                path: 'workspace-b',
+            },
+            {
+                path: 'shared/workspace-c',
+            },
+            {
+                path: 'shared/workspace-d',
+            },
+            {
+                path: 'utils/foos/foo-a',
+            },
+        ],
+    },
+];
+
 const wsATsConfig = [
     './workspace-a',
     {
@@ -133,8 +161,8 @@ const tsconfigs = [
     fooBTsConfig,
 ];
 
-const tsconfigsIncludingPrepend = [
-    rootTsConfig,
+const tsconfigsIncludingPrependWithRootDependencies = [
+    rootTsConfigWithRootDependencies,
     [
         './workspace-a',
         {
@@ -203,7 +231,7 @@ test('avoid adding an empty compilerOptions', async () => {
 test('Support yarn and npm workspaces', async () => {
     await setup(rootFolderYarn);
 
-    tsconfigsIncludingPrepend.forEach((tsconfig) => {
+    tsconfigsIncludingPrependWithRootDependencies.forEach((tsconfig) => {
         const [configPath, config] = tsconfig;
 
         expect(
@@ -216,12 +244,50 @@ test('Support yarn and npm workspaces', async () => {
         parse(fs.readFileSync(path.join(rootFolderYarn, 'tsconfig.json')).toString()).references
     ).toEqual([
         { path: 'workspace-a' },
+        { path: 'workspace-b' },
+        { path: 'shared/workspace-c' },
         { path: 'shared/workspace-d' },
+        { path: 'utils/foos/foo-a' },
     ]);
     // still has the comment
     expect(fs.readFileSync(path.join(rootFolderYarn, 'tsconfig.json')).toString()).toMatch(/\/\* Basic Options \*\//)
 });
 
+test('Prune root references when the root package does not explicitly keep them', async () => {
+    await setup(rootFolderPruneMinimal);
+
+    expect(
+        parse(fs.readFileSync(path.join(rootFolderPruneMinimal, 'tsconfig.json')).toString())
+    ).toEqual({
+        files: [],
+        compilerOptions: {
+            composite: true,
+        },
+        references: [
+            {
+                path: 'workspace-a',
+            },
+        ],
+    });
+
+    expect(
+        parse(fs.readFileSync(path.join(rootFolderPruneMinimal, 'workspace-a', 'tsconfig.json')).toString())
+    ).toEqual({
+        compilerOptions,
+        references: [
+            {
+                path: '../workspace-b',
+            },
+        ],
+    });
+
+    expect(
+        parse(fs.readFileSync(path.join(rootFolderPruneMinimal, 'workspace-b', 'tsconfig.json')).toString())
+    ).toEqual({
+        compilerOptions,
+    });
+});
+
 test('Support lerna', async () => {
     await setup(rootFolderLerna);
 
@@ -267,13 +333,27 @@ test('create paths mappings ', async () => {
         {
             compilerOptions: {
                 composite: true,
-                paths: { "workspace-a": ["workspace-a/src"] }
+                paths: {
+                    "workspace-a": ["workspace-a/src"],
+                    "workspace-b": ["workspace-b"],
+                    "foo-a": ["utils/foos/foo-a/src"],
+                    "foo-b": ["utils/foos/foo-b/src"]
+                }
             },
             files: [],
             references: [
                 {
                     path: 'workspace-a',
                 },
+                {
+                    path: 'workspace-b',
+                },
+                {
+                    path: 'utils/foos/foo-a',
+                },
+                {
+                    path: 'utils/foos/foo-b',
+                },
             ],
         },
     ];

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "workspace-b",
 +  "version": "1.0.0"
 +}