-
-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: added optional jsw format to json reporter #5017
Open
CheadleCheadle
wants to merge
6
commits into
mochajs:master
Choose a base branch
from
CheadleCheadle:optional-reporter-format
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat: added optional jsw format to json reporter #5017
CheadleCheadle
wants to merge
6
commits into
mochajs:master
from
CheadleCheadle:optional-reporter-format
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
JoshuaKGoldberg
added
status: waiting for author
waiting on response from OP - more information needed
semver-minor
implementation requires increase of "minor" version number; "features"
labels
Mar 4, 2024
JoshuaKGoldberg
requested changes
Mar 4, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Marking as waiting for changes per #4889 (comment).
JoshuaKGoldberg
changed the title
added optional jsw format to json reporter
feat: added optional jsw format to json reporter
Mar 4, 2024
I addressed the changes requested in #4889 (comment). Instead of |
JoshuaKGoldberg
added
status: in triage
a maintainer should (re-)triage (review) this issue
and removed
status: waiting for author
waiting on response from OP - more information needed
labels
Mar 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
semver-minor
implementation requires increase of "minor" version number; "features"
status: in triage
a maintainer should (re-)triage (review) this issue
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.
Requirements
Description of the Change
Added an optional CLI argument ('jsw' or 'jsonStringifyWhitespace') that allows for the user to set the whitespace of the JSON reporter. If it isn't provided it defaults to the current value (2).
This change allows for more customization of the JSON output!
Closes #4889
Alternate Designs
An alternative approach might involve using a boolean CLI argument to toggle the JSON reporter and remove whitespace. However, a more precise level of customization can be achieved by using a CLI argument to control the amount of whitespace instead.
Why should this be in core?
It's a relatively simple change that simplifies the parsing of the JSON output."
Benefits
This feature would prove valuable when parsing JSON test results. For example, Splunk mandates JSON formatting with no whitespace, and having the option to generate whitespace-free JSON would enable Splunk to directly use the data without additional processing.
Possible Drawbacks
There shouldn't be any drawbacks to making this modification. It allows for further customization but is kept default if not specified.
Applicable issues
N/A