Migrate to pnpm #11358
Migrate to pnpm #11358
Conversation
|
| @@ -17,5 +17,6 @@ | |||
| "access": "public", | |||
| "baseBranch": "dev", | |||
| "updateInternalDependencies": "patch", | |||
| "bumpVersionsWithWorkspaceProtocolOnly": true, | |||
There was a problem hiding this comment.
This setting is now enabled so that Changesets doesn't attempt to bump the react-router-dom dependency in react-router-dom-v5-compat since it's set to "4 || 5". This is a simpler method of achieving what the postversion.mjs script was doing since we can now use workspace dependencies.
| import * as path from "path"; | ||
| import { createRequire } from "node:module"; | ||
|
|
||
| // Changesets assumes that an internal peer dependency's version range should | ||
| // include the version of that package in our repo. This normally makes sense, | ||
| // but the compat package has a peer dependency on react-router-dom v4 or v5, so | ||
| // we need to: | ||
| // - Avoid validity checks for peer dependencies (done via patch package) | ||
| // - Reset the automatic version updates resulting from yarn changeset version | ||
| // (done via a simple node script) | ||
|
|
||
| const require = createRequire(import.meta.url); | ||
| const jsonfile = require("jsonfile"); | ||
|
|
||
| let file = path.join( | ||
| process.cwd(), | ||
| "packages/react-router-dom-v5-compat/package.json" | ||
| ); | ||
| let json = await jsonfile.readFile(file); | ||
| json.peerDependencies["react-router-dom"] = "4 || 5"; | ||
| await jsonfile.writeFile(file, json, { spaces: 2 }); | ||
|
|
||
| console.log("Patched peerDependencies for react-router-dom-v5-compat"); |
There was a problem hiding this comment.
This script can now be removed because we've enabled the Changesets bumpVersionsWithWorkspaceProtocolOnly setting, so this version range isn't bumped by Changesets anymore and doesn't need to be fixed after running changeset version.
| "scripts": { | ||
| "build": "rollup -c", | ||
| "clean": "git clean -fdX .", | ||
| "format": "prettier --ignore-path .eslintignore --write .", | ||
| "format:check": "prettier --ignore-path .eslintignore --check .", | ||
| "postinstall": "patch-package", |
There was a problem hiding this comment.
This feature is built into pnpm: https://pnpm.io/cli/patch
| @@ -0,0 +1,2 @@ | |||
| ignore-workspace-cycles=true | |||
There was a problem hiding this comment.
This is suppressing dependency warnings that only affect dev dependencies due to test code. Everything still works.
| @@ -0,0 +1,2 @@ | |||
| ignore-workspace-cycles=true | |||
| enable-pre-post-scripts=true | |||
There was a problem hiding this comment.
This is optional, but I've opted to keep automatic pre and post script behaviour so that the repo doesn't change too much in the migration. We can revisit this later.
| "workspaces": { | ||
| "packages": [ | ||
| "packages/react-router", | ||
| "packages/react-router-dom", | ||
| "packages/react-router-dom-v5-compat", | ||
| "packages/react-router-native", | ||
| "packages/router" | ||
| ] | ||
| }, |
There was a problem hiding this comment.
This is now configured in pnpm-workspace.yaml.
| modulePaths: [ | ||
| "<rootDir>/node_modules", // for react-native | ||
| ], | ||
| transformIgnorePatterns: [], |
There was a problem hiding this comment.
The modulePaths option as configured didn't work with pnpm's folder structure. A simpler way to solve the same problem is to simply tell Jest to transform everything.
| @@ -1,5 +1,6 @@ | |||
| /fixtures/ | |||
| node_modules/ | |||
| pnpm-lock.yaml | |||
There was a problem hiding this comment.
This is needed so that pnpm format doesn't format the lock file. We ran into an issue in the Remix repo where CI got stuck in a loop deduping and formatting pnpm-lock.yaml since pnpm and Prettier didn't agree, so this ensures we don't hit that problem again.
| @@ -29,7 +29,7 @@ import type { | |||
| Location, | |||
| RouteObject, | |||
| To, | |||
| } from "react-router-dom"; | |||
| } from "./index"; | |||
There was a problem hiding this comment.
pnpm didn't let us get away with our original approach.
|
🤖 Hello there, We just published version Thanks! |
|
🤖 Hello there, We just published version Thanks! |
I've added PR comments highlighting the notable changes below.