ConsoleIssueReportFormatAliases.

ConsoleIssueReportFormat(ICakeContext, ConsoleIssueReportFormatSettings) Method

Summary

Gets an instance of the console report format using specified settings.
Assembly
Cake.Issues.Reporting.Console.dll
Namespace
Cake.Issues.Reporting.Console
Containing Type
ConsoleIssueReportFormatAliases

Syntax

public static IIssueReportFormat ConsoleIssueReportFormat(this ICakeContext context, ConsoleIssueReportFormatSettings settings)

Examples

Report issues to console grouped by rule:

 var settings =
         new ConsoleIssueReportFormatSettings
         {
             GroupByRule = true
         };

     CreateIssueReport(
         issues,
         ConsoleIssueReportFormat(settings),
         @"c:\repo",
         string.Empty);

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings ConsoleIssueReportFormatSettings Settings for generating the report.

Return Value

Type Description
IIssueReportFormat Instance of a console report format.
GitHub