Cake.Npm

A set of aliases for Cake to help with running Npm (Node Package Manager) commands.

#addin nuget:?package=Cake.Npm&version=0.17.0

<package id="Cake.Npm" version="0.17.0" />

dotnet add package Cake.Npm --version 0.17.0

<PackageReference Include="Cake.Npm" Version="0.17.0" />

Aliases

Npm publish aliases.

AddUser

NpmAddUser(ICakeContext, Action<NpmAddUserSettings>) Adds user using the settings returned by a configurator.
NpmAddUser(ICakeContext, NpmAddUserSettings) Adds user using the specified settings.

Ci

NpmCi(ICakeContext) Cis all packages for the project in the current working directory.
NpmCi(ICakeContext, Action<NpmCiSettings>) Cis packages using the settings returned by a configurator.
NpmCi(ICakeContext, NpmCiSettings) Cis packages using the specified settings.

Install

NpmInstall(ICakeContext) Installs packages for the project in the current working directory.
NpmInstall(ICakeContext, Action<NpmInstallSettings>) Installs packages using the settings returned by a configurator.
NpmInstall(ICakeContext, NpmInstallSettings) Installs packages using the specified settings.
NpmInstall(ICakeContext, string[]) Install one or more packages to the project in the current working directory.

Pack

NpmPack(ICakeContext) Creates a npm package from the current working directory. Package will be created in the current working directory.
NpmPack(ICakeContext, Action<NpmPackSettings>) Creates a npm package using the settings returned by a configurator.
NpmPack(ICakeContext, NpmPackSettings) Creates a npm package using the specified settings. Package will be created in the current working directory.
NpmPack(ICakeContext, string) Creates a npm package from a specific source. Package will be created in the current working directory.

Prune

NpmPrune(ICakeContext) Runs npm prune from the current folder.
NpmPrune(ICakeContext, Action<NpmPruneSettings>) Runs npm prune using the settings returned by a configurator.
NpmPrune(ICakeContext, NpmPruneSettings) Runs npm prune with the specified settings.

Publish

NpmPublish(ICakeContext) Publishes the npm package in the current working directory.
NpmPublish(ICakeContext, Action<NpmPublishSettings>) Publishes a npm package using the settings returned by a configurator.
NpmPublish(ICakeContext, NpmPublishSettings) Publishes a npm package based on the specified settings.
NpmPublish(ICakeContext, string) Publishes the npm package created from a specific source.

Rebuild

NpmRebuild(ICakeContext) Rebuilds packages for the project in the current working directory.
NpmRebuild(ICakeContext, Action<NpmRebuildSettings>) Rebuild packages using the settings returned by a configurator.
NpmRebuild(ICakeContext, NpmRebuildSettings) Rebuilds packages using the specified settings.
NpmRebuild(ICakeContext, string[]) Rebuild one or more packages to the project in the current working directory.

Run-Script

NpmRunScript(ICakeContext, NpmRunScriptSettings) Runs a npm script with the specified settings.
NpmRunScript(ICakeContext, string) Runs a npm script defined in the package.json from the current folder.
NpmRunScript(ICakeContext, string, Action<NpmRunScriptSettings>) Runs a npm script using the settings returned by a configurator.
NpmRunScript(ICakeContext, string, IEnumerable<string>) Runs a npm script defined in the package.json from the current folder with specific arguments.

Set

NpmSet(ICakeContext, Action<NpmSetSettings>) Sets an npm configuration setting returned by a configurator.
NpmSet(ICakeContext, NpmSetSettings) Sets an npm configuration setting.
NpmSet(ICakeContext, string, string, bool) Sets an npm configuration setting.

Update

NpmUpdate(ICakeContext) Updates all packages for the project in the current working directory.
NpmUpdate(ICakeContext, Action<NpmUpdateSettings>) Updates all packages for the project using the settings returned by a configurator.
NpmUpdate(ICakeContext, NpmUpdateSettings) Updates all packages for the project using the specified settings.

Version

NpmVersion(ICakeContext) Versions all packages for the project in the current working directory.