Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

fix(config): suppress redundant deprecation hint during `wt config update` (#2590)

Maximilian Roosdebdc503793f
diff --git a/src/commands/config/update.rs b/src/commands/config/update.rs
index 4ba521998..cee789a4f 100644
--- a/src/commands/config/update.rs
+++ b/src/commands/config/update.rs
@@ -10,7 +10,7 @@ use std::path::PathBuf;
use anyhow::Context;
use worktrunk::config::{
DeprecationInfo, compute_migrated_content, config_path,
- copy_approved_commands_to_approvals_file, format_migration_diff,
+ copy_approved_commands_to_approvals_file, format_deprecation_warnings, format_migration_diff,
};
use worktrunk::git::Repository;
use worktrunk::styling::{
@@ -54,9 +54,8 @@ pub fn handle_config_update(yes: bool, print: bool) -> anyhow::Result<()> {
if print {
// Emit migrated content to stdout. Multiple configs → separate with a
- // labeled header so the output is still parseable. Deprecation
- // warnings already went to stderr from `Repository::prewarm`'s
- // user-config preload, so we don't re-emit them here.
+ // labeled header so the output is still parseable. `--print` is for
+ // piping, so stderr stays empty.
let multi = candidates.len() > 1;
for (idx, candidate) in candidates.iter().enumerate() {
if multi {
@@ -118,12 +117,14 @@ pub fn handle_config_update(yes: bool, print: bool) -> anyhow::Result<()> {
/// Format update preview for display.
///
-/// Shows the diff. Deprecation warnings already went to stderr from
-/// `Repository::prewarm`'s user-config preload, so we don't re-emit them
-/// here.
+/// Renders the per-pattern deprecation warnings followed by the diff. The
+/// `wt config update` hint that normally accompanies prewarm-time warnings
+/// is dropped here — the prompt below the preview is the action.
fn format_update_preview(candidate: &UpdateCandidate) -> String {
let mut out = String::new();
+ out.push_str(&format_deprecation_warnings(&candidate.info));
+
let label = candidate
.config_path
.file_name()
diff --git a/src/main.rs b/src/main.rs
index 6de9be5c6..ef4f8ad5a 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1255,9 +1255,15 @@ fn handle_merge_command(args: MergeArgs, yes: bool) -> anyhow::Result<()> {
})
}
-/// True when the parsed command renders a TUI or stderr-sensitive output
-/// (a picker, statusline-on-prompt) and would be visually broken by config
-/// deprecation warnings landing on stderr above it.
+/// True when the parsed command should silence prewarm-time deprecation
+/// warnings. Two reasons qualify:
+///
+/// - **TUI / stderr-sensitive output** (`select`, `switch` picker mode,
+/// `list statusline`) — warnings on stderr would land above the picker
+/// or shell prompt and visually break it.
+/// - **`config update`** — the handler renders the deprecations and a diff
+/// itself, so the prewarm-time warning + `wt config update` hint is
+/// redundant noise above its own UI.
///
/// Read from `Cli::command` before `Repository::prewarm` so the suppress
/// latch beats `prewarm_user_config`'s warning-emission path. The handler
@@ -1270,6 +1276,9 @@ fn command_suppresses_warnings(command: Option<&Commands>) -> bool {
Some(Commands::List(args)) => {
matches!(args.subcommand, Some(ListSubcommand::Statusline { .. }))
}
+ Some(Commands::Config {
+ action: ConfigCommand::Update { .. },
+ }) => true,
_ => false,
}
}
diff --git a/tests/integration_tests/config_show.rs b/tests/integration_tests/config_show.rs
index f55fb3f96..9a7e8cd5d 100644
--- a/tests/integration_tests/config_show.rs
+++ b/tests/integration_tests/config_show.rs
@@ -2822,7 +2822,7 @@ fn test_config_update_print_on_clean_config_is_silent(repo: TestRepo) {
}
/// `wt config update --print` emits the migrated TOML to stdout without
-/// touching the config file. Warnings still go to stderr.
+/// touching the config file. Stderr stays empty so the output is pipeable.
#[rstest]
fn test_config_update_print_emits_migrated_without_writing(repo: TestRepo) {
let config_path = repo.test_config_path();
@@ -2841,6 +2841,11 @@ fn test_config_update_print_emits_migrated_without_writing(repo: TestRepo) {
"config update --print should succeed: {}",
String::from_utf8_lossy(&output.stderr)
);
+ assert!(
+ output.stderr.is_empty(),
+ "--print must keep stderr empty for pipe-friendliness, got: {}",
+ String::from_utf8_lossy(&output.stderr)
+ );
let stdout = String::from_utf8_lossy(&output.stdout);
assert!(
stdout.contains("{{ repo }}") && !stdout.contains("{{ main_worktree }}"),
diff --git a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_approved_commands_migration.snap b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_approved_commands_migration.snap
index 941cd71f2..13f73b3b0 100644
--- a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_approved_commands_migration.snap
+++ b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_approved_commands_migration.snap
@@ -36,13 +36,17 @@ info:
WORKTRUNK_APPROVALS_PATH: "[TEST_APPROVALS]"
WORKTRUNK_CONFIG_PATH: "[TEST_CONFIG]"
WORKTRUNK_SYSTEM_CONFIG_PATH: "[TEST_SYSTEM_CONFIG]"
+ WORKTRUNK_TEST_BASH_INSTALLED: "0"
WORKTRUNK_TEST_CLAUDE_INSTALLED: "0"
WORKTRUNK_TEST_DELAYED_STREAM_MS: "-1"
WORKTRUNK_TEST_EPOCH: "1735776000"
+ WORKTRUNK_TEST_FISH_INSTALLED: "0"
WORKTRUNK_TEST_NUSHELL_ENV: "0"
WORKTRUNK_TEST_OPENCODE_INSTALLED: "0"
WORKTRUNK_TEST_POWERSHELL_ENV: "0"
+ WORKTRUNK_TEST_POWERSHELL_INSTALLED: "0"
WORKTRUNK_TEST_SKIP_URL_HEALTH_CHECK: "1"
+ WORKTRUNK_TEST_ZSH_INSTALLED: "0"
XDG_CONFIG_HOME: "[TEST_CONFIG_HOME]"
---
success: true
@@ -51,7 +55,6 @@ exit_code: 0
----- stderr -----
▲ User config: approved-commands under [projects] is deprecated in favor of approvals.toml
-↳ To see details, run wt config show; to apply updates, run wt config update
○ Proposed diff:
  diff --git a/test-config.toml/current b/test-config.toml/migrated
  index 51f8ab1..a30ca31 100644
diff --git a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_commit_generation_migration.snap b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_commit_generation_migration.snap
index cdd391545..2186ca6f3 100644
--- a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_commit_generation_migration.snap
+++ b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_commit_generation_migration.snap
@@ -36,13 +36,17 @@ info:
WORKTRUNK_APPROVALS_PATH: "[TEST_APPROVALS]"
WORKTRUNK_CONFIG_PATH: "[TEST_CONFIG]"
WORKTRUNK_SYSTEM_CONFIG_PATH: "[TEST_SYSTEM_CONFIG]"
+ WORKTRUNK_TEST_BASH_INSTALLED: "0"
WORKTRUNK_TEST_CLAUDE_INSTALLED: "0"
WORKTRUNK_TEST_DELAYED_STREAM_MS: "-1"
WORKTRUNK_TEST_EPOCH: "1735776000"
+ WORKTRUNK_TEST_FISH_INSTALLED: "0"
WORKTRUNK_TEST_NUSHELL_ENV: "0"
WORKTRUNK_TEST_OPENCODE_INSTALLED: "0"
WORKTRUNK_TEST_POWERSHELL_ENV: "0"
+ WORKTRUNK_TEST_POWERSHELL_INSTALLED: "0"
WORKTRUNK_TEST_SKIP_URL_HEALTH_CHECK: "1"
+ WORKTRUNK_TEST_ZSH_INSTALLED: "0"
XDG_CONFIG_HOME: "[TEST_CONFIG_HOME]"
---
success: true
@@ -51,7 +55,6 @@ exit_code: 0
----- stderr -----
▲ User config: [commit-generation] is deprecated in favor of [commit.generation]
-↳ To see details, run wt config show; to apply updates, run wt config update
○ Proposed diff:
  diff --git a/test-config.toml/current b/test-config.toml/migrated
  index 40d0385..bc7273c 100644
diff --git a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_template_var_migration.snap b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_template_var_migration.snap
index 3b73102b0..a17a3d3ab 100644
--- a/tests/snapshots/integration__integration_tests__config_show__config_update_applies_template_var_migration.snap
+++ b/tests/snapshots/integration__integration_tests__config_show__config_update_applies_template_var_migration.snap
@@ -36,13 +36,17 @@ info:
WORKTRUNK_APPROVALS_PATH: "[TEST_APPROVALS]"
WORKTRUNK_CONFIG_PATH: "[TEST_CONFIG]"
WORKTRUNK_SYSTEM_CONFIG_PATH: "[TEST_SYSTEM_CONFIG]"
+ WORKTRUNK_TEST_BASH_INSTALLED: "0"
WORKTRUNK_TEST_CLAUDE_INSTALLED: "0"
WORKTRUNK_TEST_DELAYED_STREAM_MS: "-1"
WORKTRUNK_TEST_EPOCH: "1735776000"
+ WORKTRUNK_TEST_FISH_INSTALLED: "0"
WORKTRUNK_TEST_NUSHELL_ENV: "0"
WORKTRUNK_TEST_OPENCODE_INSTALLED: "0"
WORKTRUNK_TEST_POWERSHELL_ENV: "0"
+ WORKTRUNK_TEST_POWERSHELL_INSTALLED: "0"
WORKTRUNK_TEST_SKIP_URL_HEALTH_CHECK: "1"
+ WORKTRUNK_TEST_ZSH_INSTALLED: "0"
XDG_CONFIG_HOME: "[TEST_CONFIG_HOME]"
---
success: true
@@ -53,7 +57,6 @@ exit_code: 0
▲ User config: template variable repo_root is deprecated in favor of repo_path
▲ User config: template variable worktree is deprecated in favor of worktree_path
▲ User config: template variable main_worktree is deprecated in favor of repo
-↳ To see details, run wt config show; to apply updates, run wt config update
○ Proposed diff:
  diff --git a/test-config.toml/current b/test-config.toml/migrated
  index 7cc556b..b3535c5 100644
diff --git a/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_accept.snap b/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_accept.snap
index 78d1a6915..4c275aeb6 100644
--- a/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_accept.snap
+++ b/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_accept.snap
@@ -4,7 +4,6 @@ expression: "&output"
---
▲ User config: template variable repo_root is deprecated in favor of repo_path
▲ User config: template variable main_worktree is deprecated in favor of repo
-↳ To see details, run wt config show; to apply updates, run wt config update
○ Proposed diff:
  diff --git a/test-config.toml/current b/test-config.toml/migrated
  index dee4883..5eef8a6 100644
diff --git a/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_decline.snap b/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_decline.snap
index 6794b6e8c..b8bb8e69e 100644
--- a/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_decline.snap
+++ b/tests/snapshots/integration__integration_tests__config_update_pty__config_update_prompt_decline.snap
@@ -4,7 +4,6 @@ expression: "&output"
---
▲ User config: template variable repo_root is deprecated in favor of repo_path
▲ User config: template variable main_worktree is deprecated in favor of repo
-↳ To see details, run wt config show; to apply updates, run wt config update
○ Proposed diff:
  diff --git a/test-config.toml/current b/test-config.toml/migrated
  index dee4883..5eef8a6 100644