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 PnpmList.

Assembly

Cake.Pnpm.dll

Namespace

Cake.Pnpm.List

Base Types

ToolSettings
PnpmSettings

graph BT Type-->Base0["PnpmSettings"] click Base0 "/api/Cake.Pnpm/PnpmSettings" Base0-->Base1["ToolSettings"] Type["PnpmListSettings"] class Type type-node

Syntax

public class PnpmListSettings : PnpmSettings

Constructors

Name	Summary
PnpmListSettings()	Initializes a new instance of the `PnpmListSettings` 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
Depth	Nullable<int>	Max display depth of the dependency tree To display only projects use '-1' value To Display only direct dependencies use '0' value (default value)
Dev	bool	Check only 'devDependencies'
Dir	string	Change to directory (default: the running dir)
Global	bool	Update globally installed packages
GlobalDir	string	Specify a custom directory to store global packages
Json	bool	Show information in JSON format
Long	bool	Show extended information
NoOptional	bool	Don't check 'optionalDependencies'
Packages	HashSet<string>	Packages names to show information about
Parseable	bool	Show parseable output instead of tree view
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
Prod	bool	Check only "dependencies" and "optionalDependencies"
Recursive	bool	Perform command on every package in subdirectories or on 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