pnpm-shrinkwrap

> Read/write/prune and other utils for dealing with shrinkwrap.yaml files

Reads and writes the wanted (shrinkwrap.yaml) and current (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

$3

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.

$3

Alias: readPrivate

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

$3

Returns true if a shrinkwrap.yaml exists in the root of the package.

$3

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

$3

Writes the wanted shrinkwrap file only. Sometimes it is needed just to update the wanted shrinkwrap
without touching node_modules.

$3

Writes the current shrinkwrap file only. Fails if there is no node_modules directory in the pkgPath.

$3

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

$3

Prunes a shrinkwrap file using only the shrinkwrap object.

$3

$3

$3

Returns true if the shrinkwrap file resolves the dependencies in the package.json`.

License

MIT