Summary
Contains settings used by
DotNetPackageLister.
- Namespace
- Cake
.Common .Tools .DotNet .Package .List - Base Types
-
- object
- ToolSettings
- DotNetSettings
graph BT
Type-->Base0["DotNetSettings"]
click Base0 "/api/Cake.Common.Tools.DotNet/DotNetSettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["DotNetPackageListSettings"]
class Type type-node
Syntax
public sealed class DotNetPackageListSettings : DotNetSettingsProperties
| Name | Value | Summary |
|---|---|---|
| Argument |
Func |
Gets or sets the argument customization.
Argument customization is a way that lets you add, replace or reuse arguments passed to a tool.
This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
|
| ConfigFile | FilePath |
Gets or sets the NuGet configuration file (nuget.config) to use.
Requires the
Outdated option.
|
| Deprecated | bool |
Gets or sets a value indicating whether to display packages that have been deprecated.
|
| DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
|
| EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
| Framework | string |
Gets or sets a specific framework to compile.
|
| HandleExitCode | Func |
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code. If the delegate returns true then no exception is thrown. This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value. Inherited from ToolSettings
|
| HighestMinor | bool |
Gets or sets a value indicating whether to display only the packages with a matching major version number when searching for newer packages.
Requires the
Outdated or Deprecated option.
|
| HighestPatch | bool |
Gets or sets a value indicating whether to display only the packages with a matching major and minor version numbers when searching for newer packages.
Requires the
Outdated or Deprecated option.
|
| Interactive | bool |
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
For example, to complete authentication. Available since .NET Core 3.0 SDK.
|
| NoWorkingDirectory | bool |
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
Inherited from ToolSettings
|
| Outdated | bool |
Gets or sets a value indicating whether to list packages that have newer versions available.
|
| PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
| Prerelease | bool |
Gets or sets a value indicating whether to list packages with prerelease versions when searching for newer packages.
Requires the
Outdated or Deprecated option.
|
| RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| Source | ICollection |
Gets or sets the URI of the NuGet package source to use.
Requires the
Outdated or Deprecated option.
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| Transitive | bool |
Gets or sets a value indicating whether to list transitive packages, in addition to the top-level packages.
When specifying this option, you get a list of packages that the top-level packages depend on.
|
| Verbosity | DotNetVerbosity? |
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
|
| Vulnerable | bool |
Gets or sets a value indicating whether to list packages that have known vulnerabilities.
Cannot be combined with
Outdated or Deprecated options.
Nuget.org is the source of information about vulnerabilities.
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
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
|
| With |
T |
Sets the tool argument customization delegate.
|
| With |
T |
Sets or adds tool environment variable.
|
| WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>).
|
| WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
| With |
T |
Sets whether the tool should use a working directory or not.
|
| WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
| With |
T |
Sets a delegate to configure the process settings.
|
| WithToolPath |
T |
Sets the tool path.
|
| WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
| WithToolTimeout |
T |
Sets the tool timeout.
|
| WithWorkingDirectory |
T |
Sets the tool working directory.
|