Features
The Cake.Issues.Markdownlint addin provides the following features.
Basic features¶
- Reads warnings from Markdownlint logfiles.
- Provides URLs for all issues.
- Support for custom URL resolving using the MarkdownlintAddRuleUrlResolver alias (except for MarkdownlintCliJsonLogFileFormat).
Supported log file formats¶
- MarkdownlintV1LogFileFormat
alias for reading issues from Markdownlint
output generated with
options.resultVersion
set to 1. - MarkdownlintCliLogFileFormat alias for reading issues from markdownlint-cli log files.
- MarkdownlintCliJsonLogFileFormat
alias for reading issues from markdownlint-cli
log files created with the
--json
parameter.
Tip
markdownlint-cli can be run with the Cake.Markdownlint addin.
Supported IIssue properties¶
Property | Remarks | |
---|---|---|
IIssue.ProviderType |
||
IIssue.ProviderName |
||
IIssue.Run |
Can be set while reading issues | |
IIssue.Identifier |
Set to IIssue.MessageText |
|
IIssue.ProjectName |
||
IIssue.ProjectFileRelativePath |
||
IIssue.AffectedFileRelativePath |
||
IIssue.Line |
||
IIssue.EndLine |
||
IIssue.Column |
Only for MarkdownlintCliLogFileFormat | |
IIssue.EndColumn |
||
IIssue.FileLink |
Can be set while reading issues | |
IIssue.MessageText |
||
IIssue.MessageHtml |
||
IIssue.MessageMarkdown |
||
IIssue.Priority |
Always IssuePriority.Warning | |
IIssue.PriorityName |
Always Warning |
|
IIssue.Rule |
||
IIssue.RuleUrl |
Support for custom rules can be added through a custom MarkdownlintAddRuleUrlResolver except for MarkdownlintCliJsonLogFileFormat |