Ordered kv's in dumps #463
Open
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
Closed
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.
I was writing a serializer/deserializer for goldmark AST and was comparing
.Dump's output to quickly check that AST survives the roundtrip encoding intact. But sinceDumpHelperuses Golang'smapfor thekv's, the output is not deterministic (kv's are swapped randomly).This PR solves this (admittedly very niche) issue by sorting the kv's by key before printing them out. I used
sort.Sliceinstead of more modernslices.Sortto preserve the minimal supported go version.I don't think that this issue is worth the pain of changing
DumpHelper's signature to use slices forkv, especially since it is a public func, but perhaps it's worth the tiny inefficiency of sorting the values. What do you think?P.S.: thanks for the great library!