Skip to content

Commit a3edc8e

Browse files
authored
Improve feature overview for different markdownlint log file formats (#951)
1 parent 0fd77f4 commit a3edc8e

File tree

1 file changed

+94
-28
lines changed
  • docs/input/documentation/issue-providers/markdownlint

1 file changed

+94
-28
lines changed

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

Lines changed: 94 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,100 @@ provides the following features.
3232

3333
## Supported IIssue properties
3434

35-
<div class="annotate" markdown>
35+
=== "MarkdownlintV1LogFileFormat"
3636

37-
- [x] `IIssue.ProviderType`
38-
- [x] `IIssue.ProviderName`
39-
- [ ] `IIssue.Run` (1)
40-
- [x] `IIssue.Identifier` (2)
41-
- [ ] `IIssue.ProjectName`
42-
- [ ] `IIssue.ProjectFileRelativePath`
43-
- [x] `IIssue.AffectedFileRelativePath`
44-
- [x] `IIssue.Line`
45-
- [ ] `IIssue.EndLine`
46-
- [x] `IIssue.Column` (3)
47-
- [ ] `IIssue.EndColumn`
48-
- [ ] `IIssue.FileLink` (4)
49-
- [x] `IIssue.MessageText`
50-
- [ ] `IIssue.MessageHtml`
51-
- [ ] `IIssue.MessageMarkdown`
52-
- [x] `IIssue.Priority` (5)
53-
- [x] `IIssue.PriorityName` (6)
54-
- [x] `IIssue.RuleId`
55-
- [x] `IIssue.RuleUrl` (7)
37+
<div class="annotate" markdown>
38+
39+
- [x] `IIssue.ProviderType`
40+
- [x] `IIssue.ProviderName`
41+
- [ ] `IIssue.Run` (1)
42+
- [x] `IIssue.Identifier` (2)
43+
- [ ] `IIssue.ProjectName`
44+
- [ ] `IIssue.ProjectFileRelativePath`
45+
- [x] `IIssue.AffectedFileRelativePath`
46+
- [x] `IIssue.Line`
47+
- [ ] `IIssue.EndLine`
48+
- [ ] `IIssue.Column`
49+
- [ ] `IIssue.EndColumn`
50+
- [ ] `IIssue.FileLink` (3)
51+
- [x] `IIssue.MessageText`
52+
- [ ] `IIssue.MessageHtml`
53+
- [ ] `IIssue.MessageMarkdown`
54+
- [x] `IIssue.Priority` (4)
55+
- [x] `IIssue.PriorityName` (5)
56+
- [x] `IIssue.RuleId`
57+
- [x] `IIssue.RuleUrl` (6)
58+
59+
</div>
60+
61+
1. Can be set while reading issues
62+
2. Set to `IIssue.MessageText`
63+
3. Can be set while reading issues
64+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
65+
5. Always `Warning`
66+
6. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"}
5667

57-
</div>
68+
=== "MarkdownlintCliLogFileFormat"
5869

59-
1. Can be set while reading issues
60-
2. Set to `IIssue.MessageText`
61-
3. Only for [MarkdownlintCliLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/B518F49E){target="_blank"}
62-
4. Can be set while reading issues
63-
5. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
64-
6. Always `Warning`
65-
7. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"} except for [MarkdownlintCliJsonLogFileFormat](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/36DE6F5F){target="_blank"}
70+
<div class="annotate" markdown>
71+
72+
- [x] `IIssue.ProviderType`
73+
- [x] `IIssue.ProviderName`
74+
- [ ] `IIssue.Run` (1)
75+
- [x] `IIssue.Identifier` (2)
76+
- [ ] `IIssue.ProjectName`
77+
- [ ] `IIssue.ProjectFileRelativePath`
78+
- [x] `IIssue.AffectedFileRelativePath`
79+
- [x] `IIssue.Line`
80+
- [ ] `IIssue.EndLine`
81+
- [x] `IIssue.Column`
82+
- [ ] `IIssue.EndColumn`
83+
- [ ] `IIssue.FileLink` (3)
84+
- [x] `IIssue.MessageText`
85+
- [ ] `IIssue.MessageHtml`
86+
- [ ] `IIssue.MessageMarkdown`
87+
- [x] `IIssue.Priority` (4)
88+
- [x] `IIssue.PriorityName` (5)
89+
- [x] `IIssue.RuleId`
90+
- [x] `IIssue.RuleUrl` (6)
91+
92+
</div>
93+
94+
1. Can be set while reading issues
95+
2. Set to `IIssue.MessageText`
96+
3. Can be set while reading issues
97+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
98+
5. Always `Warning`
99+
6. Support for custom rules can be added through a custom [MarkdownlintAddRuleUrlResolver](https://cakebuild.net/api/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases/2EE35F55){target="_blank"}
100+
101+
=== "MarkdownlintCliJsonLogFileFormat"
102+
103+
<div class="annotate" markdown>
104+
105+
- [x] `IIssue.ProviderType`
106+
- [x] `IIssue.ProviderName`
107+
- [ ] `IIssue.Run` (1)
108+
- [x] `IIssue.Identifier` (2)
109+
- [ ] `IIssue.ProjectName`
110+
- [ ] `IIssue.ProjectFileRelativePath`
111+
- [x] `IIssue.AffectedFileRelativePath`
112+
- [x] `IIssue.Line`
113+
- [x] `IIssue.EndLine`
114+
- [x] `IIssue.Column`
115+
- [x] `IIssue.EndColumn`
116+
- [ ] `IIssue.FileLink` (3)
117+
- [x] `IIssue.MessageText`
118+
- [ ] `IIssue.MessageHtml`
119+
- [ ] `IIssue.MessageMarkdown`
120+
- [x] `IIssue.Priority` (4)
121+
- [x] `IIssue.PriorityName` (5)
122+
- [x] `IIssue.RuleId`
123+
- [x] `IIssue.RuleUrl`
124+
125+
</div>
126+
127+
1. Can be set while reading issues
128+
2. Set to `IIssue.MessageText`
129+
3. Can be set while reading issues
130+
4. Always [IssuePriority.Warning](https://cakebuild.net/api/Cake.Issues/IssuePriority/7A0CE07F){target="_blank"}
131+
5. Always `Warning`

0 commit comments

Comments
 (0)