store prune (#17327)
The CAS prune removed a store file whose hard-link count was 1. A package imported with clone or copy leaves its store files at one link while a project still uses it. That is every patched or built package, every package under packageImportMethod: copy, and every package of a macOS clone. So the prune removed them, and the next install downloaded them again. The prune now also keeps every file that a registered project's installed lockfile references: - For each registered project it reads <modulesDir>/.pnpm/lock.yaml and the lock.yaml in the virtualStoreDir recorded in <modulesDir>/.modules.yaml. modulesDir comes from the nearest pnpm-workspace.yaml at or above the registered directory. - Each package's store index keys come from the install's own key functions: both keys of a git-hosted package, the manifest-keyed and plain keys of a runtime, and every variant of a variations resolution. - Every file of each row is kept, including each side-effects entry. - A project with no installed lockfile and a package with no row add nothing, so the hard-link check still decides for them. - A lockfile of an unsupported version is skipped with a warning. A lockfile, .modules.yaml, pnpm-workspace.yaml, or store index row that cannot be read fails the prune with ERR_PNPM_STORE_DIR_PRUNE_IN_USE_FILES. Registry errors keep their own codes. In pnpm 12, StoreDir::prune_keeping runs a caller's collector under the prune lock, and the CLI supplies the collector because store-dir does not depend on the lockfile crate. pnpm 11 collects before any removal. pnpm 11 and pnpm 12 share one store. pnpm 12 keys a runtime row with its synthesized manifest, so the pnpm 11 collector also keeps package-manifest keys whose tail it references. It scans the index keys only when a lockfile holds a runtime. A modulesDir set only on the command line, in the environment, in the global config, or in packageConfigs is not seen. --------- Co-authored-by: Zoltan Kochan <z@kochan.io> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
简体中文 | 日本語 | 한국어 | Italiano | Português Brasileiro
Fast, disk space efficient package manager:
- Fast. Up to 2x faster than the alternatives (see benchmark).
- Efficient. Files inside
node_modulesare linked from a single content-addressable storage. - Great for monorepos.
- Strict. A package can access only dependencies that are specified in its
package.json. - Deterministic. Has a lockfile called
pnpm-lock.yaml. - Works as a Node.js version manager. See pnpm runtime.
- Works everywhere. Supports Windows, Linux, and macOS.
- Battle-tested. Used in production by teams of all sizes since 2016.
- Experimental Rust port. Includes pacquet, an experimental port of the CLI written in Rust.
- See the full feature comparison with npm and Yarn.
To quote the Rush team:
Microsoft uses pnpm in Rush repos with hundreds of projects and hundreds of PRs per day, and we've found it to be very fast and reliable.
Platinum Sponsors
|
|
|
|
|
|
Gold Sponsors
|
|
|
|
|
|
|
|
|
|
|
Silver Sponsors
|
|
|
|
|
|
|
|
|
|
|
| ⏱️ Time.now |
Support this project by becoming a sponsor.
Background
pnpm uses a content-addressable filesystem to store all files from all module directories on a disk. When using npm, if you have 100 projects using lodash, you will have 100 copies of lodash on disk. With pnpm, lodash will be stored in a content-addressable storage, so:
- If you depend on different versions of lodash, only the files that differ are added to the store.
If lodash has 100 files, and a new version has a change only in one of those files,
pnpm updatewill only add 1 new file to the storage. - All the files are saved in a single place on the disk. When packages are installed, their files are linked from that single place consuming no additional disk space. Linking is performed using either hard-links or reflinks (copy-on-write).
As a result, you save gigabytes of space on your disk and you have a lot faster installations.
If you'd like more details about the unique node_modules structure that pnpm creates and
why it works fine with the Node.js ecosystem, read this small article: Flat node_modules is not the only way.
💖 Like this project? Let people know with a tweet
Getting Started
Benchmark
pnpm is up to 2x faster than npm and Yarn classic. See all benchmarks.
Benchmarks on an app with lots of dependencies:
License
MIT, except the pnpr/ directory, which is source-available under the PolyForm Shield License 1.0.0.