@pnpm/lockfile-file
Advanced tools
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.
pnpm add @pnpm/lockfile-file
readWantedLockfile(pkgPath, opts) => Promise<Lockfile>Reads the pnpm-lock.yaml file from the root of the package.
pkgPath - Path - the path to the projectopts.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.
existsWantedLockfile(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.
opts.wantedLockfileopts.wantedLockfileDiropts.currentLockfileopts.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.
FAQs
Read/write pnpm-lock.yaml files
The npm package @pnpm/lockfile-file receives a total of 102,944 weekly downloads. As such, @pnpm/lockfile-file popularity was classified as popular.
We found that @pnpm/lockfile-file demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.