Skip to content

skills(writing-user-outputs): route --format=json through print_json #3750

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.

Sign up for GitHub

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

Merged
max-sixty merged 5 commits into from
Aug 8, 2026
Merged

skills(writing-user-outputs): route --format=json through print_json #3750

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffd48f5
skills(writing-user-outputs): route --format=json through print_json
worktrunk-bot Aug 6, 2026
1a92fab
skills(writing-user-outputs): thirty open-coded, not thirty-six
worktrunk-bot Aug 6, 2026
b451dd4
skills(writing-user-outputs): drop the call-site tally and the worked…
worktrunk-bot Aug 6, 2026
547785a
Merge remote-tracking branch 'origin/main' into nightly/clean-3107989…
worktrunk-bot Aug 8, 2026
6774349
skills(writing-user-outputs): name println_verbatim! as the pre-rende…
worktrunk-bot Aug 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion .claude/skills/writing-user-outputs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,39 @@ use worktrunk::styling::{eprintln, println, stderr};
// Status messages to stderr
eprintln!("{}", success_message("Created worktree"));

// Primary output to stdout (tables, JSON, pipeable)
// Primary output to stdout (tables, shell code, pipeable)
println!("{}", table_output);

// Flush before interactive prompts
stderr().flush()?;
```

Which `println!` is in scope decides whether a closed pipe panics: std's
panics on the `BrokenPipe` write error, anstream's drops it. `wt … | head`
closes the pipe, so command code imports the `worktrunk::styling` one and no
`std::println!` is left in `src/`.

**Output whose ANSI is already decided** goes through
`crate::output::println_verbatim!` instead — the statusline a shell prompt or
Claude Code renders, and the `--help-page` document whose escapes the docs
pipeline turns into HTML. Neither consumer is ever a tty, so anstream would
strip their color every time, and the test suite would not catch it because it
forces color with `CLICOLOR_FORCE=1`. `println_verbatim!` writes the bytes
through unchanged and drops a `BrokenPipe` the same way anstream does. Reach
for it only when the pipe is a courier rather than the destination; anything a
person reads directly stays on anstream, which is what strips color on a pipe
and honors `NO_COLOR`.

**`--format=json` answers** go through `crate::output::print_json`, never a
hand-rolled `println!("{}", serde_json::to_string_pretty(&v)?)`. It serializes
pretty with one trailing newline and prints through anstream, so no
`--format=json` surface panics when its consumer stops reading. Before that,
thirty call sites had open-coded those two lines, and whether any one of them
panicked under `| head -3` came down to which `println!` its module happened to
import. `wt switch --format=json` is the one non-caller: it emits its single
result as one compact line (still through anstream's `println!`), because that
is what a shell loop reads.

**Shell integration functions** (`src/output/global.rs`):

| Function | Purpose |
Expand Down
Loading