docs(list): note --full requirement on the JSON ci object - #3220
Merged
Conversation
The `wt list --json` Fields table described `ci` as "absent when no CI", omitting that the object is only populated under `--full` (or `[list] full`, or the statusline JSON path) — the same gate the Columns table and the `[list] columns` note already document. A consumer scripting plain `wt list --json` would see `ci` always absent and misread it as "no CI configured". State the `--full` requirement on the field row. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
worktrunk-bot
approved these changes
Jun 25, 2026
max-sixty
added a commit
that referenced
this pull request
Jun 25, 2026
…lds (#3224) Follow-up to #3220. That PR added the `--full` qualifier to the JSON `ci` field row; the `summary` field and the `main` object's `diff` sub-field have the identical omission. Both are gated by `--full` in the same `skip_tasks` block (`SummaryGenerate` and `BranchDiff` are dropped when not `--full`), and both Columns-table rows already say "`--full` only" while their JSON field rows didn't — so a consumer scripting plain `wt list --json` would see `summary`/`main.diff` always absent and misread the cause. This states the requirement on both rows, so all three `--full`-gated JSON surfaces (`ci`, `summary`, `main.diff`) read consistently. Edited in `src/cli/mod.rs` (the `after_long_help` primary source); the `docs/content/list.md` and skill-reference mirrors plus the two `--help` snapshots are regenerated. > _This was written by Claude Code on behalf of max_ Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
2 participants
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.
The
wt list --jsonFields table described theciobject as "absent when no CI", which omits the actual gate:ciis only populated under--full(or[list] full, or the statusline JSON path) — the same--fullrequirement the Columns table and the[list] columnsnote already document. A consumer scripting plainwt list --jsonseescialways absent and reasonably misreads it as "no CI configured" rather than "needs--full".This states the requirement on the field row:
--fullonly, then absent when no PR/MR or branch workflow. Source edit is insrc/cli/mod.rs(theafter_long_helpprimary source); thedocs/content/list.mdand skill-reference mirrors plus the two--helpsnapshots are regenerated.