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
PnpmRebuild
.
- Assembly
- Cake
.Pnpm .dll - Namespace
- Cake
.Pnpm .Rebuild - Base Types
-
- ToolSettings
- PnpmSettings
graph BT
Type-->Base0["PnpmSettings"]
click Base0 "/api/Cake.Pnpm/PnpmSettings"
Base0-->Base1["ToolSettings"]
Type["PnpmRebuildSettings"]
class Type type-node
Syntax
public class PnpmRebuildSettings : PnpmSettings
Constructors
Name | Summary |
---|---|
PnpmRebuildSettings |
Initializes a new instance of the PnpmRebuildSettings 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 |
Gets or sets the Log level set by Cake.
Inherited from PnpmSettings
|
Color | Nullable |
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)
|
Packages | HashSet |
Package names(s) to rebuild
|
Pending | bool |
Rebuild packages that were not build during installation. Packages are not build when installing with the --ignore-scripts flag
|
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 |
Rebuild 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
|
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
|
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
|
WorkspaceRoot | bool |
Run the command on the root workspace project
|
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 IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp 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 |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|