Merge pull request cake-contrib#25 from cake-contrib/feature/iissue-p…

…roperties (cake-contribGH-9) Document properties set on IIssue for each issue provider
pascalberger · Oct 18, 2017 · b2a6b5e · b2a6b5e
2 parents df011b4 + 853c438
commit b2a6b5e
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 5 deletions.
diff --git a/input/docs/issue-providers/docfx/features.md b/input/docs/issue-providers/docfx/features.md
@@ -8,6 +8,17 @@ The [Cake.Issues.DocFx addin] provides the following features:
 * Reads warnings from [DocFx] log files.
 * Supported comment formats:
   * Plain text
+* Supported `IIssue` properties:
+  * [ProviderType]
+  * [AffectedFileRelativePath]
+  * [Line]
+  * [Message]
+  * [Rule]
 
 [Cake.Issues.DocFx addin]: https://www.nuget.org/packages/Cake.Issues.DocFx
-[DocFx]: https://dotnet.github.io/docfx/
+[DocFx]: https://dotnet.github.io/docfx/
+[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72
+[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1
+[Line]: ../../api/Cake.Issues/IIssue/F2A42E89
+[Message]: ../../api/Cake.Issues/IIssue/18537A3D
+[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E
diff --git a/input/docs/issue-providers/eslint/features.md b/input/docs/issue-providers/eslint/features.md
@@ -12,7 +12,22 @@ The [Cake.Issues.EsLint addin] provides the following features:
   * Plain text
 * Provides URLs for all issues.
 * Support for custom URL resolving using the [EsLintAddRuleUrlResolver] alias.
+* Supported `IIssue` properties:
+  * [ProviderType]
+  * [AffectedFileRelativePath]
+  * [Line]
+  * [Message]
+  * [Priority]
+  * [Rule]
+  * [RuleUrl]
 
 [Cake.Issues.EsLint addin]: https://www.nuget.org/packages/Cake.Issues.EsLint
 [json formatter]: http://eslint.org/docs/user-guide/formatters/#json
-[EsLintAddRuleUrlResolver]: ../../api/Cake.Issues.EsLint/EsLintIssuesAliases/66FCBDE8
+[EsLintAddRuleUrlResolver]: ../../api/Cake.Issues.EsLint/EsLintIssuesAliases/66FCBDE8
+[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72
+[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1
+[Line]: ../../api/Cake.Issues/IIssue/F2A42E89
+[Message]: ../../api/Cake.Issues/IIssue/18537A3D
+[Priority]: ../../api/Cake.Issues/IIssue/BFEFFBB1
+[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E
+[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355
diff --git a/input/docs/issue-providers/inspectcode/features.md b/input/docs/issue-providers/inspectcode/features.md
@@ -9,6 +9,19 @@ The [Cake.Issues.InspectCode addin] provides the following features:
 * Supported comment formats:
   * Plain text
 * Provides URLs for issues containing a Wiki URL.
+* Supported `IIssue` properties:
+  * [ProviderType]
+  * [AffectedFileRelativePath]
+  * [Line]
+  * [Message]
+  * [Rule]
+  * [RuleUrl]
 
 [JetBrains InsepectCode]: https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html
-[Cake.Issues.InspectCode addin]: https://www.nuget.org/packages/Cake.Issues.InspectCode
+[Cake.Issues.InspectCode addin]: https://www.nuget.org/packages/Cake.Issues.InspectCode
+[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72
+[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1
+[Line]: ../../api/Cake.Issues/IIssue/F2A42E89
+[Message]: ../../api/Cake.Issues/IIssue/18537A3D
+[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E
+[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355
diff --git a/input/docs/issue-providers/markdownlint/features.md b/input/docs/issue-providers/markdownlint/features.md
@@ -9,6 +9,19 @@ The [Cake.Issues.Markdownlint addin] provides the following features:
 * Supported comment formats:
   * Plain text
 * Provides URLs for all issues.
+* Supported `IIssue` properties:
+  * [ProviderType]
+  * [AffectedFileRelativePath]
+  * [Line]
+  * [Message]
+  * [Rule]
+  * [RuleUrl]
 
 [Cake.Issues.Markdownlint addin]: https://www.nuget.org/packages/Cake.Issues.Markdownlint
-[Markdownlint]: https://github.com/DavidAnson/markdownlint
+[Markdownlint]: https://github.com/DavidAnson/markdownlint
+[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72
+[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1
+[Line]: ../../api/Cake.Issues/IIssue/F2A42E89
+[Message]: ../../api/Cake.Issues/IIssue/18537A3D
+[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E
+[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355
diff --git a/input/docs/issue-providers/msbuild/features.md b/input/docs/issue-providers/msbuild/features.md
@@ -12,7 +12,20 @@ The [Cake.Issues.MsBuild addin] provides the following features:
   * Plain text
 * Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings.
 * Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias.
+* Supported `IIssue` properties:
+  * [ProviderType]
+  * [AffectedFileRelativePath]
+  * [Line]
+  * [Message]
+  * [Rule]
+  * [RuleUrl]
 
 [Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild
 [MSBuild Extension Pack XmlFileLogger]: http://www.msbuildextensionpack.com/help/4.0.5.0/html/242ab4fd-c2e2-f6aa-325b-7588725aed24.htm
-[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487
+[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487
+[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72
+[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1
+[Line]: ../../api/Cake.Issues/IIssue/F2A42E89
+[Message]: ../../api/Cake.Issues/IIssue/18537A3D
+[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E
+[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355