MarkdownlintIssuesProvider Class

Summary

Provider for issues reported by Markdownlint.
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

Properties

Name Value Summary
ProviderName string
Gets the human friendly name of the issue provider.
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<IIssue>
Gets all issues.
Inherited from BaseIssueProvider

Extension Methods

Name Value Summary
Dump<MarkdownlintIssuesProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MarkdownlintIssuesProvider>(MarkdownlintIssuesProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MarkdownlintIssuesProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<MarkdownlintIssuesProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<MarkdownlintIssuesProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MarkdownlintIssuesProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin