ToolSettings Class

Summary

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

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.Issues addin
NotNull<ToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp 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