Code Monkey home page Code Monkey logo

pnpm's Introduction

pnpm

Performant npm

pnpm is a fast implementation of npm install.

Status

Install

Install it via npm.

npm install -g pnpm.js

Use pnpm in place of npm. It overrides pnpm i and pnpm install—all other commands will passthru to npm.

pnpm install lodash

Preview release

pnpm will stay in <1.0.0 until it's achieved feature parity with npm install.

  • pnpm install
    • npm packages
    • GitHub-hosted packages (npm i rstacruz/scourjs)
    • @scoped packages (npm i @rstacruz/tap-spec)
    • tarball release packages (npm i http://foo.com/tar.tgz)
    • compiled packages (npm i node-sass)
    • bundled dependencies: handle bins (npm i [email protected])
    • file packages (npm i file:../path)
    • bin executables
    • --global installs
    • --save et al
  • pnpm uninstall
  • pnpm ls

Design

pnpm maintains a flat storage of all your dependencies in node_modules/.store. They are then symlinked whereever they're needed. This is like npm@2's recursive module handling (without the disk space bloat), and like npm@3s flat dependency tree (except with each module being predictably atomic). To illustrate, an installation of chalk@1.1.1 may look like this:

.
└─ node_modules/
   ├─ .store/
   │  ├─ [email protected]/
   │  │  └─ node_modules/
   │  │     ├─ ansi-styles      -> ../../[email protected]
   │  │     ├─ has-ansi         -> ../../[email protected]
   │  │     └─ supports-color   -> ../../[email protected]
   │  ├─ [email protected]/
   │  ├─ [email protected]/
   │  └─ [email protected]/
   └─ chalk                     -> .store/[email protected]

Benchmark

time npm i babel-preset-es2015 browserify chalk debug minimist mkdirp
    66.15 real        15.60 user         3.54 sys

time pnpm i babel-preset-es2015 browserify chalk debug minimist mkdirp
    11.04 real         6.85 user         2.85 sys

Prior art

ied is built on a very similar premise. pnpm takes huge inspiration from ied.

Unlike ied, however, pnpm will eventually be made to support a globally-shared store so you can keep all your npm modules in one place. With this goal in mind, pnpm also doesn't care much about npm@3's flat dependency tree style.

Thanks

pnpm © 2016+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz

pnpm's People

Contributors

rstacruz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.