Annotate YAML config errors with device, command, and line#289
Open
Annotate YAML config errors with device, command, and line#289
Conversation
5cd9f8e to
629e495
Compare
|
This is way better! Thanks! |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
@jenstopp If you don't like the more complicated yaml parsing i would propose to just stick to printing out the line number which is a very small change. |
0dacc67 to
dc1ebe6
Compare
Contributor
Author
|
I've reverted back to only outputting the line as the other way overcomplicated the yaml parsing. |
Config parse errors previously gave no context about where in the file the problem occurred, e.g.: parsing YAML failed: command must have at least one module Update Command.UnmarshalYAML to include the YAML line number in its validation errors. Errors now read: parsing YAML failed: line 14: ... Signed-off-by: Fabian Wienand <fabian.wienand@9elements.com>
dc1ebe6 to
53ae086
Compare
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
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.
Config parse errors previously gave no context about where in the file the problem occurred, e.g.:
parsing YAML failed: command must have at least one module
Add custom UnmarshalYAML to Devlist and Device that decode each entry individually and wrap errors with the device or command name. Update Command.UnmarshalYAML to include the YAML line number in its validation errors. Errors now read:
parsing YAML failed: device "hermes": command "power": yaml: line 14: ...
resolves #286