Summary

Base class for all Chocolatey related tools.

Namespace

Cake.Common.Tools.Chocolatey

Base Types

Derived Types

Syntax

public abstract class ChocolateyTool<TSettings> : Tool<TSettings> where TSettings : ToolSettings

Name	Description
TSettings	The settings type.

Name	Summary
ChocolateyTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, IChocolateyToolResolver)	Initializes a new instance of the `ChocolateyTool<TSettings>` class.

Name	Value	Summary
AddGlobalArguments(ChocolateySettings, ProcessArgumentBuilder)	ProcessArgumentBuilder	Adds common arguments to the process builder.
AddSharedArguments(ChocolateySharedSettings, ProcessArgumentBuilder)	ProcessArgumentBuilder	Adds shared arguents to the process builder.
GetAlternativeToolPaths(TSettings)	IEnumerable<FilePath>	Gets alternative file paths which the tool may exist in.
GetToolExecutableNames()	IEnumerable<string>	Gets the possible names of the tool executable.
GetToolName()	string	Gets the name of the tool.

Name	Value	Summary
Dump<ChocolateyTool<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<ChocolateyTool<TSettings>>(ChocolateyTool<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<ChocolateyTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<ChocolateyTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<ChocolateyTool<TSettings>>(string, string)	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<ChocolateyTool<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin