BuildScriptHost<TContext> Class

Summary

The script host used to execute Cake scripts.
Namespace
Cake.Cli
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["ScriptHost"] click Base0 "/api/Cake.Core.Scripting/ScriptHost" Base0-->Base1["object"] Type-.->Interface0["IScriptHost"] click Interface0 "/api/Cake.Core.Scripting/IScriptHost" Type["BuildScriptHost<TContext>"] class Type type-node Derived0["BuildScriptHost"]-->Type click Derived0 "/api/Cake.Cli/BuildScriptHost"

Syntax

public class BuildScriptHost<TContext> : ScriptHost, IScriptHost where TContext : ICakeContext

Type Parameters

Name Description
TContext The context type.

Constructors

Name Summary
BuildScriptHost(ICakeEngine, IExecutionStrategy, TContext, ICakeReportPrinter, ICakeLog) Initializes a new instance of the BuildScriptHost<TContext> class.

Properties

Name Value Summary
Context ICakeContext
Gets the context.
Inherited from ScriptHost
Engine ICakeEngine
Gets the engine.
Inherited from ScriptHost
Settings ExecutionSettings
Gets the settings.
Inherited from ScriptHost
Tasks IReadOnlyList<ICakeTaskInfo>
Gets all registered tasks.
Inherited from ScriptHost

Methods

Name Value Summary
RunTarget(string) CakeReport
Runs the specified target.
Inherited from ScriptHost
RunTargetAsync(string) Task<CakeReport>
Runs the specified target.
RunTargets(IEnumerable<string>) CakeReport
Runs the specified targets.
Inherited from ScriptHost
RunTargetsAsync(IEnumerable<string>) Task<CakeReport>
Runs the specified targets.
Setup(Action<ISetupContext>) void
Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
Inherited from ScriptHost
Setup<TData>(Func<ISetupContext, TData>) void
Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
Inherited from ScriptHost
Task(string) CakeTaskBuilder
Registers a new task.
Inherited from ScriptHost
TaskOf<TData>(string) CakeTaskBuilder<TData>
Registers a new task.
Inherited from ScriptHost
TaskSetup(Action<ITaskSetupContext>) void
Allows registration of an action that's executed before each task is run. If the task setup fails, its task will not be executed but the task teardown will be performed.
Inherited from ScriptHost
TaskSetup<TData>(Action<ITaskSetupContext, TData>) void
Allows registration of an action that's executed before each task is run. If the task setup fails, its task will not be executed but the task teardown will be performed.
Inherited from ScriptHost
TaskTeardown(Action<ITaskTeardownContext>) void
Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
Inherited from ScriptHost
TaskTeardown<TData>(Action<ITaskTeardownContext, TData>) void
Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
Inherited from ScriptHost
Teardown(Action<ITeardownContext>) void
Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
Inherited from ScriptHost
Teardown<TData>(Action<ITeardownContext, TData>) void
Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
Inherited from ScriptHost

Extension Methods

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