MarkdownlintIssuesAliases.

MarkdownlintIssuesFromFilePath(ICakeContext, FilePath, BaseMarkdownlintLogFileFormat) Method

Summary

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

Syntax

public static IIssueProvider MarkdownlintIssuesFromFilePath(this ICakeContext context, FilePath logFilePath, BaseMarkdownlintLogFileFormat format)

Examples

Read issues reported by Cake.Markdownlint:

var issues =
        ReadIssues(
            MarkdownlintIssuesFromFilePath(
                @"c:\build\Markdownlint.log",
                MarkdownlintCliLogFileFormat),
            @"c:\repo");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
logFilePath FilePath Path to 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