Simplify exposed output package methods #402
Merged
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.
Continuing to work towards more stable and usable package APIs for a
conftest
v1 release, this PR reworks theoutput
package.Remove
Manager
terminology in favor of types that represent what they output. A package consumer could create an output type by sayingoutput.JSON
Remove the
Flush()
andPut()
methods on eachOutputter
in favor of a singleOutput()
. Everywhere in the codebase we were just ranging over theCheckResults
collection to Put() them into the output manager and then flushing. This lets us just pass in a collection of results and write them e.g.log.Logger
withio.Writer
. This gives us, as well as package consumers, way more flexibility in how they can get at the formatted output. Tests can continue to pass inbytes.Buffer
, and the Conftest binary can pass inos.Stdout
.