Features
The Cake.Issues.Tap addin provides the following features.
Basic features¶
- Reads issues from files in Test Anything Protocol (TAP) format version 13 or 14.
Supported log file formats¶
Note
Details, like file, line / column or rule information, are not standardized in Test Anything Protocol (TAP). The GenericLogFileFormat
will therefore only return issues containing the description, which might be the file name for some tools. To retrieve detailed information a tool specific log file format needs to be used which can parse the non-standardized data provided by the tool for every issue.
- GenericLogFileFormat alias for reading issues from any Test Anything Protocol (TAP) compatible file
- StylelintLogFileFormat alias for reading TAP files generated by stylelint.
- Provides URLs for rules shipped with stylelint.
- Support for custom URL resolving using the
TapStylelintAddRuleUrlResolver
alias.
- TextlintLogFileFormat alias for reading TAP files generated by Textlint.
- Provides URLs for rules shipped with Textlint.
- Support for custom URL resolving using the
TapTextlintAddRuleUrlResolver
alias.
Supported IIssue properties¶
-
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
-
IIssue.PriorityName
-
IIssue.RuleId
-
IIssue.RuleUrl
- Can be set while reading issues
- Set to
IIssue.MessageText
- Can be set while reading issues
-
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
-
IIssue.PriorityName
-
IIssue.RuleId
-
IIssue.RuleUrl
(4)
- Can be set while reading issues
- Set to
IIssue.MessageText
- Can be set while reading issues
- For rules shipped with stylelint. Support for additional rules can be added through a custom
TapTextlintAddRuleUrlResolver
.
-
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
-
IIssue.PriorityName
-
IIssue.RuleId
-
IIssue.RuleUrl
(4)
- Can be set while reading issues
- Set to
IIssue.MessageText
- Can be set while reading issues
- For rules shipped with Textlint. Support for additional rules can be added through a custom
TapStylelintAddRuleUrlResolver
.