Match protojson's output field order #40
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
jhump
reviewed
Aug 9, 2024
| return err.Error(), nil | ||
| } | ||
| return "", nil | ||
| return golden.GenGoldenContent(filePath, data) |
There was a problem hiding this comment.
I am super-confused by the previous formulation that you've replaced. It looks like it basically always returned the empty string on success, instead of string(data). But the new formulation "round-trips" the file and returns the contents after re-marshaling.
All that intended? Mind adding some remarks in a comment or in the PR description to provide some guidance on some of this diff?
There was a problem hiding this comment.
Yes, I added a new 'class' of tests for valid .yaml files, that verifies the marshalled output is as expected.
There was a problem hiding this comment.
(basically, it validates that everything is normalized and in the right order for valid .yamls)
jhump
approved these changes
Aug 12, 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.
see #36
JSON objects are unmarshaled into (unordered) go maps by default. This PR uses yaml.Node (when possible) instead, which preserves the field order from protojson.
Note that yaml refuses to parse control characters into yaml.Nodes, though otherwise handle them correctly.