Enable output to both JSON and CLI #931
Open
Conversation
This file contains hidden or 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: Garett Brown <garett.brown@xanadu.ai>
|
Please address the CI issues above, thanks! |
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.
Context:
The CLI output, especially with the
--reduced-profileflag, provides concise, actionable, and human readable information for improving and optimizing code. Additionally, the JSON output provides verbose details, perfect to use for machine-automated interpretation and analysis of the results.Changes:
This PR enables the ability to save both the CLI output and the JSON output from the same profile when both the
--cliand--jsonflags are used in conjunction with--outfile.Drawbacks:
If both the
--cliand--jsonare used and--outfileis not used, then both the JSON and the CLI output are printed to STDOUT. This is clunky, but would be the expected behaviour if--outfileis not used and--cliis specified.Comments:
I understand that the default behaviour is to produce a JSON file and a human readable HTML file. The change in this PR reflects the desire to provide the option of having the human readable profile as a text file, rather than an HTML.