Zoltan Kochan
77026ff61d
The storage layer serves three ecosystems but was named for one. Rename its vocabulary so a Cargo index file and a Simple API page are documents and a `.crate` and a wheel are blobs. `pnpr-storage` now exposes `read_hosted_document`, `open_hosted_blob`, `reserve_hosted_blob`, `finalize_blob_slot` and their peers on both the filesystem and the S3 backend, and a publish write conflict is `RegistryError::DocumentWriteConflict`, logged as `document_write_conflict`. `PackageName` keeps its name: it holds a package's name and never a version, and a name is what a crate and a Python project have too. The npm surfaces keep their own packument and tarball vocabulary, which is accurate there. Separately, a name now rejects `?`, `#`, `%`, whitespace, and control characters. A request path is percent-decoded before a handler parses a name from it, and a name is interpolated into the upstream URL, so `GET /foo%23bar` was authorized and cached as `foo#bar` while fetching `foo` — a package rule that named `foo` never ran. The journal manifest's `packument_file` and `tarballs` aliases had no coverage, so a sealed entry that spells its keys that way now has a recovery test. Related to pnpm/pnpm#14599.
简体中文 | 日本語 | 한국어 | 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 here.
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.