Giter Club home page Giter Club logo

pnpm-shrinkwrap's Introduction

pnpm-shrinkwrap

Build Status

pnpm's shrinkwrap

Reads and writes the public (shrinkwrap.yaml) and private (node_modules/.shrinkwrap.yaml) shrinkwrap files of pnpm. Shrinkwrap files are the state files of the node_modules installed via pnpm. They are like the package-lock.json of npm or the yarn.lock of Yarn.

Install

npm i pnpm-shrinkwrap

API

readWanted(pkgPath, opts) => Promise<Shrinkwrap>

Alias: read

Reads the shrinkwrap.yaml file from the root of the package.

Arguments

  • pkgPath - Path - the path to the project
  • opts.ignoreIncompatible - Boolean - false by default. If true, throws an error if the shrinkwrap file format is not compatible with the current library.

readCurrent(pkgPath, opts) => Promise<Shrinkwrap>

Alias: readPrivate

Reads the shrinkwrap file from node_modules/.shrinkwrap.yaml.

write(pkgPath, wantedShrinkwrap, currentShrinkwrap) => Promise<void>

Writes the wanted/current shrinkwrap files. When they are empty, removes them.

prune(shrinkwrap, package) => Promise<Shrinkwrap>

Prunes a shrinkwrap file. Prunning means removing packages that are not referenced.

License

MIT

pnpm-shrinkwrap's People

Contributors

zkochan 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.