Cake.Issues.Markdownlint

The Markdownlint support for the Cake.Issues addin allows you to read issues logged by Markdownlint. This addin provides the aliases for reading Markdownlint issues and providing them to the Cake.Issues addin. It also requires the core Cake.Issues addin. There are also additional addins for generating reports or posting issues to pull requests. See cakeissues.net for an overview of the whole ecosystem of addins for working with issues in Cake scripts.

#addin nuget:?package=Cake.Issues.Markdownlint&version=0.9.0

<package id="Cake.Issues.Markdownlint" version="0.9.0" />

dotnet add package Cake.Issues.Markdownlint --version 0.9.0

<PackageReference Include="Cake.Issues.Markdownlint" Version="0.9.0" />

Aliases

Contains functionality for reading issues from Markdownlint log files. Provider for issues reported my markdownlint-cli. Provider for issues reported my Markdownlint.

Issue Providers

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