Unverified Commit aea417ab authored by Will Binns-Smith's avatar Will Binns-Smith Committed by GitHub

Avoid obsolete pnpm overrides in pack-next (#99199)

### What?

Make `pack-next` choose pnpm override locations from the destination
workspace root's pinned `packageManager` version.

### Why?

pnpm 11+ warns about `pnpm.overrides` in `package.json` and ignores that
setting. Conversely, rewriting `pnpm-workspace.yaml` for older pnpm
versions creates unnecessary churn.

### How?

Use the repository's `semver` package to read the major from a pinned
pnpm version. For a pnpm 11+ destination, merge overrides into the
existing/detected pnpm workspace file without adding `pnpm.overrides` to
`package.json`. For pnpm 10 and older, update only the package.json
field. When the pin is missing or unusable, retain the previous
dual-write behavior. Existing user overrides and npm/Yarn override
behavior are preserved.

### Verification

- Passed eleven temporary destination scenarios covering pinned
older/newer pnpm, existing overrides and workspace files, nested
workspace roots, and unknown versions.
- Prettier check, Node syntax check, and `git diff --check` passed.
- Repo-wide lint/typecheck not run (root dependencies are not installed
in this checkout).

<!-- NEXT_JS_LLM -->


<!-- fleet e86eb7e1-c05e-4e30-9285-7c5595ccb36f -->

---------
Co-authored-by: 's avatarvercel-fleet-prod[bot] <318278635+vercel-fleet-prod[bot]@users.noreply.github.com>
Co-authored-by: 's avatarWill Binns-Smith <755844+wbinnssmith@users.noreply.github.com>
parent bd6bdd1a
......@@ -2,6 +2,7 @@ import fs from 'node:fs/promises'
import path from 'node:path'
import { fileURLToPath } from 'node:url'
import os from 'node:os'
import semver from 'semver'
export interface DependencyPaths {
nextTarball: string
......@@ -23,6 +24,7 @@ export interface PackageJson {
overrides?: Record<string, string>
resolutions?: Record<string, string>
pnpm?: { overrides?: Record<string, string>; [key: string]: unknown }
packageManager?: string
workspaces?: string[] | { packages: string[] }
[key: string]: unknown
}
......@@ -40,19 +42,22 @@ export default async function patchPackageJson(
const packageJsonPath = await findPackageJsonPath(targetProjectPath)
const workspaceRoot = path.dirname(packageJsonPath)
const packageJsonValue = await readJsonValue(packageJsonPath)
const pnpmMajorVersion = getPnpmMajorVersion(
packageJsonValue.packageManager
)
const overrides = await patchWorkspacePackageJsonMap(
paths,
packageJsonValue
packageJsonValue,
pnpmMajorVersion
)
await writeJsonValue(packageJsonPath, packageJsonValue)
// Also mirror overrides into pnpm-workspace.yaml so pnpm v11+ picks them
// up. We don't try to detect the pnpm version — pnpm v10 reads
// `pnpm.overrides` (written above) and pnpm v11+ reads
// `pnpm-workspace.yaml#overrides`. To avoid dropping a pnpm-workspace.yaml
// into non-pnpm projects, we only write the file if it already exists or
// if a `pnpm-lock.yaml` indicates this is a pnpm project. See
// https://pnpm.io/settings and https://github.com/pnpm/pnpm/issues/11536.
if (await shouldWritePnpmWorkspace(workspaceRoot)) {
// pnpm v11+ reads overrides from pnpm-workspace.yaml, while older versions
// read pnpm.overrides from package.json. For an unknown version, keep writing
// both. Only write a workspace file when one or a pnpm lockfile already exists.
if (
(pnpmMajorVersion === null || pnpmMajorVersion >= 11) &&
(await shouldWritePnpmWorkspace(workspaceRoot))
) {
await mergePnpmWorkspaceOverrides(
workspaceRoot,
Object.fromEntries(overrides)
......@@ -97,7 +102,8 @@ async function writeJsonValue(
async function patchWorkspacePackageJsonMap(
paths: DependencyPaths,
packageJsonMap: PackageJson
packageJsonMap: PackageJson,
pnpmMajorVersion: number | null
): Promise<[string, string][]> {
const nextPeerDeps = await getNextPeerDeps()
......@@ -119,11 +125,13 @@ async function patchWorkspacePackageJsonMap(
packageJsonMap.resolutions = packageJsonMap.resolutions || {}
insertMapEntries(packageJsonMap.resolutions, overrides)
// pnpm v10 and below read `pnpm.overrides` from package.json.
// pnpm v11+ reads `pnpm-workspace.yaml#overrides` (written separately).
packageJsonMap.pnpm = packageJsonMap.pnpm || {}
packageJsonMap.pnpm.overrides = packageJsonMap.pnpm.overrides || {}
insertMapEntries(packageJsonMap.pnpm.overrides, overrides)
// pnpm v11+ ignores pnpm.overrides and warns if it is present.
// Keep writing it when the destination's pnpm version is unknown.
if (pnpmMajorVersion === null || pnpmMajorVersion < 11) {
packageJsonMap.pnpm = packageJsonMap.pnpm || {}
packageJsonMap.pnpm.overrides = packageJsonMap.pnpm.overrides || {}
insertMapEntries(packageJsonMap.pnpm.overrides, overrides)
}
// Add @next/swc to dependencies
packageJsonMap.dependencies = packageJsonMap.dependencies || {}
......@@ -166,6 +174,18 @@ async function getNextPeerDeps(): Promise<NextPeerDeps> {
}
}
function getPnpmMajorVersion(
packageManager: string | undefined
): number | null {
if (
typeof packageManager !== 'string' ||
!packageManager.startsWith('pnpm@')
) {
return null
}
return semver.parse(packageManager.slice('pnpm@'.length))?.major ?? null
}
async function shouldWritePnpmWorkspace(
workspaceRoot: string
): Promise<boolean> {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment