Fixed a regression that caused changeset version to fail on package…

…s having a dev dependency on a skipped package (#1370)
changesets · May 28, 2024 · 5e9d33a · 5e9d33a
1 parent e3f4a50
commit 5e9d33a
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 13 deletions.
diff --git a/.changeset/popular-readers-check.md b/.changeset/popular-readers-check.md
@@ -0,0 +1,5 @@
+---
+"@changesets/cli": major
+---
+
+Fixed a regression that caused `changeset version` to fail on packages having a dev dependency on a skipped package.
diff --git a/.changeset/smart-goats-smash.md b/.changeset/smart-goats-smash.md
@@ -0,0 +1,5 @@
+---
+"@changesets/get-dependents-graph": minor
+---
+
+Added a new `ignoreDevDependencies` option
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -12,7 +12,8 @@
       "disableOptimisticBPs": true,
       "windows": {
         "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-      }
+      },
+      "smartStep": false
     }
   ]
 }
diff --git a/packages/cli/src/run.test.ts b/packages/cli/src/run.test.ts
@@ -100,6 +100,41 @@ describe("cli", () => {
       expect(loggerErrorCalls.length).toEqual(0);
     });
 
+    it("should not throw on a dev dependent on an unversioned private package", async () => {
+      const cwd = await testdir({
+        "package.json": JSON.stringify({
+          private: true,
+          workspaces: ["packages/*"],
+        }),
+        "packages/pkg-a/package.json": JSON.stringify({
+          name: "pkg-a",
+          version: "1.0.0",
+          devDependencies: {
+            "pkg-b": "1.0.0",
+          },
+        }),
+        "packages/pkg-b/package.json": JSON.stringify({
+          name: "pkg-b",
+          version: "1.0.0",
+          private: true,
+        }),
+        ".changeset/config.json": JSON.stringify({
+          privatePackages: {
+            tag: false,
+            version: false,
+          },
+        }),
+      });
+      try {
+        await run(["version"], {}, cwd);
+      } catch (e) {
+        // ignore the error. We just want to validate the error message
+      }
+
+      const loggerErrorCalls = (error as any).mock.calls;
+      expect(loggerErrorCalls.length).toEqual(0);
+    });
+
     it("should throw if `--ignore` flag is used while ignore array is also defined in the config file ", async () => {
       const cwd = await testdir({
         "package.json": JSON.stringify({

diff --git a/packages/cli/src/run.ts b/packages/cli/src/run.ts
@@ -147,6 +147,7 @@ export async function run(
 
         // validate that all dependents of skipped packages are also skipped
         const dependentsGraph = getDependentsGraph(packages, {
+          ignoreDevDependencies: true,
           bumpVersionsWithWorkspaceProtocolOnly:
             config.bumpVersionsWithWorkspaceProtocolOnly,
         });

diff --git a/packages/get-dependents-graph/src/get-dependency-graph.ts b/packages/get-dependents-graph/src/get-dependency-graph.ts
@@ -11,7 +11,10 @@ const DEPENDENCY_TYPES = [
   "optionalDependencies",
 ] as const;
 
-const getAllDependencies = (config: PackageJSON) => {
+const getAllDependencies = (
+  config: PackageJSON,
+  ignoreDevDependencies: boolean
+) => {
   const allDependencies = new Map<string, string>();
 
   for (const type of DEPENDENCY_TYPES) {
@@ -21,8 +24,10 @@ const getAllDependencies = (config: PackageJSON) => {
     for (const name of Object.keys(deps)) {
       const depRange = deps[name];
       if (
-        (depRange.startsWith("link:") || depRange.startsWith("file:")) &&
-        type === "devDependencies"
+        type === "devDependencies" &&
+        (ignoreDevDependencies ||
+          depRange.startsWith("link:") ||
+          depRange.startsWith("file:"))
       ) {
         continue;
       }
@@ -50,9 +55,13 @@ const getValidRange = (potentialRange: string) => {
 
 export default function getDependencyGraph(
   packages: Packages,
-  opts?: {
+  {
+    ignoreDevDependencies = false,
+    bumpVersionsWithWorkspaceProtocolOnly = false,
+  }: {
+    ignoreDevDependencies?: boolean;
     bumpVersionsWithWorkspaceProtocolOnly?: boolean;
-  }
+  } = {}
 ): {
   graph: Map<string, { pkg: Package; dependencies: Array<string> }>;
   valid: boolean;
@@ -77,7 +86,10 @@ export default function getDependencyGraph(
   for (const pkg of queue) {
     const { name } = pkg.packageJson;
     const dependencies = [];
-    const allDependencies = getAllDependencies(pkg.packageJson);
+    const allDependencies = getAllDependencies(
+      pkg.packageJson,
+      ignoreDevDependencies
+    );
 
     for (let [depName, depRange] of allDependencies) {
       const match = packagesByName[depName];
@@ -93,7 +105,7 @@ export default function getDependencyGraph(
           dependencies.push(depName);
           continue;
         }
-      } else if (opts?.bumpVersionsWithWorkspaceProtocolOnly === true) {
+      } else if (bumpVersionsWithWorkspaceProtocolOnly) {
         continue;
       }
 

diff --git a/packages/get-dependents-graph/src/index.ts b/packages/get-dependents-graph/src/index.ts
@@ -3,14 +3,14 @@ import getDependencyGraph from "./get-dependency-graph";
 
 export function getDependentsGraph(
   packages: Packages,
-  opts?: { bumpVersionsWithWorkspaceProtocolOnly?: boolean }
+  opts?: {
+    ignoreDevDependencies?: boolean;
+    bumpVersionsWithWorkspaceProtocolOnly?: boolean;
+  }
 ) {
   const graph: Map<string, { pkg: Package; dependents: string[] }> = new Map();
 
-  const { graph: dependencyGraph } = getDependencyGraph(packages, {
-    bumpVersionsWithWorkspaceProtocolOnly:
-      opts?.bumpVersionsWithWorkspaceProtocolOnly === true,
-  });
+  const { graph: dependencyGraph } = getDependencyGraph(packages, opts);
 
   const dependentsLookup: {
     [key: string]: { pkg: Package; dependents: Array<string> };