Cake.Pnpm

A wrapper around pnpm functionality within a Cake build script.

#addin nuget:?package=Cake.Pnpm&version=1.0.0

dotnet add package Cake.Pnpm --version 1.0.0

<PackageReference Include="Cake.Pnpm" Version="1.0.0" />

Aliases

`pnpm licenses` aliases

Add

PnpmAdd(PnpmAddSettings) Install package using the specified settings
PnpmAdd(string, Action<PnpmAddSettings>) Install package using the settings returned by a configurator.
PnpmAdd(string) Install package

Audit

PnpmAudit(Action<PnpmAuditSettings>) Checks for known security issues with the installed packages using the settings returned by a configurator.
PnpmAudit(PnpmAuditSettings) Checks for known security issues with the installed packages using the specified settings
PnpmAudit() Checks for known security issues with the installed packages.

Exec

PnpmExec(string, PnpmExecSettings) Run a shell command in the context of a project using the specified settings
PnpmExec(string) Run a shell command in the context of a project

Import

PnpmImport() Generates pnpm-lock.yaml from an npm package-lock.json (or npm-shrinkwrap.json, yarn.lock) file. Visit https://pnpm.io/7.x/cli/import for documentation about this command.

Install

PnpmInstall(Action<PnpmInstallSettings>) Install packages using the settings returned by a configurator.
PnpmInstall(PnpmInstallSettings) Install packages using the specified settings
PnpmInstall() Installs packages for the project in the current working directory.

Licenses

PnpmLicenses(Action<PnpmLicensesSettings>) Check the licenses of the installed packages using the settings returned by a configurator.
PnpmLicenses(PnpmLicensesSettings) Check the licenses of the installed packages using the specified settings
PnpmLicenses() Check the licenses of the installed packages.
PnpmLink(PnpmLinkSettings) Connect the local project to another one using the specified settings
PnpmLink(string, Action<PnpmLinkSettings>) Connect the local project to another one using the settings returned by a configurator.
PnpmLink(string) Connect the local project to another one

List

PnpmList(Action<PnpmListSettings>, string[]) Connect the local project to another one using the settings returned by a configurator.
PnpmList(PnpmListSettings) Connect the local project to another one using the specified settings
PnpmList(string[]) Connect the local project to another one
PnpmRebuild(PnpmRebuildSettings) Rebuild a package(s) using the specified settings

Outdated

PnpmOutdated(Action<PnpmOutdatedSettings>, string[]) Check for outdated packages using the settings returned by a configurator.
PnpmOutdated(PnpmOutdatedSettings) Check for outdated packages using the specified settings
PnpmOutdated(string[]) Check for outdated packages

Prune

PnpmPrune(Action<PnpmPruneSettings>) Removes extraneous packages using the settings returned by a configurator.
PnpmPrune(PnpmPruneSettings) Removes extraneous packages using the specified settings
PnpmPrune() Removes extraneous packages

Rebuild

PnpmRebuild(Action<PnpmRebuildSettings>, string[]) Rebuild a package(s) using the settings returned by a configurator.
PnpmRebuild(string[]) Rebuild a package(s)

Remove

PnpmRemove(PnpmRemoveSettings) Remove package using the specified settings
PnpmRemove(string, Action<PnpmRemoveSettings>) Remove package using the settings returned by a configurator.
PnpmRemove(string) Remove package

Run

PnpmRun(string, PnpmRunSettings) Runs a defined package script using the specified settings
PnpmRun(string) Runs a defined package script.
PnpmStart() Runs an arbitrary command specified in the package's "start" property of its "scripts" object
PnpmTest() Runs a package's "test" script, if one was provided

Store

PnpmStoreAdd(string[]) Adds new packages to the store. Example: pnpm store add [email protected] [email protected]
PnpmStorePath() Returns the path to the active store directory.
PnpmStorePrune() Removes unreferenced (extraneous, orphan) packages from the store. Pruning the store is not harmful, but might slow down future installations. Visit the documentation for more information on unreferenced packages
PnpmStoreStatus() Checks for modified packages in the store. Returns exit code 0 if the content of the package is the same as it was at the time of unpacking
PnpmUnlink(PnpmUnlinkSettings) Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json` using the specified settings
PnpmUnlink(string, Action<PnpmUnlinkSettings>) Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json` using the settings returned by a configurator.
PnpmUnlink(string) Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json`

Update

PnpmUpdate(Action<PnpmUpdateSettings>, string[]) Updates packages using the settings returned by a configurator
PnpmUpdate(PnpmUpdateSettings) Updates packages using the specified settings
PnpmUpdate(string[]) Updates packages to their latest version