Issue 3100 - Changed SA1600 and tests to meet new documentInterfaces values #3140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #3140 +/- ##
=========================================
Coverage ? 97.11%
=========================================
Files ? 828
Lines ? 104096
Branches ? 3361
=========================================
Hits ? 101098
Misses ? 2104
Partials ? 894 |
sharwell
requested changes
Jul 30, 2020
| @@ -66,7 +66,7 @@ public async Task TestPartialTypeWithoutDocumentationAsync(string typeKeyword) | |||
| ""settings"": {{ | |||
| ""documentationRules"": {{ | |||
| ""documentExposedElements"": false, | |||
| ""{interfaceSettingName}"": false | |||
| ""{interfaceSettingName}"": ""false"" | |||
There was a problem hiding this comment.
📝 This shouldn't change. It should continue to allow false and true (unquoted) for compatibility purposes.
Suggested change
| ""{interfaceSettingName}"": ""false"" | |
| ""{interfaceSettingName}"": false |
| @@ -100,7 +100,7 @@ public async Task TestPartialClassWithEmptyDocumentationAsync(string typeKeyword | |||
| ""settings"": {{ | |||
| ""documentationRules"": {{ | |||
| ""documentExposedElements"": false, | |||
| ""{interfaceSettingName}"": false | |||
| ""{interfaceSettingName}"": ""false"" | |||
There was a problem hiding this comment.
Suggested change
| ""{interfaceSettingName}"": ""false"" | |
| ""{interfaceSettingName}"": false |
| @@ -140,7 +140,7 @@ public async Task TestPartialTypesWithMissingButNotRequiredDocumentationAsync(st | |||
| ""settings"": {{ | |||
| ""documentationRules"": {{ | |||
| ""documentExposedElements"": false, | |||
| ""{interfaceSettingName}"": false | |||
| ""{interfaceSettingName}"": ""false"" | |||
There was a problem hiding this comment.
Suggested change
| ""{interfaceSettingName}"": ""false"" | |
| ""{interfaceSettingName}"": false |
Comment on lines
+147
to
+151
| [InlineData("true")] | ||
| [InlineData("false")] | ||
| [InlineData("all")] | ||
| [InlineData("none")] | ||
| [InlineData("exposed")] |
There was a problem hiding this comment.
Suggested change
| [InlineData("true")] | |
| [InlineData("false")] | |
| [InlineData("all")] | |
| [InlineData("none")] | |
| [InlineData("exposed")] | |
| [InlineData("true")] | |
| [InlineData("false")] | |
| [InlineData("\"all\"")] | |
| [InlineData("\"none\"")] | |
| [InlineData("\"exposed\"")] |
| {{ | ||
| ""settings"": {{ | ||
| ""documentationRules"": {{ | ||
| ""documentInterfaces"": ""{value}"" |
There was a problem hiding this comment.
Suggested change
| ""documentInterfaces"": ""{value}"" | |
| ""documentInterfaces"": {value} |
| @@ -75,7 +75,7 @@ internal class DocumentationSettings | |||
| /// <summary> | |||
| /// This is the backing field for the <see cref="DocumentInterfaces"/> property. | |||
| /// </summary> | |||
| private readonly bool documentInterfaces; | |||
| private readonly string documentInterfaces; | |||
There was a problem hiding this comment.
💡 Use a new enumeration for this field
| "description": "Specifies whether interface members need to be documented. When true, all interface members require documentation, regardless of accessibility.", | ||
| "default": true | ||
| "default": "all" |
There was a problem hiding this comment.
Suggested change
| "default": "all" | |
| "default": "all", | |
| "enum": [ | |
| "all", | |
| "exposed", | |
| "none", | |
| true, | |
| false | |
| ] |
| @@ -221,9 +221,9 @@ | |||
| "default": false | |||
| }, | |||
| "documentInterfaces": { | |||
| "type": "boolean", | |||
| "type": "string", | |||
There was a problem hiding this comment.
Suggested change
| "type": "string", | |
| "type": [ "string", "boolean" ], |
|
Any progress with this issue? I see the suggested |
|
I'm looking through the older pull requests in this repo. Is this something that you will continue working on, @CPAM34? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As specified in issue #3100, the documentInterfaces setting has been modified to allow the support the new range of acceptable values - "all"/"true", "exposed", and "none"/"false". Test cases and checks have also been modified to take into account the setting now being a string instead of a bool.