Skip to content

fix(hooks): expand everything but vars.* in a preview - #3638

Merged
max-sixty merged 4 commits into
mainfrom
hook-preview-shared-context
Jul 28, 2026
Merged

max-sixty merged 4 commits into
mainfrom
hook-preview-shared-context

Conversation

@max-sixty

Copy link
Copy Markdown
Owner

Follow-up to #3635, from two reviews that landed after it merged.

The vars.* preview was worse than #3635 claimed

render_template_preview short-circuits on template_references_var(template, "vars"), returning the raw template. So one vars. token disabled expansion for the entire command:

pre-commit = "deploy --branch={{ branch }} --repo={{ repo }} --env={{ vars.env }}"

before:  deploy --branch={{ branch }} --repo={{ repo }} --env={{ vars.env }}
after:   deploy --branch=main --repo=repo --env={{ vars.env }}

#3635 described this as "a vars.* template renders raw", which is true but understates it: {{ branch }} and {{ repo }} stopped expanding too, in a command whose whole job is to show the expansion. That short-circuit predates #3635 and has been degrading wt hook <type> --dry-run the same way; #3635 only extended it to wt hook show --expanded.

The fix is at the source rather than at either caller. A preview now injects a stand-in object for vars that renders each reference back as itself, nested access included ({{ vars.config.port }} round-trips), while every other variable expands normally. VarsMode::Resolve keeps execution reading real values from git config; only previews pass VarsMode::Literal. A preview also no longer spawns the git read that resolving vars required.

vars.* stays literal on purpose: those values are read when the step runs, after an earlier step in the pipeline may have written them, so a value resolved at preview time can differ from the one the run uses.

Nothing covered this, which is why the suite stayed green through the regression. test_hook_show_expanded_matches_dry_run now sets a var and asserts the listing and the dry-run both leave it alone while expanding {{ branch }} beside it.

The syntax gate is a type error now

#3635 moved the template syntax check out of prepare_steps into a free validate_pipeline_syntax that both execution funnels had to remember to call. prepare_steps now returns a PreparedPipeline the caller must resolve: .validated() for the paths that run hooks, .into_unvalidated() for the listing, which annotates a broken template in place rather than blanking itself. Forgetting is a compile error, the same property ApprovedHookPlan gives hook approval.

Smaller items

Four cross-references went stale when the syntax check moved: PreparedCommand.template, validate_template_syntax, the switch.rs skip comment, and HOOK_INFRASTRUCTURE_VARS (which still named two deleted functions). The --expanded behavior is now documented in the sentence that already owns {{ vars.<key> }} semantics, with its three generated mirrors regenerated.

PreparedStep::commands() replaces two hand-rolled matches in hooks.rs. default_branch moves inside build_manual_hook_template_vars — only the commit-hook arm reads it, and resolving it can cost a git ls-remote on a fresh clone, so the other eight hook types no longer pay for it. The listing carries its expansion state in an Option<String> instead of re-deriving "was this expanded?" from whether a context exists.

This was written by Claude Code on behalf of max

max-sixty and others added 3 commits July 28, 2026 15:49
render_template_preview short-circuited the whole template when it
mentioned vars anywhere, so one {{ vars.x }} reference made
`wt hook show --expanded` and `--dry-run` a no-op for the rest of the
command. A preview now injects a stand-in that renders each reference
back as itself, nested access included, while every other variable
expands.

Also fixes stale cross-references the syntax-gate move left behind and
adopts PreparedStep::commands at two hand-rolled sites.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
prepare_steps returns a PreparedPipeline the caller must resolve:
.validated() for the paths that run hooks, .into_unvalidated() for the
listing that annotates a broken template in place. A new execution path
can no longer skip the check by omitting a line.

