MarkdownlintIssuesAliases Class

Summary

Contains functionality for reading issues from Markdownlint log files. Provider for issues reported my markdownlint-cli. Provider for issues reported my Markdownlint.
Assembly
Cake.Issues.Markdownlint.dll
Namespace
Cake.Issues.Markdownlint
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MarkdownlintIssuesAliases"] class Type type-node

Syntax

public static class MarkdownlintIssuesAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
MarkdownlintAddRuleUrlResolver(ICakeContext, Func<MarkdownlintRuleDescription, Uri>) void
Registers a new URL resolver with default priority of 0.
static
MarkdownlintAddRuleUrlResolver(ICakeContext, Func<MarkdownlintRuleDescription, Uri>, int) void
Registers a new URL resolver with a specific priority.
static
MarkdownlintCliLogFileFormat(ICakeContext) BaseMarkdownlintLogFileFormat
Gets an instance for the log format as written by markdownlint-cli or Cake.Markdownlint.
static
MarkdownlintIssues(ICakeContext, MarkdownlintIssuesSettings) IIssueProvider
Gets an instance of a provider for issues reported by Markdownlint using specified settings.
static
MarkdownlintIssuesFromContent(ICakeContext, string, BaseMarkdownlintLogFileFormat) IIssueProvider
Gets an instance of a provider for issues reported by Markdownlint using log file content.
static
MarkdownlintIssuesFromFilePath(ICakeContext, FilePath, BaseMarkdownlintLogFileFormat) IIssueProvider
Gets an instance of a provider for issues reported by Markdownlint using a log file from disk.
static
MarkdownlintIssuesProviderTypeName(ICakeContext) string
Gets the name of the Markdownlint issue provider. This name can be used to identify issues based on the ProviderType property.
static
MarkdownlintLogFileFormat(ICakeContext) BaseMarkdownlintLogFileFormat
Gets an instance for the log format as written by Markdownlint.
static
GitHub