Repository navigation
fix(shell): preview legacy-file removal in the wt switch first-run offer - #3656
Conversation
The wt switch first-run shell-integration offer passed an empty legacy-cleanups list to its confirmation prompt, then ran handle_configure_shell, which removes any deprecated wrapper file (fish conf.d/wt.fish, stranded nushell autoload) as a side effect — so accepting Install shell integration? could delete a file the prompt never named. This is the same unpreviewed-deletion defect issue #3644 fixed for wt config shell install, left on the sibling first-run path. Compute the same dry-run legacy-cleanup list handle_configure_shell re-derives internally and pass it to the offer's prompt, so the deletion is named before consent. Purely additive to the prompt: it does not change what gets removed. Regression test drives the first-run offer via PTY with bash unconfigured and a deprecated fish conf.d/wt.fish present, and asserts the preview names the removal (fails without the fix).
worktrunk-bot
left a comment
There was a problem hiding this comment.
Self-authored review. This is a genuine data-safety improvement — the first-run offer now names the deprecated fish/nushell file it will delete before the user consents, closing the last unpreviewed-deletion path left by #3644.
I traced the correctness claim: the preview list collect_legacy_cleanups(&scan.configured, binary_name, true) is identical to the list handle_configure_shell(None, /* skip */ true, …) re-derives internally, because both scans call scan_shell_configs(None, true, binary_name) with the same arguments, and dry_run = true is pure detection with no side effects. So the prompt names exactly what the install removes — no behavior change, only disclosure.
Flagging for a human sign-off because the diff edits worktrunk's shell-integration deletion surface (configure_shell.rs collect_legacy_cleanups / fs::remove_file, and the wt switch first-run offer that triggers it). Per the repo's data-safety review policy, a change on that surface isn't the bot's to authorize even when it looks strictly safer — requesting review from @max-sixty. No defects found; the change reads as a safe no-op if the previous empty-list behavior was intentional, and a real fix otherwise.
worktrunk 0.72.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 - **A host carrying a forge's name anywhere resolves to that forge again**: 0.71.0 required `github`, `gitlab`, or `gitea` as a whole dot-separated label, which read as an ownership check but wasn't one — an attacker controls their own DNS — while shutting out self-hosters with hyphenated names. `github-enterprise.acme.com`, `mygithub.com`, and the `github-personal` SSH alias classify again, so CI status, `wt switch --prs`, and `repo.provider` work with no config. ([#3673](max-sixty/worktrunk#3673)) - **One `[projects."…"]` entry can cover every repository on a host, and can set the forge**: A key containing `*` matches any run of characters, `/` included, so `[projects."git.company.example/*"]` covers a whole host; every matching entry applies, least- to most-specific. The table also gained `forge.platform` and `forge.hostname`, so a self-hosted host needs one entry here rather than a block in every repo. [Docs](https://worktrunk.dev/config/#user-project-specific-settings) ([#3701](max-sixty/worktrunk#3701), thanks @chrishas35 for the request and @witt-bit for the workspace-scoped case it partly serves) - **`wt merge` and `wt step push` leave the target worktree's uncommitted changes in place**: The autostash that held a dirty target's changes restored them as unstaged; both now advance the target with a compare-and-swap `update-ref` and `read-tree -m -u`, which leaves uncommitted work untouched. (Breaking: the fast-forward path no longer runs `git push`, so `pre-push` and the receive-side hooks no longer fire, and a failed sync errors with the ref rolled back.) ([#3703](max-sixty/worktrunk#3703), [#3684](max-sixty/worktrunk#3684), [#3693](max-sixty/worktrunk#3693), thanks @gubasso for reporting) - **Approval state and branch-removal outcomes are machine-readable**: `wt config approvals list --format=json` reports whether a non-interactive run would stop for approval. `wt remove` and `wt step prune` replace `branch_deleted` with `branch_outcome`: `deleted`, `deferred`, `not_attempted`, `retained_unmerged`, `retained_checked_out`, `retained_raced`, `retained_failed`. (Breaking.) ([#3710](max-sixty/worktrunk#3710), thanks @NathanaelRea for the requests) - **Every commit hash worktrunk prints follows `core.abbrev`**: The `wt list` table, `wt switch --prs`'s `log` tab, and `wt config state`'s CI cache table sliced to 8 characters while `--format=json` carried git's `%h`. All now ask git how wide it abbreviates in this repo. ([#3676](max-sixty/worktrunk#3676), [#3677](max-sixty/worktrunk#3677)) - **`wt list --format=json` schema 2 has a published JSON Schema**: [worktrunk.dev/schema/list-v2.json](https://worktrunk.dev/schema/list-v2.json) holds the contract, and `wt list --print-schema` prints the same document. Four fields that were bare strings are now enumerated vocabularies; the emitted JSON is unchanged. ([#3747](max-sixty/worktrunk#3747)) - **A detached worktree is named by its commit, not `-`**: The Branch cell hardcoded `-`, which reads as missing data rather than a state; it now carries the row's abbreviated HEAD, and the picker and statusline name the worktree the same way. ([#3675](max-sixty/worktrunk#3675)) ### Fixed - **Piped output is plain and no longer panics**: `wt list | head -3` exited 101 with `failed printing to stdout: Broken pipe`, and `wt list` wrote ANSI to a pipe unconditionally. Every stdout surface now exits cleanly, and the human-read ones are plain when piped unless `CLICOLOR_FORCE=1`. ([#3746](max-sixty/worktrunk#3746), [#3766](max-sixty/worktrunk#3766)) - **A CI check that hasn't finished no longer reads as passed**: Each forge's status parser missed documented values, so a GitHub PR parked on an approval gate showed green, and GitLab's `canceling` and Azure DevOps's `postponed` read as no CI at all. ([#3741](max-sixty/worktrunk#3741), [#3740](max-sixty/worktrunk#3740)) - **The shell wrappers survive an `rm` alias and a failing `--execute`**: Aliases bake into the wrapper at parse time, so `alias rm='rm -v'` reached its cleanup — noise on zsh and bash, and on nushell an abort that leaked three temp files, as a failing `--execute` body also did. ([#3714](max-sixty/worktrunk#3714), thanks @Ar4l), ([#3732](max-sixty/worktrunk#3732), [#3734](max-sixty/worktrunk#3734)) - **An alias or hook wrapping `wt switch` or `wt remove` keeps your subdirectory**: The user's position came from the `wt` process's cwd, which inside an alias body is the worktree root, so an aliased `wt remove` from `feature/apps/gateway` landed at the primary worktree's root. Fixes [#3723](max-sixty/worktrunk#3723). ([#3724](max-sixty/worktrunk#3724), thanks @vivienm for reporting) - **`wt merge` and `wt step push` refuse a target worktree parked mid-operation**: The two-tree sync refuses an unmerged index but not a stopped cherry-pick or rebase whose conflict was already staged, so the push range could land in a paused target and be committed by `--continue`. ([#3759](max-sixty/worktrunk#3759)) - **The Claude plugin's worktree-remove hook resolves against the worktree path**: The hook anchored at `CLAUDE_PROJECT_DIR`, which the `claude agents` view routinely leaves outside any repository, so `wt remove` died with `not a git repository` and the session became undeletable. Its guard now also requires a `.git` entry. ([#3754](max-sixty/worktrunk#3754), [#3767](max-sixty/worktrunk#3767), thanks @judewang for the fix and the report) - **A Gitea API error is reported as one, not as a parse failure**: `tea api` exits 0 whatever the HTTP status, so both call sites guessed from the body's shape and blamed an API change for an API error. `--include` surfaces the status instead. ([#3713](max-sixty/worktrunk#3713), [#3600](max-sixty/worktrunk#3600)) - **`--print-schema` and the doc-generation help flags name the right command**: All three found the subcommand by scanning `argv` for a `/wt` suffix, which never matches `wt.exe` under a backslash path, so on Windows they read the binary's own path as the command. ([#3762](max-sixty/worktrunk#3762)) - **A multibyte shell name no longer panics**: `extract_filename_from_path` sliced at `len() - 4` to test for `.exe` with no char-boundary check: `SHELL=/bin/日本語 wt config show` panicked, and on macOS every process name goes through it during shell detection. ([#3727](max-sixty/worktrunk#3727)) - **`wt` installed under a dotted name generates shell integration for that name**: `binary_name` used `file_stem`, which cuts at the last dot, so `wt config shell init bash` under `wt.old` emitted a wrapper for `wt`. It now strips only the executable suffix. ([#3719](max-sixty/worktrunk#3719)) - **Concurrent `wt step prune` removals no longer race the worktree registry**: `git worktree remove` reads every sibling under `.git/worktrees/`, so two overlapping removals could have one read a sibling mid-teardown. Registry-mutating removals now serialize behind a second lock. ([#3692](max-sixty/worktrunk#3692)) - **The `wt switch` first-run offer previews the legacy files it removes**: Accepting "Install shell integration?" could delete a deprecated worktrunk-managed wrapper the prompt never named. What gets removed is unchanged. ([#3656](max-sixty/worktrunk#3656)) - **`wt config create --project` writes a resolvable link**: The comment it writes into `.config/wt.toml` carried a raw Zola target, because the link-conversion regex stopped at the first `]` — here the one closing a nested code span. ([#3731](max-sixty/worktrunk#3731)) - **`wt list --branches` counts a local branch containing `/` as local**: The summary tally classified branch-only rows by `branch.contains('/')`, so a local `feature/login` counted under "N remote branches". ([#3687](max-sixty/worktrunk#3687)) - **`wt step relocate`'s human summary counts template-error branches as skipped**: `--format=json` already folded them into `skipped`; the human tally undercounted by the number of branches whose `worktree-path` template failed to expand. ([#3688](max-sixty/worktrunk#3688)) ### Documentation - **SignPath attribution appears with the artifacts it describes**: The code-signing notice and a route to the policy now sit in the install section's Windows block on the README and the docs landing page, as SignPath Foundation's OSS program requires. ([#3709](max-sixty/worktrunk#3709)) - **`wt step copy-ignored`'s `--require-include` example renders as a terminal block**: It was the only `console` block in the command's long help missing the `$ ` prefix. ([#3706](max-sixty/worktrunk#3706)) ### Internal - **Library API rework** (Breaking library API): `cargo-semver-checks` fails five lints — `LegacyForgeAlias` and `Repository::legacy_forge_alias` removed with the forge-classification revert, `Repository::forge_platform_override` removed for one shared resolver, `stage_worktree_removal` gained two parameters, `UserProjectOverrides` gained a `forge` field, and the `real-repo-benches` feature was removed. ([#3673](max-sixty/worktrunk#3673), [#3694](htt See merge request: Harmonybrew/homebrew-core!16275
Nightly sweep finding. The
wt switchfirst-run shell-integration offer could delete a deprecated wrapper file it never named in the confirmation prompt — the same unpreviewed-deletion defect #3644 fixed forwt config shell install, left on the sibling first-run path.The gap
When
wt switchshows "Install shell integration?" on first run,prompt_shell_integrationpassed an empty legacy-cleanups list to the prompt, then calledhandle_configure_shell(None, /* skip_confirmation */ true, …). That call removes any deprecated wrapper file as a side effect — the fishconf.d/wt.fishsuperseded byfunctions/wt.fish(#566), or a nushell wrapper stranded at a legacy autoload path (#2878). So a user on an unconfigured bash who also had a stale, worktrunk-managed~/.config/fish/conf.d/wt.fishwould accept "Install shell integration?" and have that fish file deleted — reported only after the fact.This is exactly what
wt config shell installnow previews (#3644, merged in #3648); the first-run offer was the one path still deleting without naming the file first. It runs against CLAUDE.md's data-safety rule: "No implicit destructive side effects — never silently delete/overwrite as a side effect of an unrelated operation."The fix
Compute the same dry-run legacy-cleanup list
handle_configure_shellre-derives internally (both come from the samescan_shell_configs(None, true, …)scan, so the lists are identical) and pass it to the offer's prompt. The deletion is now named before consent. The change is purely additive to the prompt — it does not change what gets removed, only what the prompt discloses.Test
A PTY regression test drives the first-run offer with bash unconfigured (so the offer fires) and a deprecated fish
conf.d/wt.fishpresent, requests the preview (?), and asserts it names the removal. Verified it fails without the fix (the preview shows only bash's "Will add" line) and passes with it.Note for review
The prior code carried a comment documenting the empty-list behavior as deliberate ("resolves no legacy cleanups of its own … reports removal after the fact, as before"). Reading it as "#3644's fix wasn't extended here" rather than "the first-run offer should delete without previewing", this completes that fix — but flagging it so the call is explicit. If the boundary was intentional, this is a safe no-op to close.