Features

The Cake.Issues.Markdownlint addin provides the following features.

Tip: Running markdownlint

markdownlint-cli can be run with the Cake.Markdownlint addin.

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.

Supported IIssue properties

MarkdownlintV1LogFileFormatMarkdownlintCliLogFileFormatMarkdownlintCliJsonLogFileFormat

• IIssue.ProviderType
• IIssue.ProviderName
• IIssue.Run (1)
• IIssue.Identifier (2)
• IIssue.ProjectName
• IIssue.ProjectFileRelativePath
• IIssue.AffectedFileRelativePath
• IIssue.Line
• IIssue.EndLine
• IIssue.Column
• IIssue.EndColumn
• IIssue.FileLink (3)
• IIssue.MessageText
• IIssue.MessageHtml
• IIssue.MessageMarkdown
• IIssue.Priority (4)
• IIssue.PriorityName (5)
• IIssue.RuleId
• IIssue.RuleUrl (6)

1. Can be set while reading issues
2. Set to IIssue.MessageText
3. Can be set while reading issues
4. Always IssuePriority.Warning
5. Always Warning
6. Support for custom rules can be added through a custom MarkdownlintAddRuleUrlResolver

• IIssue.ProviderType
• IIssue.ProviderName
• IIssue.Run (1)
• IIssue.Identifier (2)
• IIssue.ProjectName
• IIssue.ProjectFileRelativePath
• IIssue.AffectedFileRelativePath
• IIssue.Line
• IIssue.EndLine
• IIssue.Column
• IIssue.EndColumn
• IIssue.FileLink (3)
• IIssue.MessageText
• IIssue.MessageHtml
• IIssue.MessageMarkdown
• IIssue.Priority (4)
• IIssue.PriorityName (5)
• IIssue.RuleId
• IIssue.RuleUrl (6)

1. Can be set while reading issues
2. Set to IIssue.MessageText
3. Can be set while reading issues
4. Always IssuePriority.Warning
5. Always Warning
6. Support for custom rules can be added through a custom MarkdownlintAddRuleUrlResolver

• IIssue.ProviderType
• IIssue.ProviderName
• IIssue.Run (1)
• IIssue.Identifier (2)
• IIssue.ProjectName
• IIssue.ProjectFileRelativePath
• IIssue.AffectedFileRelativePath
• IIssue.Line
• IIssue.EndLine
• IIssue.Column
• IIssue.EndColumn
• IIssue.FileLink (3)
• IIssue.MessageText
• IIssue.MessageHtml
• IIssue.MessageMarkdown
• IIssue.Priority (4)
• IIssue.PriorityName (5)
• IIssue.RuleId
• IIssue.RuleUrl

1. Can be set while reading issues
2. Set to IIssue.MessageText
3. Can be set while reading issues
4. Always IssuePriority.Warning
5. Always Warning