chore(scripts): Use relaxed peer dependencies to avoid triggering maj…

…or version bumps (#4736)

- Add script to bump peer deps with changesets version

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>

.changeset/config.json

@@ -27,5 +27,8 @@
   "access": "public",
   "baseBranch": "dev",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": [],
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "onlyUpdatePeerDependentsWhenOutOfRange": true
+  }
 }

package.json

@@ -42,7 +42,7 @@
     "posttest:integration": "node ./integration/helpers/cleanup.mjs",
     "test:primary": "jest",
     "changeset": "changeset",
-    "changeset:version": "changeset version",
+    "changeset:version": "changeset version && node ./scripts/bump-peer-dep-ranges.mjs",
     "changeset:release": "yarn build --tsc --publish && changeset publish",
     "version": "node ./scripts/version.js",
     "version:experimental": "node ./scripts/version.js experimental",

packages/remix-dev/package.json

@@ -82,7 +82,7 @@
     "type-fest": "^2.16.0"
   },
   "peerDependencies": {
-    "@remix-run/serve": "1.8.2"
+    "@remix-run/serve": "^1.8.2"
   },
   "peerDependenciesMeta": {
     "@remix-run/serve": {

scripts/bump-peer-dep-ranges.mjs

@@ -0,0 +1,105 @@
+// Consider this scenario:
+// 1. Run `yarn changeset:version` to bump versions
+// 2. Changesets sees that a package has a minor change
+// 3. Because we release packages in lockstep, all packages get a minor update
+// 4. `@remix-run/dev` has "peerDependencies": { "@remix-run/serve": "1.8.0" }
+// 5. This dependency will now be out of range after the update
+// 6. Changesets makes the safe bet and updates `@remix-run/dev` to 2.0.0
+//    because it can't be sure this doesn't result in a breaking change
+// 7. Because we release packages in lockstep, all packages get a major update
+//
+// In practice, this means any `minor` changeset will result in a major bump,
+// which definitely isn't what we want.
+//
+// Instead, we relaxe the peer dependency range for internal packages. That way
+// the update doesn't result in an out-of-range peer dependency, and all
+// packages are bumped to the next minor release instead.
+//
+// Because changesets doesn't automatically bump peer dependencies with the
+// relaxed range (which makes sense in some cases), this script does that for
+// us. This makes the change safer because updating the leading dependency will
+// result in a peer dependency warning if the user doesn't bump the peer
+// dependency for some reason.
+//
+// Thanks to Mateusz Burzyński for the original script
+// Copyright (c) 2015 David Khourshid, MIT License
+// https://github.com/statelyai/xstate/blob/fb4786b80786d8ff3d44dfa818097b219dab623c/scripts/bump-peer-dep-ranges.js
+import { spawnSync } from "node:child_process";
+import * as fs from "node:fs";
+import path from "node:path";
+import * as url from "node:url";
+import { getPackagesSync } from "@manypkg/get-packages";
+
+const gitStatusResult = spawnSync("git", ["status", "--porcelain"]);
+
+if (gitStatusResult.status !== 0) {
+  process.exit(gitStatusResult.status || undefined);
+}
+
+const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
+const rootDir = path.join(__dirname, "..");
+
+const allPackages = getPackagesSync(rootDir).packages;
+const allPackageNames = allPackages.map((pkg) => pkg.packageJson.name);
+
+const pkgChanges = new Map(
+  gitStatusResult.stdout
+    .toString()
+    .trim()
+    .split("\n")
+    .filter((line) => /^\s*M\s+.*\/package.json/.test(line))
+    .map((line) => {
+      /**
+       * @type {string}
+       * This will always be defined but TS doesn't know that
+       * @ts-expect-error */
+      let gitPath = line.match(/[^\s]+package.json/)[0];
+      let fsPath = path.join(rootDir, gitPath);
+      let packageJson = require(fsPath);
+      let previousPackageJsonResult = spawnSync("git", [
+        "show",
+        `HEAD:${gitPath}`,
+      ]);
+
+      if (previousPackageJsonResult.status !== 0) {
+        process.exit(gitStatusResult.status || undefined);
+      }
+
+      return [
+        packageJson.name,
+        {
+          path: fsPath,
+          packageJson: packageJson,
+          versionChanged:
+            packageJson.version !==
+            JSON.parse(previousPackageJsonResult.stdout.toString().trim())
+              .version,
+        },
+      ];
+    })
+);
+
+for (let peerPkg of allPackageNames) {
+  let peerPkgChange = pkgChanges.get(peerPkg);
+  if (!peerPkgChange || !peerPkgChange.versionChanged) {
+    continue;
+  }
+
+  for (let dependentPkg of allPackages) {
+    let peerDeps = dependentPkg.packageJson.peerDependencies;
+    if (!peerDeps || !peerDeps[peerPkg]) {
+      continue;
+    }
+    let pkgJsonCopy = { ...dependentPkg.packageJson };
+    // TS not smart enough to realize we checked this before copying the object
+    // @ts-expect-error
+    pkgJsonCopy.peerDependencies[
+      peerPkg
+    ] = `^${peerPkgChange.packageJson.version}`;
+
+    fs.writeFileSync(
+      path.join(dependentPkg.dir, "package.json"),
+      JSON.stringify(pkgJsonCopy, null, 2) + "\n"
+    );
+  }
+}

scripts/tsconfig.json

@@ -8,6 +8,7 @@
     "forceConsistentCasingInFileNames": true,
     "allowSyntheticDefaultImports": true,
     "moduleResolution": "Node",
+    "module": "ESNext",
     "noEmit": true,
     "strict": true,
     "target": "ES2018"