b1737dcd9f
* docs(pnpm): docs for the package usages feature - Add documentation for `pnpm store usages` - Refactor docs for `pnpm store` to be more readable * feat(package-store): implement findPackageUsages Introduces functionality to search the package store for packages. Reports all matching packages and the node projects they are used in. Allows for searching a specific version, or all versions. * feat(server): expose findPackageUsages API Exposes an API for finding package usages in the store. * feat(store-controller-types): Exposes findPackageUsages store functionality Publicly exposes the findPackageUsages function in the store-controller. Also exposes the expected response type, allowing clients to be type-safe. * feat(supi): implement findStoreUsages functionality, add API Publicly exposes the findPackageUsages function SUPI. * feat(pnpm): pnpm store usages Enabled CLI command to find usages of a package in the global store. Pretty-prints a tree with queries and results. * style: remove semicolons Removed semicolons to follow style guide. * refactor(supi): change test after merge of #1528 * refactor: rename findPackageUsages return type Better naming of the types returned in the pnpm store usages feature. * tests: add tests for `pnpm store usages` Add tests to `supi` to ensure datamodel returned by `package-store` is correct. Fix test messages in `server` PR #1529
pnpm
Fast, disk space efficient package manager
Features:
- Fast. As fast as npm and Yarn.
- Efficient. One version of a package is saved only ever once on a disk.
- Great for multi-package repositories (a.k.a. monorepos). See the recursive commands.
- Strict. A package can access only dependencies that are specified in its
package.json. - Deterministic. Has a lockfile called
shrinkwrap.yaml. - Works everywhere. Works on Windows, Linux and OS X.
- Aliases. Install different versions of the same package or import it using a different name.
Like this project? Let people know with a tweet.
Table of Contents
Background
pnpm uses hard links and symlinks to save one version of a module only ever once on a disk.
When using npm or Yarn for example, if you have 100 projects using the same version
of lodash, you will have 100 copies of lodash on disk. With pnpm, lodash will be saved in a
single place on the disk and a hard link will put it into the node_modules where it should
be installed.
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.
Install
Using a standalone script:
curl -L https://unpkg.com/@pnpm/self-installer | node
Via npm:
npm install -g pnpm
Once you first installed pnpm, you can upgrade it using pnpm:
pnpm install -g pnpm
Do you wanna use pnpm on CI servers? See: Continuous Integration.
Usage
pnpm CLI
Just use pnpm in place of npm. For instance, to install run:
pnpm install lodash
For more advanced usage, read pnpm CLI on our website.
For using the programmatic API, use pnpm's engine: supi.
pnpx CLI
npm has a great package runner called npx.
pnpm offers the same tool via the pnpx command. The only difference is that pnpx uses pnpm for installing packages.
The following command installs a temporary create-react-app and calls it, without polluting global installs or requiring more than one step!
pnpx create-react-app my-cool-new-app
Benchmark
pnpm is as fast as npm and Yarn. See all benchmarks here.
Benchmarks on a React app:
Support
Contributors
This project exists thanks to all the people who contribute. [Contribute].
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
