Add "pretty" json configuration and change default behavior to be space-efficient #2275
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
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
| @@ -62,6 +58,13 @@ func AssertEncoderAgainstGoldenSnapshot(t *testing.T, cfg EncoderSnapshotTestCon | |||
| return | |||
| } | |||
|
|
|||
| var expected []byte | |||
There was a problem hiding this comment.
I don't understand why this code moved down. It seems like this change has no effect, which makes me think I'm missing something.
There was a problem hiding this comment.
I should have explicitly labeled this change (I can split this into another PR if needed). The first iteration of this PR was heavy on snapshot testing, which after adding I backed out the change and added more explicit tests. In adding these snapshots I was surprised to see that I couldn't add any snapshots! This fixes that bug, where the snapshot needed to exist in order to update it, which is not correct.
kzantow
reviewed
Nov 2, 2023
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
wagoodman
changed the title
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
wagoodman
force-pushed
the
compact-json
branch
from
359df2e
to
4bb03af
Compare
wagoodman
changed the title
|
@wagoodman I defer to the other reviewers for their comments being addressed here, but it looks like a cli test is failing |
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
GijsCalis
pushed a commit
to GijsCalis/syft
that referenced
this pull request
Feb 19, 2024
…ce-efficient (anchore#2275) * expose underlying format options Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * remove escape html options and address PR feedback Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * incorporate PR feedback Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli test Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
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.
This PR adds the following configuration options:
*-jsonformats:pretty: include indentation and newlines (default tofalse)*-xmlformats:pretty: include indentation at the beginning of new lines (default tofalse)This affects the following formats:
syft-jsoncyclonedx-jsoncyclonedx-xmlspdx-jsonA top-level
format.prettyswitch was also added that drives the default of anyformat.*.prettyoption (by default it is unset, allowing the other options to default tofalse).This changes the default JSON output to compact JSON.
Closes #561