CakeReportPrinterBase Class

Summary

Base-implementation for ICakeReportPrinter.
Assembly
Cake.Module.Shared.dll
Namespace
Cake.Module.Shared
Interfaces
  • ICakeReportPrinter
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type-.->Interface0["ICakeReportPrinter"] Type["CakeReportPrinterBase"] class Type type-node Derived0["AzurePipelinesReportPrinter"]-->Type click Derived0 "/api/Cake.AzurePipelines.Module/AzurePipelinesReportPrinter" Derived1["MyGetReportPrinter"]-->Type click Derived1 "/api/Cake.MyGet.Module/MyGetReportPrinter"

Syntax

public abstract class CakeReportPrinterBase : ICakeReportPrinter

Constructors

Name Summary
CakeReportPrinterBase(IConsole, ICakeContext) Initializes a new instance of the CakeReportPrinterBase class.

Fields

Name Constant Value Summary
_console
Gets the IConsole.
_context
Gets the ICakeContext.

Methods

Name Value Summary
FormatDuration(CakeReportEntry) string
Returns the formatted time it took to process one CakeReportEntry.
static
FormatTime(TimeSpan) string
Formats a TimeSpan.
static
GetItemForegroundColor(CakeReportEntry) ConsoleColor
Calculates the foreground color required to write out one CakeReportEntry.
static
GetTotalTime(IEnumerable<CakeReportEntry>) TimeSpan
Calculates the total time it took to process all CakeReportEntry elements.
static
ShouldWriteTask(CakeReportEntry) bool
Check if the CakeReportEntry should be written.
Write(CakeReport) void
WriteLifeCycleStep(string, Verbosity) void
WriteSkippedStep(string, Verbosity) void
WriteStep(string, Verbosity) void
WriteToConsole(CakeReport) void
Writes the report to the IConsole.

Extension Methods

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