Also folds default_branch into build_manual_hook_template_vars (only the
commit-hook arm reads it, and resolving it can cost a git ls-remote), and
carries the listing's expansion state in an Option rather than
re-deriving it from whether a context exists.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@worktrunk-bot worktrunk-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two stale references to validate_pipeline_syntax slipped in — the same class of stale cross-reference this PR set out to fix, except here they point at the function the PR removes. Both should name PreparedPipeline::validated, the path that now runs the check. Suggestions inline. Otherwise the change reads clean: the LiteralVars stand-in round-trips nested access, the VarsMode split keeps execution reading real values, and the #[must_use] PreparedPipeline gate is a nice unforgeable-by-construction property.

Comment thread src/commands/worktree/switch.rs Resolved
Comment thread src/config/expansion.rs Resolved
Three comments still pointed at validate_pipeline_syntax, which this
branch replaces — the same stale-cross-reference class the branch fixes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@max-sixty
max-sixty merged commit 9e7ad01 into main Jul 28, 2026
47 checks passed
@max-sixty
max-sixty deleted the hook-preview-shared-context branch July 28, 2026 23:44
max-sixty added a commit that referenced this pull request Jul 29, 2026
#3638 changed the preview renderer so a template expands everything
around a `{{ vars.<key> }}` reference and leaves only that reference
literal. `wt config alias dry-run` shares that renderer, but its
`--help` text and the `handle_alias_dry_run` docstring still described
the previous all-or-nothing behavior, where a single `vars.` token left
the whole template raw.

This corrects both. The docstring's mention of a separate
syntax-validation step goes with them: expansion reports syntax errors
itself, so there is no longer a distinct validation pass to describe.

No behavior change. The `dry-run` long help isn't rendered into any
generated doc or snapshot, so no mirrors move with it.

> _This was written by Claude Code on behalf of max_

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
@worktrunk-bot worktrunk-bot mentioned this pull request Jul 29, 2026
max-sixty added a commit that referenced this pull request Jul 29, 2026
)

`wt hook show` decided whether a section had printed anything from
whether the config held an entry for each hook type, not from whether
any command was rendered. A hook type declared with an empty command
list has an entry but no commands, so the section printed its heading
and then stopped:

```console
$ cat .config/wt.toml
post-switch = []

$ wt hook show
PROJECT HOOKS @ /path/.config/wt.toml
```

Both sections carried it, since the loop and the `(none configured)`
fallback were duplicated in `render_user_hooks` and
`render_project_hooks`. `render_hook_commands` now reports whether it
wrote any rows, and the loop plus fallback live once in
`render_hook_section`, which both callers delegate to. The flag means
"something was printed", which is what the `(none configured)` line
claims.

The execution path was already correct: an empty list announces nothing,
and the JSON output omits it. Verified against the built binary across
four cases (project-only empty, user-only empty, an empty list alongside
a real hook, and a filter naming the empty type), and pinned by
`test_hook_show_empty_command_lists`, which covers both the user and
project halves. Reverting the flag to its old meaning fails the test on
both.

Also corrects a docstring in the same file that still described the
preview's pre-#3638 behavior ("shows a `vars.*` template raw"), the same
drift #3639 fixed for `wt config alias dry-run`.

> _This was written by Claude Code on behalf of max_

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
worktrunk 0.70.0

Created-by: HarmonybrewBot
Commit-by: HarmonybrewBot
Merged-by: HarmonybrewBot
Description: Created by `brew bump`

---

Created with `brew bump-formula-pr`.<details>
  <summary>release notes</summary>
  <pre>## Release Notes

### Improved

- **`wt step prune` removes worktrees far faster**: Each removal ran a serial chain of ~17 git subprocesses under the scan write lock, re-preparing a plan the scan had already computed and re-stating the worktree right after the fsmonitor daemon stop. The chain is now one check per guarantee, reusing the scan-time plan, and removals run concurrently on the scan lock's read side — the write side is kept for the candidates that need it (hook-bearing, `--foreground`, metadata-pruning, and the current worktree). The documented rust-scale live prune of 24 candidates goes from ~12 s to ~0.6 s wall, and the `prune_e2e/live` benchmark from ~620 ms to ~400 ms. ([#3617](max-sixty/worktrunk#3617), [#3631](max-sixty/worktrunk#3631))

