CakeRunner Class

Summary

Cake out process runner.
Namespace
Cake.Common.Tools.Cake
Base Types
graph BT Type-->Base0["Tool<CakeSettings>"] Base0-->Base1["object"] Type["CakeRunner"] class Type type-node

Syntax

public sealed class CakeRunner : Tool<CakeSettings>

Constructors

Methods

Name Value Summary
ExecuteExpression(string, CakeSettings) void
Executes supplied cake code expression in own process and supplied settings.
ExecuteScript(FilePath, CakeSettings) void
Executes supplied cake script in own process and supplied settings.
GetAlternativeToolPaths(CakeSettings) IEnumerable<FilePath>
Gets alternative file paths which the tool may exist in.
GetToolExecutableNames() IEnumerable<string>
Gets the name of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

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