Add validation for additional unnecessary locations #1181
Merged
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
ToddGrun
reviewed
Aug 26, 2024
| @@ -10,8 +10,13 @@ namespace Microsoft.CodeAnalysis.Testing.TestAnalyzers | |||
| public abstract class AbstractHighlightTokensAnalyzer : DiagnosticAnalyzer | |||
| { | |||
| protected AbstractHighlightTokensAnalyzer(string id, params int[] tokenKinds) | |||
| : this(id, customTags: new string[0], tokenKinds) | |||
There was a problem hiding this comment.
➡️ Not available in all target frameworks.
ToddGrun
reviewed
Aug 26, 2024
| int[] unnecessaryIndices = { }; | ||
| if (actual.diagnostic.Properties.TryGetValue(WellKnownDiagnosticTags.Unnecessary, out var encodedUnnecessaryLocations)) | ||
| { | ||
| verifier.True(actual.diagnostic.Descriptor.CustomTags.Contains(WellKnownDiagnosticTags.Unnecessary), "Diagnostic reported extended unnecessary locations, but the descriptor is not marked as unnecessary code."); |
There was a problem hiding this comment.
➡️ No, a primary use case for faded diagnostics is when the primary diagnostic location is faded. There would be no additional property in this case.
ToddGrun
reviewed
Aug 26, 2024
| var match = EncodedIndicesSyntax.Match(encodedUnnecessaryLocations); | ||
| verifier.True(match.Success, $"Expected encoded unnecessary locations to be a valid JSON array of non-negative integers: {encodedUnnecessaryLocations}"); | ||
| unnecessaryIndices = match.Groups["Index"].Captures.OfType<Capture>().Select(capture => int.Parse(capture.Value)).ToArray(); | ||
| verifier.NotEmpty(nameof(unnecessaryIndices), unnecessaryIndices); |
There was a problem hiding this comment.
➡️ I felt it would be harder to understand why the regex failed
ToddGrun
reviewed
Aug 26, 2024
| AppendLocation(diagnostics[i].Location); | ||
| foreach (var additionalLocation in diagnostics[i].AdditionalLocations) | ||
| // The unnecessary code designator is ignored for the primary diagnostic location. | ||
| AppendLocation(diagnostics[i].Location, isUnnecessary: false); |
ToddGrun
reviewed
Aug 26, 2024
| var match = EncodedIndicesSyntax.Match(encodedUnnecessaryLocations); | ||
| if (match.Success) | ||
| { | ||
| unnecessaryIndices = match.Groups["Index"].Captures.OfType<Capture>().Select(capture => int.Parse(capture.Value)).ToArray(); |
There was a problem hiding this comment.
➡️ Will keep this form, since the collection is typically small, and if we ever want to add assertions about uniqueness or order it will be clearer what we are starting with.
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.
No description provided.