PnpmRunSettings Class

Summary

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

Syntax

public class PnpmRunSettings : PnpmSettings

Constructors

Name Summary
PnpmRunSettings() Initializes a new instance of the PnpmRunSettings 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
Command string
Command to run
Dir string
Change to directory (default: the running dir)
IfPresent bool
Avoid exiting with a non-zero exit code when the script is undefined
NoBail bool
The command will exit with a 0 exit code even if the script fails
Parallel bool
Completely disregard concurrency and topological sorting, running a given script immediately in all matching packages with prefixed streaming output. This is the preferred flag for long-running processes such as watch run over many packages.
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
Recursive bool
Run the defined package script in every package found in subdirectories or every workspace package, when executed inside a workspace. 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
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
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
WorkspaceRoot bool
Run the command on the root workspace project

Methods

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

Extension Methods

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