Skip to content

Commit 2e8988e

Browse files
authored
Improve feature overview for different MsBuild log file formats (#952)
1 parent a3edc8e commit 2e8988e

File tree

1 file changed

+62
-29
lines changed
  • docs/input/documentation/issue-providers/msbuild

1 file changed

+62
-29
lines changed

docs/input/documentation/issue-providers/msbuild/features.md

Lines changed: 62 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,68 @@ provides the following features.
2323

2424
## Supported IIssue properties
2525

26-
<div class="annotate" markdown>
27-
28-
- [x] `IIssue.ProviderType`
29-
- [x] `IIssue.ProviderName`
30-
- [ ] `IIssue.Run` (1)
31-
- [x] `IIssue.Identifier` (2)
32-
- [x] `IIssue.ProjectName`
33-
- [x] `IIssue.ProjectFileRelativePath`
34-
- [x] `IIssue.AffectedFileRelativePath`
35-
- [x] `IIssue.Line`
36-
- [ ] `IIssue.EndLine`
37-
- [x] `IIssue.Column` (3)
38-
- [ ] `IIssue.EndColumn`
39-
- [ ] `IIssue.FileLink` (4)
40-
- [x] `IIssue.MessageText`
41-
- [ ] `IIssue.MessageHtml`
42-
- [ ] `IIssue.MessageMarkdown`
43-
- [x] `IIssue.Priority`
44-
- [x] `IIssue.PriorityName`
45-
- [x] `IIssue.RuleId`
46-
- [x] `IIssue.RuleUrl` (5)
47-
48-
</div>
49-
50-
1. Can be set while reading issues
51-
2. Set to `IIssue.MessageText`
52-
3. Only for [MsBuildXmlFileLoggerFormat](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E){target="_blank"}
53-
4. Can be set while reading issues
54-
5. For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487){target="_blank"}
26+
=== "MsBuildBinaryLogFileFormat"
27+
28+
<div class="annotate" markdown>
29+
30+
- [x] `IIssue.ProviderType`
31+
- [x] `IIssue.ProviderName`
32+
- [ ] `IIssue.Run` (1)
33+
- [x] `IIssue.Identifier` (2)
34+
- [x] `IIssue.ProjectName`
35+
- [x] `IIssue.ProjectFileRelativePath`
36+
- [x] `IIssue.AffectedFileRelativePath`
37+
- [x] `IIssue.Line`
38+
- [ ] `IIssue.EndLine`
39+
- [x] `IIssue.Column`
40+
- [ ] `IIssue.EndColumn`
41+
- [ ] `IIssue.FileLink` (3)
42+
- [x] `IIssue.MessageText`
43+
- [ ] `IIssue.MessageHtml`
44+
- [ ] `IIssue.MessageMarkdown`
45+
- [x] `IIssue.Priority`
46+
- [x] `IIssue.PriorityName`
47+
- [x] `IIssue.RuleId`
48+
- [x] `IIssue.RuleUrl` (4)
49+
50+
</div>
51+
52+
1. Can be set while reading issues
53+
2. Set to `IIssue.MessageText`
54+
3. Can be set while reading issues
55+
4. For .NET SDK analyzers (`CA*`), StyleCop analyzer rules (`SA*`), SonarLint rules (`S*`) and Roslynator rules (`RCS*`). Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver]{target="_blank"}
56+
57+
=== "MsBuildXmlFileLoggerFormat"
58+
59+
<div class="annotate" markdown>
60+
61+
- [x] `IIssue.ProviderType`
62+
- [x] `IIssue.ProviderName`
63+
- [ ] `IIssue.Run` (1)
64+
- [x] `IIssue.Identifier` (2)
65+
- [x] `IIssue.ProjectName`
66+
- [x] `IIssue.ProjectFileRelativePath`
67+
- [x] `IIssue.AffectedFileRelativePath`
68+
- [x] `IIssue.Line`
69+
- [ ] `IIssue.EndLine`
70+
- [ ] `IIssue.Column`
71+
- [ ] `IIssue.EndColumn`
72+
- [ ] `IIssue.FileLink` (3)
73+
- [x] `IIssue.MessageText`
74+
- [ ] `IIssue.MessageHtml`
75+
- [ ] `IIssue.MessageMarkdown`
76+
- [x] `IIssue.Priority`
77+
- [x] `IIssue.PriorityName`
78+
- [x] `IIssue.RuleId`
79+
- [x] `IIssue.RuleUrl` (4)
80+
81+
</div>
82+
83+
1. Can be set while reading issues
84+
2. Set to `IIssue.MessageText`
85+
3. Can be set while reading issues
86+
4. For .NET SDK analyzers (`CA*`), StyleCop analyzer rules (`SA*`), SonarLint rules (`S*`) and Roslynator rules (`RCS*`). Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver]{target="_blank"}
5587

5688
[DotNet aliases]: https://cakebuild.net/dsl/dotnet/#Built-In
5789
[MsBuild aliases]: https://cakebuild.net/dsl/msbuild/#Built-In
90+
[MsBuildAddRuleUrlResolver]: https://cakebuild.net/api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487

0 commit comments

Comments
 (0)