Summary
Contains common settings used by
DotNetTool<TSettings>.
- Namespace
- Cake
.Common .Tools .DotNet - Base Types
-
- object
- ToolSettings
- Derived Types
-
- Dot
Net Workload List Settings - Dot
Net Workload Install Settings - Dot
Net Workload Uninstall Settings - Dot
Net Publish Settings - DotNetCleanSettings
- Dot
Net Workload Search Settings - Dot
Net Restore Settings - Dot
Net Execute Settings - Dot
Net Package Add Settings - Dot
Net Build Server Settings - Dot
Net Workload Update Settings - Dot
Net S D K Check Settings - DotNetTestSettings
- Dot
Net Nu Get Source Settings - DotNetVSTestSettings
- DotNetRunSettings
- Dot
Net Workload Repair Settings - DotNetToolSettings
- Dot
Net M S Build Settings - DotNetPackSettings
- DotNetFormatSettings
- Dot
Net Workload Restore Settings - Dot
Net Sln List Settings - Dot
Net Nu Get Delete Settings - Dot
Net Reference Add Settings - DotNetSlnAddSettings
- Dot
Net Reference List Settings - Dot
Net Reference Remove Settings - Dot
Net Package List Settings - DotNetBuildSettings
- Dot
Net Package Search Settings - Dot
Net Package Remove Settings - Dot
Net Nu Get Push Settings
- Dot
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["DotNetSettings"]
class Type type-node
Derived0["DotNetWorkloadListSettings"]-->Type
click Derived0 "/api/Cake.Common.Tools.DotNet.Workload.List/DotNetWorkloadListSettings"
Derived1["DotNetWorkloadInstallSettings"]-->Type
click Derived1 "/api/Cake.Common.Tools.DotNet.Workload.Install/DotNetWorkloadInstallSettings"
Derived2["DotNetWorkloadUninstallSettings"]-->Type
click Derived2 "/api/Cake.Common.Tools.DotNet.Workload.Uninstall/DotNetWorkloadUninstallSettings"
Derived3["DotNetPublishSettings"]-->Type
click Derived3 "/api/Cake.Common.Tools.DotNet.Publish/DotNetPublishSettings"
Derived4["DotNetCleanSettings"]-->Type
click Derived4 "/api/Cake.Common.Tools.DotNet.Clean/DotNetCleanSettings"
Derived5["DotNetWorkloadSearchSettings"]-->Type
click Derived5 "/api/Cake.Common.Tools.DotNet.Workload.Search/DotNetWorkloadSearchSettings"
Derived6["DotNetRestoreSettings"]-->Type
click Derived6 "/api/Cake.Common.Tools.DotNet.Restore/DotNetRestoreSettings"
Derived7["DotNetExecuteSettings"]-->Type
click Derived7 "/api/Cake.Common.Tools.DotNet.Execute/DotNetExecuteSettings"
Derived8["DotNetPackageAddSettings"]-->Type
click Derived8 "/api/Cake.Common.Tools.DotNet.Package.Add/DotNetPackageAddSettings"
Derived9["DotNetBuildServerSettings"]-->Type
click Derived9 "/api/Cake.Common.Tools.DotNet.BuildServer/DotNetBuildServerSettings"
Derived10["DotNetWorkloadUpdateSettings"]-->Type
click Derived10 "/api/Cake.Common.Tools.DotNet.Workload.Update/DotNetWorkloadUpdateSettings"
Derived11["DotNetSDKCheckSettings"]-->Type
click Derived11 "/api/Cake.Common.Tools.DotNet.SDKCheck/DotNetSDKCheckSettings"
Derived12["DotNetTestSettings"]-->Type
click Derived12 "/api/Cake.Common.Tools.DotNet.Test/DotNetTestSettings"
Derived13["DotNetNuGetSourceSettings"]-->Type
click Derived13 "/api/Cake.Common.Tools.DotNet.NuGet.Source/DotNetNuGetSourceSettings"
Derived14["DotNetVSTestSettings"]-->Type
click Derived14 "/api/Cake.Common.Tools.DotNet.VSTest/DotNetVSTestSettings"
Derived15["DotNetRunSettings"]-->Type
click Derived15 "/api/Cake.Common.Tools.DotNet.Run/DotNetRunSettings"
Derived16["DotNetWorkloadRepairSettings"]-->Type
click Derived16 "/api/Cake.Common.Tools.DotNet.Workload.Repair/DotNetWorkloadRepairSettings"
Derived17["DotNetToolSettings"]-->Type
click Derived17 "/api/Cake.Common.Tools.DotNet.Tool/DotNetToolSettings"
Derived18["DotNetMSBuildSettings"]-->Type
click Derived18 "/api/Cake.Common.Tools.DotNet.MSBuild/DotNetMSBuildSettings"
Derived19["DotNetPackSettings"]-->Type
click Derived19 "/api/Cake.Common.Tools.DotNet.Pack/DotNetPackSettings"
Derived20["DotNetFormatSettings"]-->Type
click Derived20 "/api/Cake.Common.Tools.DotNet.Format/DotNetFormatSettings"
Derived21["DotNetWorkloadRestoreSettings"]-->Type
click Derived21 "/api/Cake.Common.Tools.DotNet.Workload.Restore/DotNetWorkloadRestoreSettings"
Derived22["DotNetSlnListSettings"]-->Type
click Derived22 "/api/Cake.Common.Tools.DotNet.Sln.List/DotNetSlnListSettings"
Derived23["DotNetNuGetDeleteSettings"]-->Type
click Derived23 "/api/Cake.Common.Tools.DotNet.NuGet.Delete/DotNetNuGetDeleteSettings"
Derived24["DotNetReferenceAddSettings"]-->Type
click Derived24 "/api/Cake.Common.Tools.DotNet.Reference.Add/DotNetReferenceAddSettings"
Derived25["DotNetSlnAddSettings"]-->Type
click Derived25 "/api/Cake.Common.Tools.DotNet.Sln.Add/DotNetSlnAddSettings"
Derived26["DotNetReferenceListSettings"]-->Type
click Derived26 "/api/Cake.Common.Tools.DotNet.Reference.List/DotNetReferenceListSettings"
Derived27["DotNetReferenceRemoveSettings"]-->Type
click Derived27 "/api/Cake.Common.Tools.DotNet.Reference.Remove/DotNetReferenceRemoveSettings"
Derived28["DotNetPackageListSettings"]-->Type
click Derived28 "/api/Cake.Common.Tools.DotNet.Package.List/DotNetPackageListSettings"
Derived29["DotNetBuildSettings"]-->Type
click Derived29 "/api/Cake.Common.Tools.DotNet.Build/DotNetBuildSettings"
Derived30["DotNetPackageSearchSettings"]-->Type
click Derived30 "/api/Cake.Common.Tools.DotNet.Package.Search/DotNetPackageSearchSettings"
Derived31["DotNetPackageRemoveSettings"]-->Type
click Derived31 "/api/Cake.Common.Tools.DotNet.Package.Remove/DotNetPackageRemoveSettings"
Derived32["DotNetNuGetPushSettings"]-->Type
click Derived32 "/api/Cake.Common.Tools.DotNet.NuGet.Push/DotNetNuGetPushSettings"
Syntax
public abstract class DotNetSettings : ToolSettingsProperties
| 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
|
| DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
|
| EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
| 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
|
| 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
|
| PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
| RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| Verbosity | DotNetVerbosity? |
Gets or sets the verbosity of logging to use.
|
| 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.
|