This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Pnpm.
Summary
Contains settings used by
PnpmExec.
- Assembly
- Cake
.Pnpm .dll - Namespace
- Cake
.Pnpm .Exec - Base Types
-
- ToolSettings
- PnpmSettings
graph BT
Type-->Base0["PnpmSettings"]
click Base0 "/api/Cake.Pnpm/PnpmSettings"
Base0-->Base1["ToolSettings"]
Type["PnpmExecSettings"]
class Type type-node
Syntax
public class PnpmExecSettings : PnpmSettingsConstructors
| Name | Summary |
|---|---|
| PnpmExecSettings |
Initializes a new instance of the PnpmExecSettings class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| CakeVerbosityLevel | Nullable |
Gets or sets the Log level set by Cake.
Inherited from PnpmSettings
|
| Command | string |
Command to run
|
| 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 shell command 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"
|
| Redirect |
bool |
Gets or sets the process option to redirect standard error output.
Inherited from PnpmSettings
|
| Redirect |
bool |
Gets or sets the process option to redirect standard output.
Inherited from PnpmSettings
|
| ShellMode | bool |
If exist, runs file inside of a shell. Uses /bin/sh on UNIX and
`cmd.exe` on Windows. The shell should understand the -c switch
on UNIX or /d /s /c on Windows.
|
| StandardErrorAction | Action |
Gets or sets an action to retrieve and process standard error output.
Inherited from PnpmSettings
|
| StandardOutputAction | Action |
Gets or sets an action to retrieve and process standard output.
Inherited from PnpmSettings
|
Methods
| Name | Value | Summary |
|---|---|---|
| EvaluateCore |
void |
Evaluates the settings and writes them to args.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|