Add a field order option for the pretty-printer #1199
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
For human consumers, it's usually nice to show record fields in the same order they appear in the source (as sometimes programmers use the field order as a communication channel to other programmers). However, for machine consumers, sometimes it is nicer to adhere to a rigid, predictable format. This commit adds a setting, `field-order`, to switch between these two modes, with a backward-compatible default.
robdockins
approved these changes
May 25, 2021
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.
We're working on a cryptol-to-C compiler, and one way we've been validating that it's working right is to use the cryptol repl's
:dumptestsfeature and a small C wrapper that treats them as golden tests. I'd like to keep the C wrapper's parser simple, and if records get printed with a predictable field order, that simplifies the parser a lot.This pull request adds a feature for this: a new setting,
fieldOrder/field-orderin the REPL, which can be set tocanonicalordisplay, and which controls the pretty-printer for records. It defaults todisplayfor backwards compatibility.(Actually, I'm going to use a different branch than
masterfor the C compiler, but I'd like to minimize drift between them if possible.)