Skip to content

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

refactor: filter deprecated keys inside warn_unknown_fields (#1895)

Maximilian Roos1be4ab956b06
diff --git a/src/commands/config/mod.rs b/src/commands/config/mod.rs
index 50d5fb1ea..a24275ebd 100644
--- a/src/commands/config/mod.rs
+++ b/src/commands/config/mod.rs
@@ -155,15 +155,15 @@ mod tests {
);
assert_snapshot!(warn_unknown_keys::<ProjectConfig>(&unknown), @"▲ Key skip-shell-integration-prompt belongs in user config (will be ignored)");
- // ci in user config should suggest project config
+ // forge in user config should suggest project config
let mut unknown = HashMap::new();
let mut inner = toml::map::Map::new();
inner.insert(
"platform".to_string(),
toml::Value::String("github".to_string()),
);
- unknown.insert("ci".to_string(), toml::Value::Table(inner));
- assert_snapshot!(warn_unknown_keys::<UserConfig>(&unknown), @"▲ Key ci belongs in project config (will be ignored)");
+ unknown.insert("forge".to_string(), toml::Value::Table(inner));
+ assert_snapshot!(warn_unknown_keys::<UserConfig>(&unknown), @"▲ Key forge belongs in project config (will be ignored)");
}
// ==================== render_ci_tool_status tests ====================
diff --git a/src/commands/config/show.rs b/src/commands/config/show.rs
index c594d3083..1479a4b80 100644
--- a/src/commands/config/show.rs
+++ b/src/commands/config/show.rs
@@ -374,11 +374,9 @@ fn render_system_config(out: &mut String) -> anyhow::Result<bool> {
writeln!(out, "{}", error_message("Invalid config"))?;
writeln!(out, "{}", format_with_gutter(&e.to_string(), None))?;
} else {
- let unknown_keys: std::collections::HashMap<_, _> = find_unknown_user_keys(&contents)
- .into_iter()
- .filter(|(k, _)| !worktrunk::config::DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
- .collect();
- out.push_str(&warn_unknown_keys::<UserConfig>(&unknown_keys));
+ out.push_str(&warn_unknown_keys::<UserConfig>(&find_unknown_user_keys(
+ &contents,
+ )));
}
// Display TOML with syntax highlighting
@@ -449,11 +447,9 @@ fn render_user_config(out: &mut String, has_system_config: bool) -> anyhow::Resu
// Only check for unknown keys if config is valid.
// Filter deprecated section keys to avoid duplicate warnings
// (deprecation system already warns about these).
- let unknown_keys: std::collections::HashMap<_, _> = find_unknown_user_keys(&contents)
- .into_iter()
- .filter(|(k, _)| !worktrunk::config::DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
- .collect();
- out.push_str(&warn_unknown_keys::<UserConfig>(&unknown_keys));
+ out.push_str(&warn_unknown_keys::<UserConfig>(&find_unknown_user_keys(
+ &contents,
+ )));
}
// Add "Current config" label when deprecations shown (to separate from diff)
@@ -494,8 +490,12 @@ pub(super) fn warn_unknown_keys<C: worktrunk::config::WorktrunkConfig>(
) -> String {
let mut out = String::new();
- // Sort keys for deterministic output order
- let mut keys: Vec<_> = unknown_keys.keys().collect();
+ // Sort keys for deterministic output order, skipping deprecated keys
+ // (the deprecation system handles those with better messaging)
+ let mut keys: Vec<_> = unknown_keys
+ .keys()
+ .filter(|k| !worktrunk::config::DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
+ .collect();
keys.sort();
for key in keys {
diff --git a/src/config/deprecation.rs b/src/config/deprecation.rs
index 0c248ef40..89ab3a70e 100644
--- a/src/config/deprecation.rs
+++ b/src/config/deprecation.rs
@@ -67,8 +67,13 @@ const DEPRECATED_VARS: &[(&str, &str)] = &[
("main_worktree_path", "primary_worktree_path"),
];
-/// Top-level section keys that are deprecated and handled separately.
-/// Callers should filter these out before calling `warn_unknown_fields` to avoid duplicate warnings.
+/// Top-level section keys that are deprecated and handled by the deprecation system.
+/// `warn_unknown_fields` skips these automatically.
+///
+/// TODO: When a deprecated key appears in the wrong config file (e.g., `[commit-generation]`
+/// in project config), the deprecation system suggests renaming it — but the renamed key
+/// isn't valid in that config either. Ideally we'd detect "deprecated + wrong file" and
+/// suggest moving to the correct config instead of just renaming.
pub const DEPRECATED_SECTION_KEYS: &[&str] = &["commit-generation", "select", "ci"];
/// Normalize a template string by replacing deprecated variables with their canonical names.
@@ -1420,8 +1425,12 @@ pub fn warn_unknown_fields<C: WorktrunkConfig>(
guard.insert(canonical_path);
}
- // Sort keys for deterministic output order
- let mut keys: Vec<_> = unknown_keys.keys().collect();
+ // Sort keys for deterministic output order, skipping deprecated keys
+ // (the deprecation system handles those with better messaging)
+ let mut keys: Vec<_> = unknown_keys
+ .keys()
+ .filter(|k| !DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
+ .collect();
keys.sort();
for key in keys {
diff --git a/src/config/project.rs b/src/config/project.rs
index 4762124bd..caf0bcf02 100644
--- a/src/config/project.rs
+++ b/src/config/project.rs
@@ -226,13 +226,9 @@ impl ProjectConfig {
// Warn about unknown fields (only in main worktree where it's actionable)
if is_main_worktree {
- let unknown_keys: std::collections::HashMap<_, _> = find_unknown_keys(&contents)
- .into_iter()
- .filter(|(k, _)| !super::deprecation::DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
- .collect();
super::deprecation::warn_unknown_fields::<ProjectConfig>(
&config_path,
- &unknown_keys,
+ &find_unknown_keys(&contents),
"Project config",
);
}
diff --git a/src/config/user/mod.rs b/src/config/user/mod.rs
index 540385c33..7e7faf02f 100644
--- a/src/config/user/mod.rs
+++ b/src/config/user/mod.rs
@@ -117,13 +117,9 @@ impl UserConfig {
&& let Ok(content) = std::fs::read_to_string(&system_path)
{
// Warn about unknown fields in system config
- let unknown_keys: std::collections::HashMap<_, _> = find_unknown_keys(&content)
- .into_iter()
- .filter(|(k, _)| !super::deprecation::DEPRECATED_SECTION_KEYS.contains(&k.as_str()))
- .collect();
super::deprecation::warn_unknown_fields::<UserConfig>(
&system_path,
- &unknown_keys,
+ &find_unknown_keys(&content),
"System config",
);
@@ -156,15 +152,9 @@ impl UserConfig {
// Warn about unknown fields in the config file
// (must check file content directly, not config.unknown, because
// config.unknown includes env vars which shouldn't trigger warnings)
- let unknown_keys: std::collections::HashMap<_, _> = find_unknown_keys(&content)
- .into_iter()
- .filter(|(k, _)| {
- !super::deprecation::DEPRECATED_SECTION_KEYS.contains(&k.as_str())
- })
- .collect();
super::deprecation::warn_unknown_fields::<UserConfig>(
config_path,
- &unknown_keys,
+ &find_unknown_keys(&content),
"User config",
);
diff --git a/tests/snapshots/integration__integration_tests__config_show__config_show_suggests_user_config_for_commit_generation.snap b/tests/snapshots/integration__integration_tests__config_show__config_show_suggests_user_config_for_commit_generation.snap
index b2117610c..3f1a308e7 100644
--- a/tests/snapshots/integration__integration_tests__config_show__config_show_suggests_user_config_for_commit_generation.snap
+++ b/tests/snapshots/integration__integration_tests__config_show__config_show_suggests_user_config_for_commit_generation.snap
@@ -60,7 +60,6 @@ exit_code: 0
  / No newline at end of file
  +[commit.generation]
  +command = "claude"
-▲ Unknown key commit-generation will be ignored
○ Current config:
  [commit-generation]
  command = "claude"