ToolSettingsExtensions Class

Summary

Contains functionality related to ToolSettings.
Namespace
Cake.Core.Tooling
Base Types
  • object
graph BT Type-->Base0["object"] Type["ToolSettingsExtensions"] class Type type-node

Syntax

public static class ToolSettingsExtensions

Methods

Name Value Summary
WithArgumentCustomization<T>(T, Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
static
WithEnvironmentVariable<T>(T, string, string) T
Sets or adds tool environment variable.
static
WithExpectedExitCode<T>(T, int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
static
WithHandleExitCode<T>(T, Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
static
WithNoWorkingDirectory<T>(T, bool) T
Sets whether the tool should use a working directory or not.
static
WithPostAction<T>(T, Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
static
WithSetupProcessSettings<T>(T, Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
static
WithToolPath<T>(T, FilePath) T
Sets the tool path.
static
WithToolSettings<T>(T, Action<T>) T
Provides fluent null guarded tool settings action.
static
WithToolTimeout<T>(T, TimeSpan) T
Sets the tool timeout.
static
WithWorkingDirectory<T>(T, DirectoryPath) T
Sets the tool working directory.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin