NpmBumpVersionSettings Class

Summary

Contains settings used by NpmBumpVersionTool.
Assembly
Cake.Npm.dll
Namespace
Cake.Npm.BumpVersion
Base Types
graph BT Type-->Base0["NpmSettings"] click Base0 "/api/Cake.Npm/NpmSettings" Base0-->Base1["ToolSettings"] Type["NpmBumpVersionSettings"] class Type type-node

Syntax

public class NpmBumpVersionSettings : NpmSettings

Constructors

Name Summary
NpmBumpVersionSettings() Initializes a new instance of the NpmBumpVersionSettings class.

Properties

Name Value Summary
Command string
Gets the command which should be run.
Inherited from NpmSettings
CommitMessage string
Gets or sets the commit message.
Force bool
Gets or sets the force-option
LogLevel NpmLogLevel
Gets or sets the log level which should be used to run the npm command.
Inherited from NpmSettings
RedirectStandardError bool
Gets or sets the process option to redirect standard error output.
Inherited from NpmSettings
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output.
Inherited from NpmSettings
StandardErrorAction Action<string>
Gets or sets an action to retrieve and process standard error output.
Inherited from NpmSettings
StandardOutputAction Action<string>
Gets or sets an action to retrieve and process standard output.
Inherited from NpmSettings
Version string
Gets or sets the version to bump to. Should be a valid semver or one of "patch", "minor", "major", "prepatch", "preminor", "premajor", "prerelease" or "from-git".

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.

Extension Methods

Name Value Summary
Dump<NpmBumpVersionSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FromPath(DirectoryPath) NpmSettings
Sets the working directory which should be used to run the npm command.
Requires the Cake.Npm addin
IsIn<NpmBumpVersionSettings>(NpmBumpVersionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NpmBumpVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NpmBumpVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetRedirectedStandardErrorHandler(Action<string>) NpmSettings
Sets the StandardError-Action
Requires the Cake.Npm addin
SetRedirectedStandardOutputHandler(Action<string>) NpmSettings
Sets the StandardOutput-Action
Requires the Cake.Npm addin
ThrowIfNull<NpmBumpVersionSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NpmBumpVersionSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
WithCommitMessage(string) NpmBumpVersionSettings
Sets the commit message.
Requires the Cake.Npm addin
WithForce(bool) NpmBumpVersionSettings
Defines that npm version should commit, even if the repository is not clean.
Requires the Cake.Npm addin
WithLogLevel(NpmLogLevel) NpmSettings
Sets the log level which should be used to run the npm command.
Requires the Cake.Npm addin
WithVersion(string) NpmBumpVersionSettings
Sets the version to bump.
Requires the Cake.Npm addin