chore: pretty-print JSON in snapshots #647
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
Otherwise, it can be very hard to review a PR that updates a snapshot. Signed-off-by: Will Murphy <[email protected]>
orjson is the preferred JSON package in this project, but only supports indent 2. Track the script that formats the JSON snapshots, and switch to indenting at 2 spaces to permit using orjson. Signed-off-by: Will Murphy <[email protected]>
Signed-off-by: Will Murphy <[email protected]>
Since this script is not part of Vunnel, it should not be declared in the pyproject.toml tool.poetry.scripts block. Signed-off-by: Will Murphy <[email protected]>
westonsteimel
approved these changes
Jul 31, 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.
Otherwise, it can be very hard to review a PR that updates a snapshot.
For some added context, #645 shows some differences in snapshot JSON that look like they're just reordering keys, but it's very hard to tell. Therefore, sort and indent the JSON on snapshot comparison so that the diffs are more obvious.
This was discovered on the way to fixing #644.
Note for reviewers: there are only a few manual changes in this PR:
make formatvia the makefile changetests/conftext.pyis changed to format json before comparing workspace snapshotsmake format