Zoltan Kochan
57c9cc7eb2
A scoped package was one escaped segment, so `@pnpm-testing/fresh` was stored as `packages/!40pnpm-testing!2ffresh/` and its tarball as `blobs/fresh-1.0.0.tgz`, repeating a name the directory already holds. The hosted store and the proxy cache now place every package two directories below `packages/`: - `@<scope>/<name>/` for a scoped name, `@/<name>/` for any other. No npm scope is empty, so `@` cannot collide with a scope. - A `.tgz`, `.sigstore` or `.crate` blob named `<basename>-<rest>` is stored as `<rest>`, so a tarball is `blobs/1.0.0.tgz`. Such a file that does not start with `<basename>-` (a non-canonical upstream tarball in the proxy cache) is stored with a leading `@`, which `encode_segment` never writes, so the two forms cannot collide. Every other file (OCI digests, PyPI wheels and sdists) keeps its name. - The rule keys on the extension rather than the ecosystem because `pnpr verify` and the image maintenance walk namespaces read from storage, where the ecosystem is not known. - The prefix is not stripped when the rest would be empty or start with `.`, so `foo-..tgz` cannot become a hidden `..tgz` file. Each segment is still `encode_segment`ed, so names that differ only in case stay apart on a case-insensitive filesystem. The mapping lives in `layout.rs` with strict inverses; every backend and listing goes through it, so no caller of the storage API changed. `LAYOUT_VERSION` stays 1: pnpr is experimental, and an existing store is republished rather than converted. `pnpr upgrade-storage` writes the new paths when converting a pre-marker store, and the fixture fingerprint hashes a sample path so cached fixture trees in the old layout are rebuilt.
简体中文 | 日本語 | 한국어 | 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.