PnpmAuditSettings Class

Summary

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

Syntax

public class PnpmAuditSettings : PnpmSettings

Constructors

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

Properties

Name Value Summary
AuditLevel Nullable<AuditLevelSeverity>
Only print advisories with severity greater than or equal to one of the following: low|moderate|high|critical. Default: low
CakeVerbosityLevel Nullable<Verbosity>
Gets or sets the Log level set by Cake.
Inherited from PnpmSettings
Dev bool
Only audit 'devDependencies'
Fix bool
Add overrides to the package.json file in order to force non-vulnerable versions of the dependencies
IgnoreRegistryErrors bool
Use exit code 0 if the registry responds with an error. Useful when audit checks are used in CI. A build should fail because the registry has issues.
Json bool
Output audit report in JSON format
NoOptional bool
Don't audit 'optionalDependencies'
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
Only audit "dependencies" and "optionalDependencies"
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

Methods

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

Extension Methods

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