MarkdownlintIssuesAliases.

MarkdownlintIssues(ICakeContext, MarkdownlintIssuesSettings) Method

Summary

Gets an instance of a provider for issues reported by Markdownlint using specified settings.

Syntax

public static IIssueProvider MarkdownlintIssues(this ICakeContext context, MarkdownlintIssuesSettings settings)

Examples

Read issues reported by Cake.Markdownlint:

 var settings =
         new MarkdownlintIssuesSettings(
             @"C:\build\Markdownlint.log",
             MarkdownlintCliLogFileFormat);

     var issues =
         ReadIssues(
             MarkdownlintIssuesFromFilePath(settings),
             @"c:\repo");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings MarkdownlintIssuesSettings Settings for reading the Markdownlint log.

Return Value

Type Description
IIssueProvider Instance of a provider for issues reported by Markdownlint.