Improve snippet parse error context #46277
Open
+9
−5
Conversation
This file contains hidden or 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
cla-bot
bot
added
the
cla-signed
Contributor
SomeoneToIgnore
left a comment
SomeoneToIgnore
left a comment
There was a problem hiding this comment.
Thank you.
Since we start to improve things around, let's do a bit more?
| let body = snippet.body.to_string(); | ||
| if snippet::Snippet::parse(&body).log_err().is_none() { | ||
| if snippet::Snippet::parse(&body) | ||
| .with_context(|| format!("invalid snippet in {} ({})", source.display(), name)) |
Contributor
There was a problem hiding this comment.
Suggested change
| .with_context(|| format!("invalid snippet in {} ({})", source.display(), name)) | |
| .with_context(|| format!("invalid snippet '{name}' in {source:?}")) |
Can we
-
reword the error a bit to make it more obvious where the snippet name is (not sure if single quotes around are good, just proposing)?
-
do a
if let Err(e) = snippet::Snippet::parse(&body) {
log::error!("Invalid snippet '{name}' in {source:?}: {e:#}
}-like change instead of log_err()?
The latter shows quite a backtrace in the settings, which seems totally unneeded.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Release Notes:
Description:
E.g. Instead of saying:
2026-01-07T09:08:42-06:00 ERROR [crates/snippet_provider/src/lib.rs:46] failed to parse snippet
Caused by:
expected an integer
Now the logs give more valuable information like:
2026-01-07T10:47:39-06:00 ERROR [crates/snippet_provider/src/lib.rs:48] invalid snippet in /Users/oscarvarto/Library/Application Support/Zed/extensions/installed/django-snippets/./snippets/python.json (re_path)