Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
Feat: Warn on unknown config keys when showing config
Maximilian Roos85f6d30792cc
diff --git a/src/commands/config.rs b/src/commands/config.rsindex 7964c70e4..a17b97c74 100644--- a/src/commands/config.rs+++ b/src/commands/config.rs@@ -2,12 +2,13 @@ use anyhow::Context;use etcetera::base_strategy::{BaseStrategy, choose_base_strategy};use std::fmt::Write as _;use std::path::PathBuf;+use worktrunk::config::{find_unknown_project_keys, find_unknown_user_keys};use worktrunk::git::Repository;use worktrunk::path::format_path_for_display;use worktrunk::shell::Shell;use worktrunk::styling::{- AnstyleStyle, CYAN, GREEN, GREEN_BOLD, HINT, HINT_EMOJI, INFO_EMOJI, WARNING, WARNING_EMOJI,- format_toml, format_with_gutter,+ AnstyleStyle, CYAN, GREEN, GREEN_BOLD, HINT, HINT_EMOJI, INFO_EMOJI, WARNING, WARNING_BOLD,+ WARNING_EMOJI, format_toml, format_with_gutter,};use super::configure_shell::{ConfigAction, scan_shell_configs};@@ -144,12 +145,26 @@ fn render_global_config(out: &mut String) -> anyhow::Result<()> {return Ok(());}+ // Check for unknown keys and warn+ warn_unknown_keys(out, &find_unknown_user_keys(&contents))?;+// Display TOML with syntax highlighting (gutter at column 0)write!(out, "{}", format_toml(&contents, ""))?;Ok(())}+/// Write warnings for any unknown config keys+fn warn_unknown_keys(out: &mut String, unknown_keys: &[String]) -> anyhow::Result<()> {+ for key in unknown_keys {+ writeln!(+ out,+ "{WARNING_EMOJI} {WARNING}Unknown key {WARNING_BOLD}{key}{WARNING_BOLD:#}{WARNING} will be ignored{WARNING:#}"+ )?;+ }+ Ok(())+}+fn render_project_config(out: &mut String) -> anyhow::Result<()> {let bold = AnstyleStyle::new().bold();let dim = AnstyleStyle::new().dimmed();@@ -188,6 +203,9 @@ fn render_project_config(out: &mut String) -> anyhow::Result<()> {return Ok(());}+ // Check for unknown keys and warn+ warn_unknown_keys(out, &find_unknown_project_keys(&contents))?;+// Display TOML with syntax highlighting (gutter at column 0)write!(out, "{}", format_toml(&contents, ""))?;diff --git a/src/config/mod.rs b/src/config/mod.rsindex 6ccadb91b..f3d3884b4 100644--- a/src/config/mod.rs+++ b/src/config/mod.rs@@ -46,10 +46,10 @@ mod user;// Re-export public typespub use commands::{Command, CommandConfig, CommandPhase};pub use expansion::{expand_command_template, expand_template};-pub use project::ProjectConfig;+pub use project::{ProjectConfig, find_unknown_keys as find_unknown_project_keys};pub use user::{- CommitGenerationConfig, StageMode, UserProjectConfig, WorktrunkConfig, get_config_path,- set_config_path,+ CommitGenerationConfig, StageMode, UserProjectConfig, WorktrunkConfig,+ find_unknown_keys as find_unknown_user_keys, get_config_path, set_config_path,};#[cfg(test)]@@ -749,4 +749,51 @@ squash-template-file = "~/file.txt"assert!(toml.contains("llm"));assert!(toml.contains("template"));}++ #[test]+ fn test_find_unknown_project_keys_with_typo() {+ let toml_str = "[post-merge-command]\ndeploy = \"task deploy\"";+ let unknown = find_unknown_project_keys(toml_str);+ assert_eq!(unknown, vec!["post-merge-command"]);+ }++ #[test]+ fn test_find_unknown_project_keys_valid() {+ let toml_str =+ "[post-merge]\ndeploy = \"task deploy\"\n\n[pre-merge]\ntest = \"cargo test\"";+ let unknown = find_unknown_project_keys(toml_str);+ assert!(unknown.is_empty());+ }++ #[test]+ fn test_find_unknown_project_keys_multiple() {+ let toml_str = "[post-merge-command]\ndeploy = \"task deploy\"\n\n[after-create]\nsetup = \"npm install\"";+ let unknown = find_unknown_project_keys(toml_str);+ assert_eq!(unknown.len(), 2);+ assert!(unknown.contains(&"post-merge-command".to_string()));+ assert!(unknown.contains(&"after-create".to_string()));+ }++ #[test]+ fn test_find_unknown_user_keys_with_typo() {+ let toml_str = "worktree-path = \"../test\"\n\n[commit-gen]\ncommand = \"llm\"";+ let unknown = find_unknown_user_keys(toml_str);+ assert_eq!(unknown, vec!["commit-gen"]);+ }++ #[test]+ fn test_find_unknown_user_keys_valid() {+ let toml_str = "worktree-path = \"../test\"\n\n[commit-generation]\ncommand = \"llm\"\n\n[list]\nfull = true";+ let unknown = find_unknown_user_keys(toml_str);+ assert!(unknown.is_empty());+ }++ #[test]+ fn test_find_unknown_keys_invalid_toml() {+ let toml = "this is not valid toml {{{";+ let unknown_project = find_unknown_project_keys(toml);+ let unknown_user = find_unknown_user_keys(toml);+ assert!(unknown_project.is_empty());+ assert!(unknown_user.is_empty());+ }}diff --git a/src/config/project.rs b/src/config/project.rsindex 876167eb2..ea4bd480c 100644--- a/src/config/project.rs+++ b/src/config/project.rs@@ -7,6 +7,17 @@ use serde::{Deserialize, Serialize};use super::commands::CommandConfig;+/// Valid top-level keys for project config+// TODO: Replace with #[serde(flatten)] HashMap<String, toml::Value> on the struct+// to capture unknown fields automatically during deserialization+const VALID_PROJECT_KEYS: &[&str] = &[+ "post-create",+ "post-start",+ "pre-commit",+ "pre-merge",+ "post-merge",+];+/// Project-specific configuration with hooks.////// This config is stored at `<repo>/.config/wt.toml` within the repository and@@ -84,3 +95,18 @@ impl ProjectConfig {Ok(Some(config))}}++/// Find unknown keys in project config TOML content+///+/// Returns a list of unrecognized top-level keys that will be silently ignored.+pub fn find_unknown_keys(contents: &str) -> Vec<String> {+ let Ok(table) = contents.parse::<toml::Table>() else {+ return vec![];+ };++ table+ .keys()+ .filter(|key| !VALID_PROJECT_KEYS.contains(&key.as_str()))+ .cloned()+ .collect()+}diff --git a/src/config/user.rs b/src/config/user.rsindex b7d093d0d..5a4ee7dc4 100644--- a/src/config/user.rs+++ b/src/config/user.rs@@ -10,6 +10,18 @@ use std::sync::OnceLock;#[cfg(not(test))]use etcetera::base_strategy::{BaseStrategy, choose_base_strategy};+/// Valid top-level keys for user config+// TODO: Replace with #[serde(flatten)] HashMap<String, toml::Value> on the struct+// to capture unknown fields automatically during deserialization+const VALID_USER_KEYS: &[&str] = &[+ "worktree-path",+ "commit-generation",+ "projects",+ "list",+ "commit",+ "merge",+];+/// Global override for config path, set via --config CLI flagstatic CONFIG_PATH: OnceLock<PathBuf> = OnceLock::new();@@ -524,3 +536,18 @@ pub fn get_config_path() -> Option<PathBuf> {Some(strategy.config_dir().join("worktrunk").join("config.toml"))}}++/// Find unknown keys in user config TOML content+///+/// Returns a list of unrecognized top-level keys that will be silently ignored.+pub fn find_unknown_keys(contents: &str) -> Vec<String> {+ let Ok(table) = contents.parse::<toml::Table>() else {+ return vec![];+ };++ table+ .keys()+ .filter(|key| !VALID_USER_KEYS.contains(&key.as_str()))+ .cloned()+ .collect()+}diff --git a/tests/integration_tests/config_show.rs b/tests/integration_tests/config_show.rsindex 01dc13fe0..81d7364d6 100644--- a/tests/integration_tests/config_show.rs+++ b/tests/integration_tests/config_show.rs@@ -19,9 +19,8 @@ fn test_config_show_with_project_config() {global_config_dir.join("config.toml"),r#"worktree-path = "../{{ main_worktree }}.{{ branch }}"-[[approved-commands]]-project = "test-project"-command = "npm install"+[projects."test-project"]+approved-commands = ["npm install"]"#,).unwrap();@@ -55,9 +54,8 @@ server = "npm run dev"⚪ Global Config: [1m~/.config/worktrunk/config.toml[0m[107m [0m worktree-path = [32m"../{{ main_worktree }}.{{ branch }}"[0m[107m [0m- [107m [0m [1m[36m[[approved-commands]][0m- [107m [0m project = [32m"test-project"[0m- [107m [0m command = [32m"npm install"[0m+ [107m [0m [1m[36m[projects."test-project"][0m+ [107m [0m approved-commands = [[32m"npm install"[0m]⚪ Project Config: [1m[REPO]/.config/wt.toml[0m[107m [0m post-create = [32m"npm install"[0m@@ -260,3 +258,100 @@ if command -v wt >/dev/null 2>&1; then eval "$(command wt config shell init zsh)assert_cmd_snapshot!(cmd);});}++/// Test `wt config show` warns about unknown/misspelled keys in project config+#[test]+fn test_config_show_warns_unknown_project_keys() {+ let repo = TestRepo::new();+ let temp_home = TempDir::new().unwrap();++ // Create global config+ let global_config_dir = temp_home.path().join(".config").join("worktrunk");+ fs::create_dir_all(&global_config_dir).unwrap();+ fs::write(+ global_config_dir.join("config.toml"),+ "worktree-path = \"../{{ main_worktree }}.{{ branch }}\"",+ )+ .unwrap();++ // Create project config with typo: post-merge-command instead of post-merge+ let config_dir = repo.root_path().join(".config");+ fs::create_dir_all(&config_dir).unwrap();+ fs::write(+ config_dir.join("wt.toml"),+ "[post-merge-command]\ndeploy = \"task deploy\"",+ )+ .unwrap();++ let settings = setup_snapshot_settings_with_home(&repo, &temp_home);+ settings.bind(|| {+ let mut cmd = wt_command();+ repo.clean_cli_env(&mut cmd);+ cmd.arg("config").arg("show").current_dir(repo.root_path());+ set_temp_home_env(&mut cmd, temp_home.path());++ assert_cmd_snapshot!(cmd, @r#"+ success: true+ exit_code: 0+ ----- stdout -----++ ----- stderr -----+ ⚪ Global Config: [1m~/.config/worktrunk/config.toml[0m+ [107m [0m worktree-path = [32m"../{{ main_worktree }}.{{ branch }}"[0m++ ⚪ Project Config: [1m[REPO]/.config/wt.toml[0m+ 🟡 [33mUnknown key [1m[33mpost-merge-command[0m[33m will be ignored[0m+ [107m [0m [1m[36m[post-merge-command][0m+ [107m [0m deploy = [32m"task deploy"[0m++ [2m⚪ Skipped bash; ~/.bashrc not found[0m+ [2m⚪ Skipped zsh; ~/.zshrc not found[0m+ [2m⚪ Skipped fish; ~/.config/fish/conf.d not found[0m+ "#);+ });+}++/// Test `wt config show` warns about unknown keys in user config+#[test]+fn test_config_show_warns_unknown_user_keys() {+ let repo = TestRepo::new();+ let temp_home = TempDir::new().unwrap();++ // Create global config with typo: commit-gen instead of commit-generation+ let global_config_dir = temp_home.path().join(".config").join("worktrunk");+ fs::create_dir_all(&global_config_dir).unwrap();+ fs::write(+ global_config_dir.join("config.toml"),+ "worktree-path = \"../{{ main_worktree }}.{{ branch }}\"\n\n[commit-gen]\ncommand = \"llm\"",+ )+ .unwrap();++ let settings = setup_snapshot_settings_with_home(&repo, &temp_home);+ settings.bind(|| {+ let mut cmd = wt_command();+ repo.clean_cli_env(&mut cmd);+ cmd.arg("config").arg("show").current_dir(repo.root_path());+ set_temp_home_env(&mut cmd, temp_home.path());++ assert_cmd_snapshot!(cmd, @r#"+ success: true+ exit_code: 0+ ----- stdout -----++ ----- stderr -----+ ⚪ Global Config: [1m~/.config/worktrunk/config.toml[0m+ 🟡 [33mUnknown key [1m[33mcommit-gen[0m[33m will be ignored[0m+ [107m [0m worktree-path = [32m"../{{ main_worktree }}.{{ branch }}"[0m+ [107m [0m+ [107m [0m [1m[36m[commit-gen][0m+ [107m [0m command = [32m"llm"[0m++ ⚪ Project Config: [1m[REPO]/.config/wt.toml[0m+ 💡 [2mNot found[0m++ [2m⚪ Skipped bash; ~/.bashrc not found[0m+ [2m⚪ Skipped zsh; ~/.zshrc not found[0m+ [2m⚪ Skipped fish; ~/.config/fish/conf.d not found[0m+ "#);+ });+}