Summary
Base class for tools.
- Namespace
- Cake
.Core .Tooling - Base Types
-
- object
- Derived Types
-
- VSWhereTool
<TSettings> - LightRunner
- MSBuildRunner
- NUnit3Runner
- FixieRunner
- DotCoverTool
<TSettings> - MSTestRunner
- SignToolSignRunner
- GitLink3Runner
- DupFinderRunner
- CakeRunner
- InnoSetupRunner
- MSpecRunner
- VSTestRunner
- InspectCodeRunner
- ILMergeRunner
- XUnitRunner
- CommandRunner
- CandleRunner
- OctopusDeployTool
<TSettings> - TextTransformRunner
- ReportUnitRunner
- DotNetTool
<TSettings> - ChocolateyTool
<TSettings> - NuGetTool
<TSettings> - XBuildRunner
- HeatRunner
- ILRepackRunner
- MakeNSISRunner
- NUnitRunner
- GitVersionRunner
- Git
Release Notes Runner - RoundhouseRunner
- Report
Generator Runner - Git
Release Manager Tool <TSettings> - SpecFlowTool
<TSettings> - XUnit2Runner
- GitLinkRunner
- OpenCoverRunner
- VSWhereTool
graph BT
Type-->Base0["object"]
Type["Tool<TSettings>"]
class Type type-node
Derived0["VSWhereTool<TSettings>"]-->Type
click Derived0 "/api/Cake.Common.Tools.VSWhere/VSWhereTool_1"
Derived1["LightRunner"]-->Type
click Derived1 "/api/Cake.Common.Tools.WiX/LightRunner"
Derived2["MSBuildRunner"]-->Type
click Derived2 "/api/Cake.Common.Tools.MSBuild/MSBuildRunner"
Derived3["NUnit3Runner"]-->Type
click Derived3 "/api/Cake.Common.Tools.NUnit/NUnit3Runner"
Derived4["FixieRunner"]-->Type
click Derived4 "/api/Cake.Common.Tools.Fixie/FixieRunner"
Derived5["DotCoverTool<TSettings>"]-->Type
click Derived5 "/api/Cake.Common.Tools.DotCover/DotCoverTool_1"
Derived6["MSTestRunner"]-->Type
click Derived6 "/api/Cake.Common.Tools.MSTest/MSTestRunner"
Derived7["SignToolSignRunner"]-->Type
click Derived7 "/api/Cake.Common.Tools.SignTool/SignToolSignRunner"
Derived8["GitLink3Runner"]-->Type
click Derived8 "/api/Cake.Common.Tools.GitLink/GitLink3Runner"
Derived9["DupFinderRunner"]-->Type
click Derived9 "/api/Cake.Common.Tools.DupFinder/DupFinderRunner"
Derived10["CakeRunner"]-->Type
click Derived10 "/api/Cake.Common.Tools.Cake/CakeRunner"
Derived11["InnoSetupRunner"]-->Type
click Derived11 "/api/Cake.Common.Tools.InnoSetup/InnoSetupRunner"
Derived12["MSpecRunner"]-->Type
click Derived12 "/api/Cake.Common.Tools.MSpec/MSpecRunner"
Derived13["VSTestRunner"]-->Type
click Derived13 "/api/Cake.Common.Tools.VSTest/VSTestRunner"
Derived14["InspectCodeRunner"]-->Type
click Derived14 "/api/Cake.Common.Tools.InspectCode/InspectCodeRunner"
Derived15["ILMergeRunner"]-->Type
click Derived15 "/api/Cake.Common.Tools.ILMerge/ILMergeRunner"
Derived16["XUnitRunner"]-->Type
click Derived16 "/api/Cake.Common.Tools.XUnit/XUnitRunner"
Derived17["CommandRunner"]-->Type
click Derived17 "/api/Cake.Common.Tools.Command/CommandRunner"
Derived18["CandleRunner"]-->Type
click Derived18 "/api/Cake.Common.Tools.WiX/CandleRunner"
Derived19["OctopusDeployTool<TSettings>"]-->Type
click Derived19 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployTool_1"
Derived20["TextTransformRunner"]-->Type
click Derived20 "/api/Cake.Common.Tools.TextTransform/TextTransformRunner"
Derived21["ReportUnitRunner"]-->Type
click Derived21 "/api/Cake.Common.Tools.ReportUnit/ReportUnitRunner"
Derived22["DotNetTool<TSettings>"]-->Type
click Derived22 "/api/Cake.Common.Tools.DotNet/DotNetTool_1"
Derived23["ChocolateyTool<TSettings>"]-->Type
click Derived23 "/api/Cake.Common.Tools.Chocolatey/ChocolateyTool_1"
Derived24["NuGetTool<TSettings>"]-->Type
click Derived24 "/api/Cake.Common.Tools.NuGet/NuGetTool_1"
Derived25["XBuildRunner"]-->Type
click Derived25 "/api/Cake.Common.Tools.XBuild/XBuildRunner"
Derived26["HeatRunner"]-->Type
click Derived26 "/api/Cake.Common.Tools.WiX.Heat/HeatRunner"
Derived27["ILRepackRunner"]-->Type
click Derived27 "/api/Cake.Common.Tools.ILRepack/ILRepackRunner"
Derived28["MakeNSISRunner"]-->Type
click Derived28 "/api/Cake.Common.Tools.NSIS/MakeNSISRunner"
Derived29["NUnitRunner"]-->Type
click Derived29 "/api/Cake.Common.Tools.NUnit/NUnitRunner"
Derived30["GitVersionRunner"]-->Type
click Derived30 "/api/Cake.Common.Tools.GitVersion/GitVersionRunner"
Derived31["GitReleaseNotesRunner"]-->Type
click Derived31 "/api/Cake.Common.Tools.GitReleaseNotes/GitReleaseNotesRunner"
Derived32["RoundhouseRunner"]-->Type
click Derived32 "/api/Cake.Common.Tools.Roundhouse/RoundhouseRunner"
Derived33["ReportGeneratorRunner"]-->Type
click Derived33 "/api/Cake.Common.Tools.ReportGenerator/ReportGeneratorRunner"
Derived34["GitReleaseManagerTool<TSettings>"]-->Type
click Derived34 "/api/Cake.Common.Tools.GitReleaseManager/GitReleaseManagerTool_1"
Derived35["SpecFlowTool<TSettings>"]-->Type
click Derived35 "/api/Cake.Common.Tools.SpecFlow/SpecFlowTool_1"
Derived36["XUnit2Runner"]-->Type
click Derived36 "/api/Cake.Common.Tools.XUnit/XUnit2Runner"
Derived37["GitLinkRunner"]-->Type
click Derived37 "/api/Cake.Common.Tools.GitLink/GitLinkRunner"
Derived38["OpenCoverRunner"]-->Type
click Derived38 "/api/Cake.Common.Tools.OpenCover/OpenCoverRunner"
Syntax
public abstract class Tool<TSettings> where TSettings : ToolSettingsType Parameters
| Name | Description |
|---|---|
| TSettings | The settings type. |
Constructors
| Name | Summary |
|---|---|
| Tool |
Initializes a new instance of the Tool<TSettings> class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Get |
IEnumerable |
Gets alternative file paths which the tool may exist in.
|
| Get |
IDictionary |
Gets the environment variables.
|
| Get |
IEnumerable |
Gets the possible names of the tool executable.
|
| Get |
IEnumerable |
Gets the possible names of the tool executable.
|
| GetToolName |
string |
Gets the name of the tool.
|
| GetToolPath |
FilePath |
Gets the resolved tool path.
|
| GetWorkingDirectory |
DirectoryPath |
Gets the working directory.
Defaults to the currently set working directory.
|
| ProcessExitCode |
void |
Customized exit code handling.
Standard behavior is to fail when non zero.
|
| Run |
void |
Runs the tool using a custom tool path and the specified settings.
|
| Run |
void |
Runs the tool using the specified settings.
|
| RunProcess |
IProcess |
Runs the tool using a custom tool path and the specified settings.
|
| RunProcess |
IProcess |
Runs the tool using a custom tool path and the specified settings.
|
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
|