Summary
Base class for all .NET Core related tools.
- Namespace
- Cake
.Common .Tools .DotNet - Base Types
- Derived Types
graph BT
Type-->Base0["Tool<TSettings>"]
Base0-->Base1["object"]
Type["DotNetTool<TSettings>"]
class Type type-node
Derived0["DotNetCoreExecutor"]-->Type
click Derived0 "/api/Cake.Common.Tools.DotNetCore.Execute/DotNetCoreExecutor"
Derived1["DotNetWorkloadSearcher"]-->Type
click Derived1 "/api/Cake.Common.Tools.DotNet.Workload.Search/DotNetWorkloadSearcher"
Derived2["DotNetSDKChecker"]-->Type
click Derived2 "/api/Cake.Common.Tools.DotNet.SDKCheck/DotNetSDKChecker"
Derived3["DotNetCoreTool<TSettings>"]-->Type
click Derived3 "/api/Cake.Common.Tools.DotNetCore/DotNetCoreTool_1"
Derived4["DotNetFormatter"]-->Type
click Derived4 "/api/Cake.Common.Tools.DotNet.Format/DotNetFormatter"
Syntax
public abstract class DotNetTool<TSettings> : Tool<TSettings> where TSettings : DotNetSettings
Type Parameters
Name | Description |
---|---|
TSettings | The settings type. |
Constructors
Name | Summary |
---|---|
DotNetTool |
Initializes a new instance of the DotNetTool<TSettings> class.
|
Methods
Name | Value | Summary |
---|---|---|
Create |
Process |
Creates a
ProcessArgumentBuilder and adds common commandline arguments.
|
Get |
IEnumerable |
Gets the possible names of the tool executable.
|
GetToolName |
string |
Gets the name of the tool.
|
RunCommand |
void |
Runs the dotnet cli command using the specified settings and arguments.
|
RunCommand |
void |
Runs the dotnet cli command using the specified settings and arguments.
|
RunCommand |
void |
Runs the dotnet cli command using the specified settings and arguments.
|
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 if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator 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
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|