fix(invalid span): skip the snippet when read_span fails #347
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
zkat
reviewed
Feb 21, 2024
src/handlers/graphical.rs
Outdated
| writeln!( | ||
| f, | ||
| " [{} `{}`: {:?}]", | ||
| "no snippet, error in label".style(self.theme.styles.error), |
There was a problem hiding this comment.
Suggested change
| "no snippet, error in label".style(self.theme.styles.error), | |
| "Failed to read contents for label".style(self.theme.styles.error), |
src/handlers/graphical.rs
Outdated
| Err(err) => { | ||
| writeln!( | ||
| f, | ||
| " [{} `{}`: {:?}]", |
There was a problem hiding this comment.
We should print the source name, at least. Possibly the span, as well.
There was a problem hiding this comment.
There is no name at this point. We only have a SourceCode trait object, which will give the name but only if the read_span succeeds.
|
The CI failure should be addressed with #348 |
Fixes: zkat#219 When a snippet couldn't be read (typically because the span didn't fit within the source code), it and the rest of the diagnostic were silently dropped, which was confusing to the developer. Now, in place of the snippet, print an error message with the name of the failed label and the error it triggered, then proceed with the rest of the diagnostic (footer, related, ...)
zkat
approved these changes
Feb 21, 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.
Fixes: #219
When a snippet couldn't be read (typically because the span didn't fit within the source code), it and the rest of the diagnostic were silently dropped, which was confusing to the developer.
Now, in place of the snippet, print an error message with the name of the failed label and the error it triggered, then proceed with the rest of the diagnostic (footer, related, ...)
This is what it looks like:
