-
Notifications
You must be signed in to change notification settings - Fork 9
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: support json output #77
Merged
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
G-Rath
force-pushed
the
add-json-output
branch
2 times, most recently
from
March 28, 2022 04:39
bb041d8
to
db38c19
Compare
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 originally started as a general output re-design, but turned into supporting json output.
I'm somewhat annoyed at this because outputting in the loop is nice but when you're outputting JSON you want to do it as an array and... ugh it just kind of breaks the single responsibility principle.
However I think I've found a good solution: having a
Reporter
class that tracks this (and so owns the responsibility for outputting) - all that functions are required to do is produce "results" which contractually must be convertible to a "string" format and to json (which is implied).The main icky thing with this is that you need to ensure that#Finish
is called, which is technically an implication detail but afaik there's no escaping it - really, this is a form of RAII that's made icky by the fact that you have to make it that by setting up thedefer
(e.g. it'd be better if the class itself could somehow setup thedefer
).I've made this a bit nicer by renaming
Finish
toPrintJSON
which then means its the responsibility of the "user" to know when/if they want to call that.Anyway, this should be fine I think - hopefully I've not missed something that makes it horrible to use.
Resolves #10