ToolSettings Class

Summary

Base class for tool settings.
graph BT Type-->Base0["object"] Type["ToolSettings"] class Type type-node Derived0["VSTestSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.VSTest/VSTestSettings" Derived1["CakeSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.Cake/CakeSettings" Derived2["VSWhereSettings"]-->Type click Derived2 "/api/Cake.Common.Tools.VSWhere/VSWhereSettings" Derived3["NuGetInitSettings"]-->Type click Derived3 "/api/Cake.Common.Tools.NuGet.Init/NuGetInitSettings" Derived4["ReportGeneratorSettings"]-->Type click Derived4 "/api/Cake.Common.Tools.ReportGenerator/ReportGeneratorSettings" Derived5["NuGetPackSettings"]-->Type click Derived5 "/api/Cake.Common.Tools.NuGet.Pack/NuGetPackSettings" Derived6["DupFinderSettings"]-->Type click Derived6 "/api/Cake.Common.Tools.DupFinder/DupFinderSettings" Derived7["NuGetRestoreSettings"]-->Type click Derived7 "/api/Cake.Common.Tools.NuGet.Restore/NuGetRestoreSettings" Derived8["ChocolateyPushSettings"]-->Type click Derived8 "/api/Cake.Common.Tools.Chocolatey.Push/ChocolateyPushSettings" Derived9["DotNetCoreSettings"]-->Type click Derived9 "/api/Cake.Common.Tools.DotNetCore/DotNetCoreSettings" Derived10["ILRepackSettings"]-->Type click Derived10 "/api/Cake.Common.Tools.ILRepack/ILRepackSettings" Derived11["XBuildSettings"]-->Type click Derived11 "/api/Cake.Common.Tools.XBuild/XBuildSettings" Derived12["NUnit3Settings"]-->Type click Derived12 "/api/Cake.Common.Tools.NUnit/NUnit3Settings" Derived13["TextTransformSettings"]-->Type click Derived13 "/api/Cake.Common.Tools.TextTransform/TextTransformSettings" Derived14["DotCoverSettings"]-->Type click Derived14 "/api/Cake.Common.Tools.DotCover/DotCoverSettings" Derived15["ChocolateyConfigSettings"]-->Type click Derived15 "/api/Cake.Common.Tools.Chocolatey.Config/ChocolateyConfigSettings" Derived16["NUnitSettings"]-->Type click Derived16 "/api/Cake.Common.Tools.NUnit/NUnitSettings" Derived17["GitReleaseManagerExportSettings"]-->Type click Derived17 "/api/Cake.Common.Tools.GitReleaseManager.Export/GitReleaseManagerExportSettings" Derived18["CandleSettings"]-->Type click Derived18 "/api/Cake.Common.Tools.WiX/CandleSettings" Derived19["NuGetListSettings"]-->Type click Derived19 "/api/Cake.Common.Tools.NuGet.List/NuGetListSettings" Derived20["ChocolateySettings"]-->Type click Derived20 "/api/Cake.Common.Tools.Chocolatey/ChocolateySettings" Derived21["GitLinkSettings"]-->Type click Derived21 "/api/Cake.Common.Tools.GitLink/GitLinkSettings" Derived22["FixieSettings"]-->Type click Derived22 "/api/Cake.Common.Tools.Fixie/FixieSettings" Derived23["SpecFlowSettings"]-->Type click Derived23 "/api/Cake.Common.Tools.SpecFlow/SpecFlowSettings" Derived24["OpenCoverSettings"]-->Type click Derived24 "/api/Cake.Common.Tools.OpenCover/OpenCoverSettings" Derived25["NuGetSetApiKeySettings"]-->Type click Derived25 "/api/Cake.Common.Tools.NuGet.SetApiKey/NuGetSetApiKeySettings" Derived26["MakeNSISSettings"]-->Type click Derived26 "/api/Cake.Common.Tools.NSIS/MakeNSISSettings" Derived27["ChocolateyPinSettings"]-->Type click Derived27 "/api/Cake.Common.Tools.Chocolatey.Pin/ChocolateyPinSettings" Derived28["XUnit2Settings"]-->Type click Derived28 "/api/Cake.Common.Tools.XUnit/XUnit2Settings" Derived29["GitReleaseManagerPublishSettings"]-->Type click Derived29 "/api/Cake.Common.Tools.GitReleaseManager.Publish/GitReleaseManagerPublishSettings" Derived30["MSBuildSettings"]-->Type click Derived30 "/api/Cake.Common.Tools.MSBuild/MSBuildSettings" Derived31["HeatSettings"]-->Type click Derived31 "/api/Cake.Common.Tools.WiX.Heat/HeatSettings" Derived32["ReportUnitSettings"]-->Type click Derived32 "/api/Cake.Common.Tools.ReportUnit/ReportUnitSettings" Derived33["ChocolateySourcesSettings"]-->Type click Derived33 "/api/Cake.Common.Tools.Chocolatey.Sources/ChocolateySourcesSettings" Derived34["ChocolateyPackSettings"]-->Type click Derived34 "/api/Cake.Common.Tools.Chocolatey.Pack/ChocolateyPackSettings" Derived35["InspectCodeSettings"]-->Type click Derived35 "/api/Cake.Common.Tools.InspectCode/InspectCodeSettings" Derived36["GitReleaseManagerLabelSettings"]-->Type click Derived36 "/api/Cake.Common.Tools.GitReleaseManager.Label/GitReleaseManagerLabelSettings" Derived37["SignToolSignSettings"]-->Type click Derived37 "/api/Cake.Common.Tools.SignTool/SignToolSignSettings" Derived38["GitReleaseManagerAddAssetsSettings"]-->Type click Derived38 "/api/Cake.Common.Tools.GitReleaseManager.AddAssets/GitReleaseManagerAddAssetsSettings" Derived39["NuGetPushSettings"]-->Type click Derived39 "/api/Cake.Common.Tools.NuGet.Push/NuGetPushSettings" Derived40["LightSettings"]-->Type click Derived40 "/api/Cake.Common.Tools.WiX/LightSettings" Derived41["GitReleaseNotesSettings"]-->Type click Derived41 "/api/Cake.Common.Tools.GitReleaseNotes/GitReleaseNotesSettings" Derived42["GitReleaseManagerCloseMilestoneSettings"]-->Type click Derived42 "/api/Cake.Common.Tools.GitReleaseManager.Close/GitReleaseManagerCloseMilestoneSettings" Derived43["GitReleaseManagerCreateSettings"]-->Type click Derived43 "/api/Cake.Common.Tools.GitReleaseManager.Create/GitReleaseManagerCreateSettings" Derived44["ILMergeSettings"]-->Type click Derived44 "/api/Cake.Common.Tools.ILMerge/ILMergeSettings" Derived45["GitLink3Settings"]-->Type click Derived45 "/api/Cake.Common.Tools.GitLink/GitLink3Settings" Derived46["NuGetUpdateSettings"]-->Type click Derived46 "/api/Cake.Common.Tools.NuGet.Update/NuGetUpdateSettings" Derived47["ChocolateyFeatureSettings"]-->Type click Derived47 "/api/Cake.Common.Tools.Chocolatey.Features/ChocolateyFeatureSettings" Derived48["NuGetSetProxySettings"]-->Type click Derived48 "/api/Cake.Common.Tools.NuGet.SetProxy/NuGetSetProxySettings" Derived49["MSTestSettings"]-->Type click Derived49 "/api/Cake.Common.Tools.MSTest/MSTestSettings" Derived50["RoundhouseSettings"]-->Type click Derived50 "/api/Cake.Common.Tools.Roundhouse/RoundhouseSettings" Derived51["OctopusDeployToolSettings"]-->Type click Derived51 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployToolSettings" Derived52["InnoSetupSettings"]-->Type click Derived52 "/api/Cake.Common.Tools.InnoSetup/InnoSetupSettings" Derived53["NuGetInstallSettings"]-->Type click Derived53 "/api/Cake.Common.Tools.NuGet.Install/NuGetInstallSettings" Derived54["XUnitSettings"]-->Type click Derived54 "/api/Cake.Common.Tools.XUnit/XUnitSettings" Derived55["NuGetSourcesSettings"]-->Type click Derived55 "/api/Cake.Common.Tools.NuGet.Sources/NuGetSourcesSettings" Derived56["GitVersionSettings"]-->Type click Derived56 "/api/Cake.Common.Tools.GitVersion/GitVersionSettings" Derived57["NuGetAddSettings"]-->Type click Derived57 "/api/Cake.Common.Tools.NuGet.Add/NuGetAddSettings" Derived58["ChocolateyApiKeySettings"]-->Type click Derived58 "/api/Cake.Common.Tools.Chocolatey.ApiKey/ChocolateyApiKeySettings" Derived59["MSpecSettings"]-->Type click Derived59 "/api/Cake.Common.Tools.MSpec/MSpecSettings"

Syntax

public class ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
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.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
ToolPath FilePath
Gets or sets the tool path.
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.

Extension Methods

Name Value Summary
Dump<ToolSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ToolSettings>(ToolSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ToolSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ToolSettings>(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