Make the reporter public #341
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
approved these changes
Apr 13, 2023
oliverchang
approved these changes
Apr 13, 2023
michaelkedar
approved these changes
Apr 13, 2023
Comment on lines
61
to
69
| func (r *Reporter) PrintResult(vulnResult *models.VulnerabilityResults) error { | ||
| switch r.format { | ||
| case "json": | ||
| return PrintJSONResults(vulnResult, r.stdout) | ||
| return output.PrintJSONResults(vulnResult, r.stdout) | ||
| case "markdown": | ||
| PrintMarkdownTableResults(vulnResult, r.stdout) | ||
| output.PrintMarkdownTableResults(vulnResult, r.stdout) | ||
| case "table": | ||
| PrintTableResults(vulnResult, r.stdout) | ||
| output.PrintTableResults(vulnResult, r.stdout) | ||
| } |
There was a problem hiding this comment.
nit:
Since it's public, I think it'd make sense to make Reporter an interface, with individual json/markdown/table/void reporter implementations.
That way, an external program could write/wrap their own logging/formatting outputs.
(Also, it avoids this awkward format checking)
There was a problem hiding this comment.
This sounds like a interesting idea, I'll make the changes and push it in a separate PR.
This was referenced Apr 13, 2023
another-rex
added a commit
that referenced
this pull request
Apr 26, 2023
The reporter has been refactored to be an interface with various implementations. Based on the idea from Michael here: #341 (comment) Want to get some feedback on whether this is worth changing or not. I'm also not sure if we should have the different reporter types public here, or make them private and have the users of the library provide their own implementations of Reporter.
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.
Make the reporter package public so that it can be passed into the public DoScan function.