Merge pull request #14 from bodo-run/copilot/fix-13

Fix CLI/config field naming consistency by ensuring kebab-case naming across all field types

Author: mohsen1

advanced-config.yaml

@@ -0,0 +1 @@
+special-secret: "from_config"

examples/advanced/advanced-config.yaml

@@ -2,20 +2,20 @@
 # You can place this file in the current directory (or a parent directory)
 # so it can be auto-discovered, or specify it via --config-file, etc.
 
-server_port: 9000
-database_url: "postgres://user:pass@localhost/mydb"
+port: 9000
+database-url: "postgres://user:pass@localhost/mydb"
 debug: true
 
 # Lists for demonstration
-extend_list:
+extend-list:
   - "foo"
   - "bar"
-overwrite_list:
+overwrite-list:
   - "config_item_1"
   - "config_item_2"
 
 # These are config-only; no CLI arguments can override them
-special_secret: "this-came-from-the-config"
-extra_settings:
-  nesting_level: 3
-  allow_guest: false
+special-secret: "this-came-from-the-config"
+extra-settings:
+  nesting-level: 3
+  allow-guest: false

examples/advanced/src/main.rs

@@ -3,7 +3,9 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Default, Deserialize, Serialize)]
 pub struct ExtraSettings {
+    #[serde(rename = "nesting-level")]
     pub nesting_level: i64,
+    #[serde(rename = "allow-guest")]
     pub allow_guest: Option<bool>,
 }
 
@@ -32,7 +34,7 @@ struct AdvancedConfig {
     pub server_port: u16,
 
     // just specifying --debug will set it to true
-    #[config_arg()]
+    #[config_arg(default_value = "false")]
     pub debug: bool,
 
     // some config files expand environment variables

examples/basic/app-config.yaml

@@ -1,7 +1,3 @@
 # Sample configuration file for the "basic" example.
 port: 9090
-database_url: "postgres://localhost:5432/mydb"
-ignored_files:
-  - "*.log"
-  - "target/"
-  - "node_modules/"
+database-url: "postgres://localhost:5432/mydb"

examples/basic/simple-config.yaml

@@ -0,0 +1 @@
+port: 3000

examples/basic/snake-config.yaml

@@ -0,0 +1 @@
+database_url: "postgres://localhost:5432/mydb"

examples/basic/test-config.yaml

@@ -0,0 +1 @@
+database-url: "postgres://localhost:5432/mydb"

src/lib.rs

@@ -318,12 +318,15 @@ fn generate_config_field(field: &FieldInfo) -> TokenStream2 {
     let ident = &field.ident;
     let ty = &field.ty;
 
-    // Only use rename if explicitly specified
+    // Use kebab-case naming for config fields to match CLI conventions
     let rename_attr = if let Some(name) = &field.arg_attrs.name {
         let name_lit = LitStr::new(name, Span::call_site());
         quote!(#[serde(rename = #name_lit)])
     } else {
-        quote!()
+        // Convert to kebab-case to match CLI field naming
+        let kebab_name = ident.to_string().to_kebab_case();
+        let name_lit = LitStr::new(&kebab_name, Span::call_site());
+        quote!(#[serde(rename = #name_lit)])
     };
 
     // Wrap non-Option types as Option<T> to detect presence in config
@@ -488,7 +491,7 @@ fn unify_field(field: &FieldInfo) -> TokenStream2 {
                                 }
                             }
                         }
-                    },
+                    }
                     MultiValueBehavior::Overwrite => {
                         // For overwrite: CLI > config > default
                         if let Some(dv) = &field.arg_attrs.default_value {

tests/advanced.rs

@@ -6,8 +6,8 @@ use tempfile::TempDir;
 #[test]
 fn extend_list_merging() -> Result<(), Box<dyn std::error::Error>> {
     let dir = TempDir::new()?;
-    std::fs::write(dir.path().join("advanced-config.yaml"), 
-        "extend_list: [\"config_item\"]\noverwrite_list: [\"config_item\"]\nspecial_secret: \"secret\"\nextra_settings: { nesting_level: 3, allow_guest: false }")?;
+    std::fs::write(dir.path().join("advanced-config.yaml"),
+        "extend-list: [\"config_item\"]\noverwrite-list: [\"config_item\"]\nspecial-secret: \"secret\"\nextra-settings:\n  nesting-level: 3\n  allow-guest: false")?;
 
     Command::cargo_bin("advanced")?
         .current_dir(dir.path())
@@ -27,8 +27,8 @@ fn extend_list_merging() -> Result<(), Box<dyn std::error::Error>> {
 #[test]
 fn overwrite_list_cli() -> Result<(), Box<dyn std::error::Error>> {
     let dir = TempDir::new()?;
-    std::fs::write(dir.path().join("advanced-config.yaml"), 
-        "overwrite_list: [\"config_item\"]\nspecial_secret: \"secret\"\nextra_settings: { nesting_level: 3, allow_guest: false }")?;
+    std::fs::write(dir.path().join("advanced-config.yaml"),
+        "overwrite-list: [\"config_item\"]\nspecial-secret: \"secret\"\nextra-settings:\n  nesting-level: 3\n  allow-guest: false")?;
 
     Command::cargo_bin("advanced")?
         .current_dir(dir.path())
@@ -49,7 +49,7 @@ fn config_only_field_from_file() -> Result<(), Box<dyn std::error::Error>> {
     let dir = TempDir::new()?;
     std::fs::write(
         dir.path().join("advanced-config.yaml"),
-        "special_secret: \"from_config\"\nextra_settings: { nesting_level: 3, allow_guest: false }",
+        "special-secret: \"from_config\"",
     )?;
 
     Command::cargo_bin("advanced")?
@@ -80,7 +80,7 @@ fn test_positional_args() -> Result<(), Box<dyn std::error::Error>> {
     let dir = TempDir::new()?;
     std::fs::write(
         dir.path().join("advanced-config.yaml"),
-        "database_url: \"sqlite://test.db\"\n",
+        "database-url: \"sqlite://test.db\"\n",
     )?;
 
     Command::cargo_bin("advanced")?

tests/basic.rs

@@ -57,13 +57,13 @@ fn no_config_uses_defaults() -> Result<(), Box<dyn std::error::Error>> {
 fn config_overrides_default_github_issue_8() -> Result<(), Box<dyn std::error::Error>> {
     // This test specifically validates the fix for GitHub issue #8
     // Config file values should override default_value attributes
-    
+
     let dir = Path::new("examples/basic");
-    
+
     // The config file has port: 9090
     // The struct has #[config_arg(default_value = "8080")]
     // Expected: config value (9090) should override default (8080)
-    
+
     Command::cargo_bin("basic")?
         .current_dir(dir)
         .arg("--config-file")