GenericIssueReportFormatAliases Class

Summary

Contains functionality for creating issue reports in any text based format (HTML, Markdown, ...). NOTE: Use Cake.Issues.Reporting.Generic addin to use these aliases with Cake Script Runners and Cake.Frosting.Issues.Reporting.Generic to use these aliases with Cake Frosting.
Assembly
Cake.Issues.Reporting.Generic.dll
Namespace
Cake.Issues.Reporting.Generic
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GenericIssueReportFormatAliases"] class Type type-node

Syntax

public static class GenericIssueReportFormatAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
GenericIssueReportFormat(ICakeContext, GenericIssueReportFormatSettings) IIssueReportFormat
Gets an instance of the generic report format using specified settings.
static
GenericIssueReportFormatFromContent(ICakeContext, string, Action<GenericIssueReportFormatSettings>) IIssueReportFormat
Gets an instance of the generic report format using a template string with custom settings.
static
GenericIssueReportFormatFromContent(ICakeContext, string) IIssueReportFormat
Gets an instance of the generic report format using a template string.
static
GenericIssueReportFormatFromEmbeddedTemplate(ICakeContext, GenericIssueReportTemplate, Action<GenericIssueReportFormatSettings>) IIssueReportFormat
Gets an instance of the generic report format using an embedded template with custom settings.
static
GenericIssueReportFormatFromEmbeddedTemplate(ICakeContext, GenericIssueReportTemplate) IIssueReportFormat
Gets an instance of the generic report format using an embedded template.
static
GenericIssueReportFormatFromFilePath(ICakeContext, FilePath, Action<GenericIssueReportFormatSettings>) IIssueReportFormat
Gets an instance of the generic report format using a local template with custom settings.
static
GenericIssueReportFormatFromFilePath(ICakeContext, FilePath) IIssueReportFormat
Gets an instance of the generic report format using a local template.
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