Improve reporting of related locations #4929
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
keyboardDrummer
changed the title
MikaelMayer
previously approved these changes
Jan 9, 2024
| } | ||
|
|
||
| public void WriteSourceCodeSnippet(IToken tok, TextWriter tw) { | ||
| string line = GetFileLine(tok.Uri, tok.line - 1); | ||
| if (line == null) { |
There was a problem hiding this comment.
Makes sense, thanks for doing that!
| yield return SerializeRelated(tok, null, "Related location"); | ||
| while (tok is NestedToken nestedToken) { | ||
| tok = nestedToken.Inner; | ||
| var message = nestedToken.Message != null ? "Related location: " + nestedToken.Message : "Related location"; |
There was a problem hiding this comment.
Good job updating this! I don't think it is tested, is it?
There was a problem hiding this comment.
It is, in Source/IntegrationTests/bin/Test/cli/diagnosticsFormats.dfy
| rwLock.EnterWriteLock(); | ||
| try { | ||
| counts[dafnyDiagnostic.Level] = counts.GetValueOrDefault(dafnyDiagnostic.Level, 0) + 1; | ||
| if (messageSource != MessageSource.Verifier && messageSource != MessageSource.Compiler) { | ||
| if (dafnyDiagnostic.Source != MessageSource.Verifier && dafnyDiagnostic.Source != MessageSource.Compiler) { |
There was a problem hiding this comment.
I like dafnyDiagnostic more than message too
|
|
||
| yield return new DafnyRelatedInformation(token, message); | ||
| if (inner != null) { | ||
| foreach (var nestedInformation in CreateDiagnosticRelatedInformationFor(inner, newMessage)) { |
MikaelMayer
approved these changes
Jan 9, 2024
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.
Description
Behavior
Make reporting of related locations more consistent, so related locations are always shown on a separate line. Example:
This style already occurred in many other locations, such as here:
and here:
Refactoring
LocalVariableDeclarationVisitorinto its own file, without changesSymbolDeclarationResolverinto its own file, without changesDiagnosticUtilinto its own file, and rename toDiagnosticsUtilMapTypeinto its own file, without changesHow has this been tested?
Expect files have been updated to match the new related location format.
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.