Reads and writes the wanted (pnpm-lock.yaml) and current (node_modules/.pnpm-lock.yaml) lockfile files of pnpm. Lockfile 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

<pnpm|yarn|npm> add @pnpm/lockfile-file

API

`readWantedLockfile(pkgPath, opts) => Promise<Lockfile>`

Alias: read

Reads the pnpm-lock.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 lockfile file format is not compatible with the current library.

`readCurrentLockfile(pkgPath, opts) => Promise<Lockfile>`

Alias: readPrivate

Reads the lockfile file from node_modules/.pnpm-lock.yaml.

`existsWantedLockfile(pkgPath) => Promise<Boolean>`

Returns true if a pnpm-lock.yaml exists in the root of the package.

`writeLockfiles(pkgPath, wantedLockfile, currentLockfile) => Promise<void>`

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

`writeWantedLockfile(pkgPath, wantedLockfile) => Promise<void>`

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

`writeCurrentLockfile(pkgPath, currentLockfile) => Promise<void>`

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

License

MIT