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 issue providers supporting multiple log formats.
- Assembly
- Cake
.Issues .dll - Namespace
- Cake
.Issues - Interfaces
- Base Types
- Derived Types
graph BT
Type-->Base0["BaseConfigurableIssueProvider<TSettings>"]
Base0-->Base1["BaseIssueProvider"]
click Base1 "/api/Cake.Issues/BaseIssueProvider"
Base1-->Base2["BaseIssueComponent<IReadIssuesSettings>"]
Base2-->Base3["Object"]
Type-.->Interface0["IIssueProvider"]
click Interface0 "/api/Cake.Issues/IIssueProvider"
Type-.->Interface1["IBaseIssueComponent<IReadIssuesSettings>"]
Type["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"]
class Type type-node
Derived0["MarkdownlintIssuesProvider"]-->Type
click Derived0 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesProvider"
Derived1["MsBuildIssuesProvider"]-->Type
click Derived1 "/api/Cake.Issues.MsBuild/MsBuildIssuesProvider"
Derived2["EsLintIssuesProvider"]-->Type
click Derived2 "/api/Cake.Issues.EsLint/EsLintIssuesProvider"
Syntax
public abstract class BaseMultiFormatIssueProvider<TSettings, TIssueProvider> :
BaseConfigurableIssueProvider<TSettings>, IIssueProvider,
IBaseIssueComponent<IReadIssuesSettings>
where TSettings : BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings> where TIssueProvider : BaseMultiFormatIssueProvider<TSettings, TIssueProvider>
Type Parameters
Name | Description |
---|---|
TSettings | Type of the settings. |
TIssueProvider | Type of the issue provider. |
Constructors
Name | Summary |
---|---|
Base |
Base class for issue providers supporting multiple log formats. |
Properties
Name | Value | Summary |
---|---|---|
ProviderName | string |
Gets the human friendly name of the issue provider.
Inherited from BaseIssueProvider
|
ProviderType | string |
Gets the type of the issue provider.
Inherited from BaseIssueProvider
|
Methods
Name | Value | Summary |
---|---|---|
InternalReadIssues |
IEnumerable |
Gets all issues.
Compared to
ReadIssues() it is safe to access Settings from this method.
|
ReadIssues |
IEnumerable |
Gets all issues.
Inherited from BaseIssueProvider
|
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
|