This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Issues.
Summary
Definition of a log file format for
IIssueProvider which support different log file formats.
- Assembly
- Cake
.Issues .dll - Namespace
- Cake
.Issues - Implementing Types
graph BT
Type["ILogFileFormat<TIssueProvider, TSettings>"]
class Type type-node
Implementing0["BaseEsLintLogFileFormat"]-.->Type
click Implementing0 "/api/Cake.Issues.EsLint/BaseEsLintLogFileFormat"
Implementing1["BaseLogFileFormat<TIssueProvider, TSettings>"]-.->Type
click Implementing1 "/api/Cake.Issues/BaseLogFileFormat_2"
Implementing2["BaseMsBuildLogFileFormat"]-.->Type
click Implementing2 "/api/Cake.Issues.MsBuild/BaseMsBuildLogFileFormat"
Implementing3["BaseMarkdownlintLogFileFormat"]-.->Type
click Implementing3 "/api/Cake.Issues.Markdownlint/BaseMarkdownlintLogFileFormat"
Syntax
public interface ILogFileFormat<in TIssueProvider, in TSettings>
where TIssueProvider : BaseMultiFormatIssueProvider<in TSettings, in TIssueProvider> where TSettings : BaseMultiFormatIssueProviderSettings<in TIssueProvider, in TSettings>Type Parameters
| Name | Description |
|---|---|
| TIssueProvider | Type of the issue provider. |
| TSettings | Type of the settings. |
Methods
| Name | Value | Summary |
|---|---|---|
| ReadIssues |
IEnumerable |
Gets all issues.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|