Repository navigation
fix(cli): --out writes only to the file, not also to stdout - #371
Merged
Merged
Conversation
Every command that takes --out shares one helper, _write_or_print, which despite its name wrote the file AND still printed the whole report to stdout. So `patchrail ci explain --log ci.log --out report.md` flooded the terminal with the report a first-timer had just asked to send to a file, and a CI script capturing stdout while using --out got the report duplicated into its pipe. Make --out silent on stdout, matching curl -o / gcc -o / openssl -out and the helper's own name; running without --out prints exactly as before. Add a regression test for `ci explain --out`.
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.
--outis meant to redirect output to a file. But every command that takes--outshares one helper —_write_or_print— which, despite its name, wrote the file and still printed the whole report to stdout:So
patchrail ci explain --log ci.log --out report.mdflooded the terminal with the report a first-timer had just asked to send to a file, and a CI script capturing stdout while using--outgot the report duplicated into its pipe (having to add> /dev/nullto work around it).Fix:
--outis now silent on stdout — matchingcurl -o,gcc -o,openssl … -outand the helper's own name (_write_or_print= write or print). Running without--outprints to stdout exactly as before.Shared by every
--outcommand (ci explain/classify/classes,redact,evidence …, and the rest).Before / after
Tests
test_ci_explain_out_writes_file_without_teeing_stdout: exit 0, stdout empty, file contains the report.Marca: Pablo Guillén · PatchRail · getpatchrail.com