* docs: lint prose with Vale Add Vale with an in-repo style, .vale/styles/pnpm, that turns the writing rules in AGENTS.md and the Google developer documentation style guide into lint rules. The stock Vale packages (Google, Microsoft, RedHat, write-good) were too noisy to block on, for example 1,300 passive-voice hits in the v12 docs alone, so the rules are written for this repo, following the GitLab model. Each one links the guideline it enforces. Levels: - error, fails CI: dashes, plain-word substitutions, condescending words, "please", "note that", hedges, puffery, optional plurals, exclamation marks, ellipses, curly quotes, generic link text, product spellings, sentence-case headings, repeated words, double spaces, implementation history in comments; in changesets, bold or italic emphasis, internal names and release-line names. - warning: future tense, sentences over 30 words, "instead of" and "so that" tails in changesets. - suggestion: passive voice. .vale.ini scopes the rules. Docs get every rule. Contributor Markdown and code comments keep dashes and headings as warnings until their roughly 8,100 em dashes are rewritten. Released changesets stay in .changeset/ and are not rewritten, so lint-prose.mjs lints only the changesets added since PROSE_BASE (the PR base in CI). The prose workflow installs a pinned, checksum-verified Vale release and runs `pnpm lint:prose`. The rest of this change rewrites the existing docs, READMEs, contributor Markdown, and code comments to pass the error-level rules. Only prose and comment text changed. Renamed headings keep their anchors. Spelling stays with cspell, which checks identifiers that Vale does not see. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: keep prose lint from flattening meaning --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
3.5 KiB
3.5 KiB
id, title
| id | title |
|---|---|
| migration | Migrating from v10 to v11 |
pnpm v11 introduces several breaking changes to how configuration is read and which settings are available. Most config changes are mechanical and can be applied by a codemod; the remainder require human attention. pnpm prints a pointer to this page when pnpm self-update 11 is run from a v10 install.
Run the codemod
cd /path/to/your/project
pnpx codemod run pnpm-v10-to-v11
# or
pnpm add --global codemod
codemod run pnpm-v10-to-v11
The codemod applies the following automatically:
- Moves settings out of
package.json#pnpmintopnpm-workspace.yaml. In v11, pnpm no longer reads configuration from thepnpmfield inpackage.json. - Splits
.npmrcinto auth/registry vs. everything else. v11 only reads auth and registry settings from.npmrc. Every other setting (hoist-pattern,node-linker,save-exact, and so on) is moved intopnpm-workspace.yamlwith a camelCase key. Per-subproject.npmrcfiles land underpackageConfigs["<project-name>"]. - Consolidates build-dependency settings into
allowBuilds.onlyBuiltDependencies,neverBuiltDependencies,ignoredBuiltDependencies, andonlyBuiltDependenciesFileare merged into a singleallowBuildsmap ({ name: true | false }). - Replaces the package-manager strictness settings with
pmOnFail.managePackageManagerVersions,packageManagerStrict, andpackageManagerStrictVersionare collapsed into onepmOnFail: download | ignore | warn | errorsetting. - Renames
allowNonAppliedPatches→allowUnusedPatches, andauditConfig.ignoreCves→auditConfig.ignoreGhsas(the key is renamed; CVE IDs still need to be converted to GHSA IDs manually; see below). - Converts
useNodeVersioninto adevEngines.runtimeentry on the rootpackage.json. - Bumps
packageManagerinpackage.jsonto the target pnpm v11 version.
Manual follow-ups
The following changes are not automatable and need human attention:
- CVE → GHSA.
auditConfig.ignoreCveswas renamed toauditConfig.ignoreGhsas. Replace eachCVE-YYYY-NNNNNentry with the matchingGHSA-xxxx-xxxx-xxxxID (visible in the "More info" column ofpnpm auditoutput). ignorePatchFailureshas been removed. Failed patches now always throw; fix the patch or remove the dependency.executionEnv.nodeVersionin a workspace subpackage'spackage.json#pnpmis removed. Declare the runtime in that subpackage'sdevEngines.runtimeinstead.npm_config_*environment variables are no longer read. Rename them topnpm_config_*wherever they are set (CI configs, shell profiles, Docker images).- Docker images need to copy
pnpm-workspace.yamlif the project has one. Copy it beforepnpm installso project settings and workspace package patterns are available (see Working with Docker). pnpm link <pkg-name>no longer resolves packages from the global store. Use a relative or absolute path (pnpm link ./foo).pnpm install -g(with no arguments) is no longer supported. Usepnpm add -g <pkg>instead.pnpm serverhas been removed with no replacement.- Script names shadow built-in commands. If your
package.jsondefines a script namedclean,setup,deploy, orrebuild,pnpm <name>now runs the script instead of the built-in command. Usepnpm pm <name>to force the built-in.
For the full list of breaking changes, see the v11 changelog.