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.Markdownlint.
Summary
Provider for issues reported by Markdownlint.
- Assembly
- Cake
.Issues .Markdownlint .dll - Namespace
- Cake
.Issues .Markdownlint - Interfaces
- Base Types
graph BT
Type-->Base0["BaseMultiFormatIssueProvider<MarkdownlintIssuesSettings, MarkdownlintIssuesProvider>"]
Base0-->Base1["BaseConfigurableIssueProvider<MarkdownlintIssuesSettings>"]
Base1-->Base2["BaseIssueProvider"]
click Base2 "/api/Cake.Issues/BaseIssueProvider"
Base2-->Base3["BaseIssueComponent<IReadIssuesSettings>"]
Base3-->Base4["Object"]
Type-.->Interface0["IIssueProvider"]
click Interface0 "/api/Cake.Issues/IIssueProvider"
Type-.->Interface1["IBaseIssueComponent<IReadIssuesSettings>"]
Type["MarkdownlintIssuesProvider"]
class Type type-node
Syntax
public class MarkdownlintIssuesProvider :
BaseMultiFormatIssueProvider<MarkdownlintIssuesSettings, MarkdownlintIssuesProvider>,
IIssueProvider, IBaseIssueComponent<IReadIssuesSettings>Constructors
| Name | Summary |
|---|---|
| Markdownlint |
Provider for issues reported by Markdownlint. |
Properties
| Name | Value | Summary |
|---|---|---|
| ProviderName | string |
Gets the human friendly name of the issue provider.
|
| ProviderType | string |
Gets the type of the issue provider.
Inherited from BaseIssueProvider
|
| ProviderTypeName | string |
Gets the name of the Markdownlint issue provider.
This name can be used to identify issues based on the
ProviderType property.
static
|
Methods
| Name | Value | Summary |
|---|---|---|
| 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
|