MarkdownlintIssuesAliases.

MarkdownlintIssuesFromContent(ICakeContext, string, BaseMarkdownlintLogFileFormat) Method

Summary

Gets an instance of a provider for issues reported by Markdownlint using log file content.
Assembly
Cake.Issues.Markdownlint.dll
Namespace
Cake.Issues.Markdownlint
Containing Type
MarkdownlintIssuesAliases

Syntax

public static IIssueProvider MarkdownlintIssuesFromContent(this ICakeContext context, string logFileContent, BaseMarkdownlintLogFileFormat format)

Examples

Read issues reported by Markdownlint:

var issues =
        ReadIssues(
            MarkdownlintIssuesFromContent(
                logFileContent,
                MarkdownlintLogFileFormat),
            @"c:\repo");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
logFileContent string Content of the the Markdownlint log file. The log file needs to be in the format as defined by the format parameter.
format BaseMarkdownlintLogFileFormat Format of the provided Markdownlint log file.

Return Value

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