@pnpm/lockfile-file

Read/write pnpm-lock.yaml files

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 add @pnpm/lockfile-file

API

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

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(virtualStoreDir, opts) => Promise<Lockfile>`

Reads the lockfile file from <virtualStoreDir>/lock.yaml.

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

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

`writeLockfiles(opts) => Promise<void>`

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

Arguments

opts.wantedLockfile
opts.wantedLockfileDir
opts.currentLockfile
opts.currentLockfileDir
[opts.forceSharedFormat]

`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(virtualStoreDir, currentLockfile) => Promise<void>`

Writes the current lockfile file only.

License

MIT

Current Tags

0.0.0-20230605-20230605142810 ... dev (3 years ago)
9.1.3 ... latest (2 years ago)
4.3.2 ... latest-6 (4 years ago)
2.0.0-0 ... next (7 years ago)
3.0.12 ... pnpm-temp (6 years ago)

@pnpm/lockfile-file

Install

API

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

Arguments

readCurrentLockfile(virtualStoreDir, opts) => Promise<Lockfile>

existsNonEmptyWantedLockfile(pkgPath) => Promise<Boolean>

writeLockfiles(opts) => Promise<void>

Arguments

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

writeCurrentLockfile(virtualStoreDir, currentLockfile) => Promise<void>

License

Current Tags

119 Versions

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

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

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

`writeLockfiles(opts) => Promise<void>`

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

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