- **`wt step prune --format=json` is ordered, and a failed removal aborts the rest**: Live JSON output is now sorted by scan index, matching `--dry-run`, with the current worktree last. The first failing removal drains the remaining queue unexecuted, matching the serial loop it replaced; in-flight removals complete. ([#3631](max-sixty/worktrunk#3631))

- **A worktree can be named by its path wherever a branch is accepted**: Every argument that takes a branch now also accepts the worktree's own path, resolved after the branch so a directory never shadows a branch sharing its name. A path names what a branch cannot — a detached worktree, or one of two checkouts of the same branch. Relative paths resolve against `-C` and a leading `~` against the home directory, so a path worktrunk printed can be pasted back. [Docs](https://worktrunk.dev/switch/#naming-a-worktree) ([#3607](max-sixty/worktrunk#3607))

- **`wt list` flags a branch checked out in more than one worktree**: Such a branch resolves to whichever worktree git lists first, so every worktree on it now carries `⚑` — `worktree.state` `"duplicate_branch"` in schema 1, a `worktree.duplicate_branch` boolean in schema 2. The flag makes the ambiguity visible in the listing; resolving such a branch from any command warns separately and names a duplicate to drop. ([#3480](max-sixty/worktrunk#3480), [#3606](max-sixty/worktrunk#3606))

- **`wt switch --execute` computes only the template variables its command names**: The switch path built every variable the template context could hold before rendering; it now resolves just the ones the command references. On a clone with no `origin/HEAD` and no cached default branch, that removes a `git ls-remote` the command never asked for — 13 subprocesses and one remote query down to 8 and none. ([#3628](max-sixty/worktrunk#3628))

### Fixed

- **A branch checked out in a second worktree is retained on removal, `-D` included**: `wt remove` and `wt step prune` now act on the worktree named rather than the branch's first checkout, and all three of `wt remove`, `wt step prune`, and `wt merge` keep the branch while another worktree still has it out — deleting the ref would leave that worktree unable to resolve `HEAD`, which is why `git branch -d` refuses the same delete. The retention is reported and names the surviving checkout rather than passing silently. ([#3533](max-sixty/worktrunk#3533))

- **Removal reports what it took, not what it selected**: A removal's summary and JSON described the plan, so a worktree candidate whose branch was retained still counted as `✓ Pruned 1 branch`, and `wt remove --format=json` reported `"branch_deleted": true` beside a stderr line saying the branch was kept. Execution now returns the branch's fate; `wt step prune` counts executed outcomes (`--dry-run` included), both JSON payloads gained `branch_deleted`, and a declined orphan deletion drops out of the removed list rather than being reported as removed. ([#3633](max-sixty/worktrunk#3633), [#3637](max-sixty/worktrunk#3637))

- **Hook previews expand every variable except `vars.*`**: One `vars.` token disabled expansion for the whole command, so `wt hook show --expanded` and `wt hook <type> --dry-run` printed `{{ branch }}` and `{{ repo }}` raw in a listing whose job is to show the expansion. A preview now substitutes a stand-in that renders each `vars.*` reference back as itself, nested access included, while every other variable expands — and no longer spawns the git read that resolving `vars` required. The listing is also derived from the execution path itself, so a context key added there reaches the preview with no second edit. `wt config alias dry-run` shares the renderer, so its help text — which still described the all-or-nothing behavior — was corrected to match. ([#3635](max-sixty/worktrunk#3635), [#3638](max-sixty/worktrunk#3638), [#3639](max-sixty/worktrunk#3639))

- **`wt hook show` no longer prints a bare heading for an empty command list**: A hook type declared as `post-switch = []` has a config entry but no commands, and the section decided it had printed something from the entry rather than from the rows — so it emitted its heading and stopped, and the `(none configured)` line never appeared. Both the user and project sections carried the bug, since the loop and the fallback were duplicated; they now share one renderer that reports whether it wrote any rows. The execution path was already correct: an empty list announces nothing and is omitted from JSON. ([#3641](max-sixty/worktrunk#3641))

- **`wt config shell install` reclaims its own legacy wrapper paths**: Fish sources `conf.d` at startup, so a stale `conf.d/{cmd}.fish` was already loaded by the time fish would autoload the `functions/{cmd}.fish` the install had just written — the old definition won and the new wrapper never loaded. Install decided ownership by reading the file, and left anything unrecognized in place. Ownership now comes from the path: `conf.d/{cmd}.fish` and the stranded nushell `{cmd}.nu` candidates are paths worktrunk computes for the command being installed, so it takes them back whole, unread. Only that exact filename is touched — a neighbour under another name is not worktrunk's — and each removal is reported. `wt config shell uninstall` still reads the header, because it takes no `--cmd` and so cannot know the name; it prompts and previews every file first. (Breaking: install now removes a file at those exact paths regardless of its contents.) ([#3602](max-sixty/worktrunk#3602))

- **Command timeouts actually bound wall-clock, and a default branch guessed while the remote was unreachable isn't cached**: A timeout killed only the direct child, so a surviving grandchild held the output pipe open and the call ran on regardless — a 3 s bound measured at 120 s. A timed command now runs in its own process group and the whole tree is torn down on expiry, which fixes every existing bound including the fsmonitor and reap probes. On top of that, nothing in git bounds `git ls-remote` (an unreachable host costs ~127 s per address on Linux), so default-branch detection abandons the query after 10 s and falls back to local inference — without caching the result, so an outage can't make an inferred default branch permanent. (Breaking: because a timed command gets its own process group, Ctrl-C no longer reaches it; the command waits out the remaining bound.) ([#3603](max-sixty/worktrunk#3603))

- **`wt step relocate` no longer strands a worktree in its staging directory**: When worktree A's target was held by worktree B, and B was itself blocked by a non-worktree path without `--clobber`, the dependency loop read the stall as a cycle, temp-moved A into `.git/wt/staging/relocate/`, then failed moving it into the still-occupied target — leaving A at neither its original nor its expected path. A worktree blocked by an immovable occupant is now skipped. ([#3530](max-sixty/worktrunk#3530))

- **Forge CLI failures are classified by response shape, not by the tool's prose**: `tea api` copies the response body to stdout and exits 0, so an HTTP error never tripped the exit-code gate — a Gitea `APIError` body deserialized into `{state: "", total_count: 0}`, indistinguishable from a commit with no CI statuses, while the PR-list path blamed an API change for what was an API error. Failures from `gh`, `glab`, and `tea` are now keyed on the response envelope, and a non-zero exit keeps meaning the tool itself failed; the CLI's own error text is forwarded rather than reworded, so a bad token surfaces as `gh: Bad credentials (HTTP 401)` instead of a suggestion to re-authenticate. `wt config show --full` reports the Azure DevOps CLI extension alongside the other forge tools. ([#3595](max-sixty/worktrunk#3595), [#3597](max-sixty/worktrunk#3597), [#3605](max-sixty/worktrunk#3605))

- **`wt config plugins claude install-statusline` no longer mistakes another tool's statusline for its own**: The check for an existing worktrunk statusline matched the bare substring `wt `, which an unrelated command like `newt status` satisfies — so `wt config show` reported a foreign statusline as worktrunk's, and the installer early-returned "already configured" and refused to install. It now matches the adjacent `list statusline` token pair, so it works whether the binary is `wt`, `git-wt`, or an absolute path. ([#3595](max-sixty/worktrunk#3595))

- **`[list] task-timeout-ms` is removed**: The per-command bound is gone; `[list] timeout-ms` bounds the whole collect phase. A config that still sets it warns, and `wt config update` strips the key — i

See merge request: Harmonybrew/homebrew-core!15439
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants