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
Base class for all log file format implementations.
- Assembly
- Cake
.Issues .dll - Namespace
- Cake
.Issues - Interfaces
- Base Types
-
- Object
- Derived Types
graph BT
Type-->Base0["Object"]
Type-.->Interface0["ILogFileFormat<TIssueProvider, TSettings>"]
Type["BaseLogFileFormat<TIssueProvider, TSettings>"]
class Type type-node
Derived0["BaseEsLintLogFileFormat"]-->Type
click Derived0 "/api/Cake.Issues.EsLint/BaseEsLintLogFileFormat"
Derived1["BaseMarkdownlintLogFileFormat"]-->Type
click Derived1 "/api/Cake.Issues.Markdownlint/BaseMarkdownlintLogFileFormat"
Derived2["BaseMsBuildLogFileFormat"]-->Type
click Derived2 "/api/Cake.Issues.MsBuild/BaseMsBuildLogFileFormat"
Syntax
public abstract class BaseLogFileFormat<TIssueProvider, TSettings> :
ILogFileFormat<TIssueProvider, TSettings>
where TIssueProvider : BaseMultiFormatIssueProvider<TSettings, TIssueProvider> where TSettings : BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>
Type Parameters
Name | Description |
---|---|
TIssueProvider | Type of the issue provider. |
TSettings | Type of the settings. |
Constructors
Name | Summary |
---|---|
BaseLogFileFormat |
Initializes a new instance of the BaseLogFileFormat<TIssueProvider, TSettings> class.
|
Properties
Name | Value | Summary |
---|---|---|
Log | ICakeLog |
Gets the Cake log instance.
|
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
|