Repository navigation
feat: add configurable output stream - #13
Merged
Merged
Conversation
Collaborator
|
Thanks, in hindsight defaulting to stdout was a mistake. Next major we should switch the default. |
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
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.
picospinnercurrently writes all spinner frames toprocess.stdout. That is fine for simple interactive CLIs, but it breaks commands that reserve stdout for machine-readable output, such as JSON intended forjq, shell scripts, or CI tooling.This PR adds an optional
streamfield toDisplayOptions, so callers can route spinner UI tostderr:This gives CLI authors a way to follow the common convention (https://clig.dev/#the-basics) that
stdoutis for program output andstderris for status/progress UI, without monkeypatchingpicospinnerinternals (as I temporary did here).The default behavior is unchanged: spinners still write to process.stdout unless a stream is provided.
Testing instructions
jqto assert that it's indeed printed to stderr:jq: parse error: Invalid numeric literal at line 1, column 3):@43081j @PondWader