PnpmAddSettings Class

Summary

Contains settings used by PnpmAdd.
Assembly
Cake.Pnpm.dll
Namespace
Cake.Pnpm.Add
Base Types
graph BT Type-->Base0["PnpmSettings"] click Base0 "/api/Cake.Pnpm/PnpmSettings" Base0-->Base1["ToolSettings"] Type["PnpmAddSettings"] class Type type-node

Syntax

public class PnpmAddSettings : PnpmSettings

Constructors

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

Properties

Name Value Summary
AggregateOutput bool
Aggregate output from child processes that are run in parallel, and only print output when child process is finished. It makes reading large logs after running `pnpm recursive` with `--parallel` or with `--workspace-concurrency` much easier (especially on CI). Only `--reporter=append-only` is supported.
CakeVerbosityLevel Nullable<Verbosity>
Gets or sets the Log level set by Cake.
Inherited from PnpmSettings
Color Nullable<bool>
Controls colors in the output. By default, output is always colored when it goes directly to a terminal
Dir string
Change to directory (default: the running dir)
Global bool
Install as a global package
GlobalDir string
Specify a custom directory to store global packages
IgnoreScripts bool
Don't run lifecycle scripts
Offline bool
Trigger an error if any required dependencies are not available in local store
PackageName string
Package name to install
PnpmLogLevel PnpmLogLevel
What level of logs to report. Any logs at or higher than the given level will be shown. Levels (lowest to highest): debug, info, warn, error.
Inherited from PnpmSettings
PreferOffline bool
Skip staleness checks for cached data, but request missing data from the server
Recursive bool
Run installation recursively in every package found in subdirectories. For options that may be used with `-r`, see "pnpm help recursive"
RedirectStandardError bool
Gets or sets the process option to redirect standard error output.
Inherited from PnpmSettings
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output.
Inherited from PnpmSettings
SaveDev bool
Save package to your `devDependencies`
SaveExact Nullable<bool>
Install exact version
SaveOptional bool
Save package to your `optionalDependencies`
SavePeer bool
Save package to your `peerDependencies` and `devDependencies`
SaveProd bool
Save package to your `dependencies`. The default behavior
SaveWorkspaceProtocol Nullable<bool>
Save packages from the workspace with a "workspace:" protocol. True by default
StandardErrorAction Action<string>
Gets or sets an action to retrieve and process standard error output.
Inherited from PnpmSettings
StandardOutputAction Action<string>
Gets or sets an action to retrieve and process standard output.
Inherited from PnpmSettings
StoreDir string
The directory in which all the packages are saved on the disk
Stream bool
Stream output from child processes immediately, prefixed with the originating package directory. This allows output from different packages to be interleaved.
UseStderr bool
Divert all output to stderr
VirtualStoreDir string
The directory with links to the store (default is node_modules/.pnpm). All direct and indirect dependencies of the project are linked into this directory
Workspace bool
Only adds the new dependency if it is found in the workspace
WorkspaceRoot bool
Run the command on the root workspace project

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Pnpm tool settings.

Extension Methods

Name Value Summary
Dump<PnpmAddSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PnpmAddSettings>(PnpmAddSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PnpmAddSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PnpmAddSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<PnpmAddSettings>(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
ThrowIfNull<PnpmAddSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin