settingspec 0.5.1__tar.gz → 0.7.0__tar.gz

{settingspec-0.5.1 → settingspec-0.7.0}/Cargo.lock

@@ -1823,7 +1823,7 @@ dependencies = [
 
 [[package]]
 name = "settingspec"
-version = "0.5.1"
+version = "0.7.0"
 dependencies = [
  "age",
  "anyhow",

{settingspec-0.5.1 → settingspec-0.7.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "settingspec"
-version = "0.5.1"
+version = "0.7.0"
 edition = "2024"
 description = "One file for all environments, all languages, all submodules."
 readme = "README.md"

{settingspec-0.5.1 → settingspec-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: settingspec
-Version: 0.5.1
+Version: 0.7.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -58,14 +58,15 @@ profile.options = [                  # Optional: Enables strict checking of per-
 ]
 profile.default = "dev"  # Optional: Default profile when the switch is not set
 
-[settings]                 # Declare the settings here with syntax: `<key>.<profile>.<directive> = <value>`
-key1.default.val = "val1"  # Default value for all profiles
-key1.prod.val = "prod1"    # Override the default value when SETTINGSPEC_PROFILE=prod
+[settings]                   # Declare the settings here with syntax: `<key>._.<profile>.<directive> = <value>`
+key1._.default.val = "val1"  # Default value for all profiles
+key1._.prod.val = "prod1"    # Override the default value when SETTINGSPEC_PROFILE=prod
 
-# Strictly define different values for different profiles
-key2.dev.val = "dev2"      # When SETTINGSPEC_PROFILE=dev, key2=dev2
-key2.stage.val = "stage2"
-key2.prod.val = "prod2"
+key2._ = {  # Strictly define different values for different profiles
+  dev.val = "dev2",
+  stage.val = "stage2",
+  prod.val = "prod2",
+}
 ```
 
 Overrides are intentional and kept in plain sight (see `key1`).
@@ -74,14 +75,14 @@ By not defining a default value, you can ensure that you never miss adding a val
 
 ### Language independent
 
-The command-line tool `settingspec` can export the final settings into well-known formats such as `toml`, `json`, `yaml`, etc., or hard-coded modules such as `.py`, `.js`, `.lua`, etc., write them to disk, print, or pipe them via stdin or even export as environment variables, allowing you to use a single `settingspec.toml` without worrying about the target language.
+The command-line tool `settingspec` can export the final settings into well-known formats such as `toml`, `json`, `yaml`, `tf`, etc., or hard-coded modules such as `.py`, `.js`, `.ts`, `.lua`, `.rs`, `.go`, `.zig`, `.c`, `.cpp`, `.java`, `.elm`, `.rb`, `.scala`, `.hs`, etc., write them to disk, print, or pipe them via stdin or even export as environment variables, allowing you to use a single `settingspec.toml` without worrying about the target language.
 
 ```toml
 [spec]
-export.file = true  # Default: Export all settings into settings.toml
-# export.file = {   # Optional: Fine-grained control over what to export
-#   "settings.json" = true,
-#   "settings.yaml" = {
+export.file = true         # Default: Export all settings into settings.toml
+# export.file = {          # Optional: Fine-grained control over what to export
+#   "settings.py" = true,  # Get auto-completion of settings in your editor/IDE for free
+#   "settings.yaml" = {    # Select which keys to export
 #     key1 = true,
 #     group1 = true,
 #     group2.subgroup = true,
@@ -97,11 +98,11 @@ export.env = "PREFIX_"  # Optional: Export as environment variables prefixed wit
 export.stdin = "toml"   # Optional: Pass settings to program stdin in specified format
 
 [settings]
-key1.default.val = "val1"
-group1.key1.default.val = "group1val1"
-group2.subgroup.key1.default.val = "group2val1"
-group3.subgroup.key1.default.val = "group3val1"
-group3.subgroup.key1.default.tags = ["tag1", "tag2"]
+key1._.default.val = "val1"
+group1.key1._.default.val = "group1val1"
+group2.subgroup.key1._.default.val = "group2val1"
+group3.subgroup.key1._.default.val = "group3val1"
+group3.subgroup.key1._.tags = ["tag1", "tag2"]  # Syntax: `<key>._.tags = [...]`
 ```
 
 Now export the final settings as declared.
@@ -125,7 +126,7 @@ settingspec run -- [your program]...
 If no export option is specified, the default behavior is to export all settings into `settings.toml`.
 
 > [!NOTE]
-> If the target programming language supports null values, you can declare it as `key.default.null = true` in the settings section.
+> If the target programming language supports null values, you can declare it as `key._.default.null = true` in the settings section.
 
 ### Easy secrets
 
@@ -156,12 +157,12 @@ settingspec.toml
 profile.options = ["dev", "stage", "prod"]
 
 [settings]
-secret1.default.env = "SECRET1"  # Load value from $SECRET1
+secret1._.default.env = "SECRET1"  # Load value from $SECRET1
 
 # Override the default value from environment variables
-secret2.default.val = "defaultvalue"  # Default value if $SECRET2 is not set
-secret2.default.env = "SECRET2"       # Load value from $SECRET2 if set
-secret2.prod.env = "PRODSECRET"       # Load value from $PRODSECRET if SETTINGSPEC_PROFILE=prod
+secret2._.default.val = "defaultvalue"  # Default value if $SECRET2 is not set
+secret2._.default.env = "SECRET2"       # Load value from $SECRET2 if set
+secret2._.prod.env = "PRODSECRET"       # Load value from $PRODSECRET if SETTINGSPEC_PROFILE=prod
 ```
 
 With these set up, run:
@@ -186,7 +187,7 @@ envfile.prod = "-"          # Read from stdin, encrypted or not
 # decryption.key.path = "~/.ssh/"                    # Default
 
 [settings]
-secret1.default.env = "SECRET1"     # Load value from $SECRET1
+secret1._.default.env = "SECRET1"     # Load value from $SECRET1
 ```
 
 #### Cottage or agebox
@@ -196,13 +197,14 @@ Too simple? Use [Cottage](https://cottage-cli.pages.dev) or [agebox](https://git
 ```toml
 [spec]
 envfile.default = ".env.cott.age"
+# envfile.default = ".env.agebox"
 
-# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
-# decryption.key.env = "COTTAGE_IDENTITY"
 decryption.key.path = "~/.config/cottage/identity:~/.ssh"
+decryption.key.env = "COTTAGE_IDENTITY"
+# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
 
 [settings]
-secret.default.env = "SECRET"
+secret._.default.env = "SECRET"
 ```
 
 ## Learn more

{settingspec-0.5.1 → settingspec-0.7.0}/README.md

@@ -41,14 +41,15 @@ profile.options = [                  # Optional: Enables strict checking of per-
 ]
 profile.default = "dev"  # Optional: Default profile when the switch is not set
 
-[settings]                 # Declare the settings here with syntax: `<key>.<profile>.<directive> = <value>`
-key1.default.val = "val1"  # Default value for all profiles
-key1.prod.val = "prod1"    # Override the default value when SETTINGSPEC_PROFILE=prod
-
-# Strictly define different values for different profiles
-key2.dev.val = "dev2"      # When SETTINGSPEC_PROFILE=dev, key2=dev2
-key2.stage.val = "stage2"
-key2.prod.val = "prod2"
+[settings]                   # Declare the settings here with syntax: `<key>._.<profile>.<directive> = <value>`
+key1._.default.val = "val1"  # Default value for all profiles
+key1._.prod.val = "prod1"    # Override the default value when SETTINGSPEC_PROFILE=prod
+
+key2._ = {  # Strictly define different values for different profiles
+  dev.val = "dev2",
+  stage.val = "stage2",
+  prod.val = "prod2",
+}
 ```
 
 Overrides are intentional and kept in plain sight (see `key1`).
@@ -57,14 +58,14 @@ By not defining a default value, you can ensure that you never miss adding a val
 
 ### Language independent
 
-The command-line tool `settingspec` can export the final settings into well-known formats such as `toml`, `json`, `yaml`, etc., or hard-coded modules such as `.py`, `.js`, `.lua`, etc., write them to disk, print, or pipe them via stdin or even export as environment variables, allowing you to use a single `settingspec.toml` without worrying about the target language.
+The command-line tool `settingspec` can export the final settings into well-known formats such as `toml`, `json`, `yaml`, `tf`, etc., or hard-coded modules such as `.py`, `.js`, `.ts`, `.lua`, `.rs`, `.go`, `.zig`, `.c`, `.cpp`, `.java`, `.elm`, `.rb`, `.scala`, `.hs`, etc., write them to disk, print, or pipe them via stdin or even export as environment variables, allowing you to use a single `settingspec.toml` without worrying about the target language.
 
 ```toml
 [spec]
-export.file = true  # Default: Export all settings into settings.toml
-# export.file = {   # Optional: Fine-grained control over what to export
-#   "settings.json" = true,
-#   "settings.yaml" = {
+export.file = true         # Default: Export all settings into settings.toml
+# export.file = {          # Optional: Fine-grained control over what to export
+#   "settings.py" = true,  # Get auto-completion of settings in your editor/IDE for free
+#   "settings.yaml" = {    # Select which keys to export
 #     key1 = true,
 #     group1 = true,
 #     group2.subgroup = true,
@@ -80,11 +81,11 @@ export.env = "PREFIX_"  # Optional: Export as environment variables prefixed wit
 export.stdin = "toml"   # Optional: Pass settings to program stdin in specified format
 
 [settings]
-key1.default.val = "val1"
-group1.key1.default.val = "group1val1"
-group2.subgroup.key1.default.val = "group2val1"
-group3.subgroup.key1.default.val = "group3val1"
-group3.subgroup.key1.default.tags = ["tag1", "tag2"]
+key1._.default.val = "val1"
+group1.key1._.default.val = "group1val1"
+group2.subgroup.key1._.default.val = "group2val1"
+group3.subgroup.key1._.default.val = "group3val1"
+group3.subgroup.key1._.tags = ["tag1", "tag2"]  # Syntax: `<key>._.tags = [...]`
 ```
 
 Now export the final settings as declared.
@@ -108,7 +109,7 @@ settingspec run -- [your program]...
 If no export option is specified, the default behavior is to export all settings into `settings.toml`.
 
 > [!NOTE]
-> If the target programming language supports null values, you can declare it as `key.default.null = true` in the settings section.
+> If the target programming language supports null values, you can declare it as `key._.default.null = true` in the settings section.
 
 ### Easy secrets
 
@@ -139,12 +140,12 @@ settingspec.toml
 profile.options = ["dev", "stage", "prod"]
 
 [settings]
-secret1.default.env = "SECRET1"  # Load value from $SECRET1
+secret1._.default.env = "SECRET1"  # Load value from $SECRET1
 
 # Override the default value from environment variables
-secret2.default.val = "defaultvalue"  # Default value if $SECRET2 is not set
-secret2.default.env = "SECRET2"       # Load value from $SECRET2 if set
-secret2.prod.env = "PRODSECRET"       # Load value from $PRODSECRET if SETTINGSPEC_PROFILE=prod
+secret2._.default.val = "defaultvalue"  # Default value if $SECRET2 is not set
+secret2._.default.env = "SECRET2"       # Load value from $SECRET2 if set
+secret2._.prod.env = "PRODSECRET"       # Load value from $PRODSECRET if SETTINGSPEC_PROFILE=prod
 ```
 
 With these set up, run:
@@ -169,7 +170,7 @@ envfile.prod = "-"          # Read from stdin, encrypted or not
 # decryption.key.path = "~/.ssh/"                    # Default
 
 [settings]
-secret1.default.env = "SECRET1"     # Load value from $SECRET1
+secret1._.default.env = "SECRET1"     # Load value from $SECRET1
 ```
 
 #### Cottage or agebox
@@ -179,13 +180,14 @@ Too simple? Use [Cottage](https://cottage-cli.pages.dev) or [agebox](https://git
 ```toml
 [spec]
 envfile.default = ".env.cott.age"
+# envfile.default = ".env.agebox"
 
-# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
-# decryption.key.env = "COTTAGE_IDENTITY"
 decryption.key.path = "~/.config/cottage/identity:~/.ssh"
+decryption.key.env = "COTTAGE_IDENTITY"
+# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
 
 [settings]
-secret.default.env = "SECRET"
+secret._.default.env = "SECRET"
 ```
 
 ## Learn more

{settingspec-0.5.1 → settingspec-0.7.0}/src/cli.rs

@@ -57,6 +57,9 @@ pub enum Commands {
     },
     /// Watches settingspec.toml and regenerates exports whenever it changes
     Watch,
+
+    /// Deletes all generated export files
+    Clean,
 }
 
 pub const INIT_CONFIG: &str = r#"[spec]
@@ -64,8 +67,8 @@ profile.options = ["local", "prod"]
 profile.default = "local"  # Switch via $SETTINGSPEC_PROFILE
 
 [settings]
-key.local.val = "local"
-key.prod.env = "KEY"  # Load from $KEY when active profile is "prod"
+key._.local.val = "local"
+key._.prod.env = "KEY"  # Load from $KEY when active profile is "prod"
 "#;
 
 pub fn init_config() -> Result<()> {
@@ -169,6 +172,7 @@ pub fn run_cli() -> Result<()> {
             execute_run(&ctx, &command)
         }
         Commands::Watch => run_watch(),
+        Commands::Clean => clean_exported_files(),
     }
 }
 
@@ -278,6 +282,17 @@ fn perform_export(ctx: &ExecutionContext) -> Result<Vec<PathBuf>> {
     Ok(generated_files)
 }
 
+fn clean_exported_files() -> Result<()> {
+    let ctx = load_and_resolve()?;
+
+    let _guard = CleanupGuard {
+        keep: false,
+        paths: ctx.doc.spec.export.file.keys().map(PathBuf::from).collect(),
+    };
+
+    Ok(())
+}
+
 fn execute_run(ctx: &ExecutionContext, command_args: &[String]) -> Result<()> {
     if command_args.is_empty() {
         return Err(SettingSpecError::InvalidToml(

{settingspec-0.5.1 → settingspec-0.7.0}/src/error.rs

@@ -5,8 +5,9 @@ pub enum SettingSpecError {
     ConfigNotFound,
     InvalidToml(String),
     MissingSettingsSection,
-    ReservedProfileInOptions,
+    ReservedProfileInOptions(String),
     ReservedKeywordConflict(String),
+    InvalidDeclaration(String, String),
     UnknownProfileInSettings(String),
     ActiveProfileNotInOptions(String),
     NoProfileSelected,
@@ -14,7 +15,8 @@ pub enum SettingSpecError {
     InvalidDirective(String, String, String), // setting key, profile, directive
     NullCoexistsWithVal(String, String),  // setting key, profile
     InvalidNullValue(String, String),     // setting key, profile
-    InvalidTagsValue(String, String),     // setting key, profile
+    InvalidTagsValue(String),             // setting key
+    DuplicateTags(String),                // setting key
     InvalidEnvValue(String, String),      // setting key, profile
     MissingRequiredEnvVar(String, String), // setting key, env var name
     RequiredValueMissing(String),         // setting key
@@ -37,15 +39,17 @@ impl fmt::Display for SettingSpecError {
                 f,
                 "Missing required '[settings]' section in settingspec.toml"
             ),
-            Self::ReservedProfileInOptions => write!(
+            Self::ReservedProfileInOptions(name) => write!(
                 f,
-                "Reserved profile identifier 'default' MUST NOT be in spec.profile.options"
-            ),
-            Self::ReservedKeywordConflict(seg) => write!(
-                f,
-                "Reserved directive keyword '{}' cannot be used as a setting key segment or profile name",
-                seg
+                "Reserved profile identifier '{}' MUST NOT be in spec.profile.options",
+                name
             ),
+            Self::ReservedKeywordConflict(seg) => {
+                write!(f, "Reserved profile name '{}' cannot be used", seg)
+            }
+            Self::InvalidDeclaration(decl, reason) => {
+                write!(f, "Invalid setting declaration '{}': {}", decl, reason)
+            }
             Self::UnknownProfileInSettings(p) => write!(
                 f,
                 "Unknown profile '{}' used in [settings] (not in spec.profile.options)",
@@ -80,14 +84,17 @@ impl fmt::Display for SettingSpecError {
                 "Directive 'null' must be true for setting '{}' in profile '{}'",
                 k, p
             ),
-            Self::InvalidTagsValue(k, p) => write!(
+            Self::InvalidTagsValue(k) => write!(
                 f,
-                "Directive 'tags' must be an array of strings for setting '{}' in profile '{}'",
-                k, p
+                "Directive 'tags' for setting '{}': expected a sequence of strings",
+                k
             ),
+            Self::DuplicateTags(k) => {
+                write!(f, "Setting '{}' has more than one tags declaration", k)
+            }
             Self::InvalidEnvValue(k, p) => write!(
                 f,
-                "Directive 'env' must be a string for setting '{}' in profile '{}'",
+                "Directive 'env' for setting '{}' in profile '{}': expected a string",
                 k, p
             ),
             Self::MissingRequiredEnvVar(k, env) => write!(

settingspec-0.7.0/src/generator/c.rs

@@ -0,0 +1,211 @@
+use super::common::{format_scalar_literal, is_valid_identifier};
+use super::tree::{ConfigNode, build_config_tree};
+use crate::error::Result;
+use crate::model::ResolvedSetting;
+use indexmap::IndexMap;
+use toml::Value as TomlValue;
+
+pub fn generate_c(settings: &[ResolvedSetting]) -> Result<String> {
+    let tree = build_config_tree(settings, false);
+    let mut out = String::from(
+        "/* Generated by SettingSpec */\n\n#ifndef SETTINGS_H\n#define SETTINGS_H\n\n#include <stdbool.h>\n#include <stddef.h>\n\n",
+    );
+
+    let mut struct_defs = String::new();
+    let root_type = generate_c_structs(&tree, "Settings", &mut struct_defs);
+
+    out.push_str(&struct_defs);
+
+    let mut init_vals = String::new();
+    format_c_init(&tree, 1, &mut init_vals);
+
+    out.push_str(&format!(
+        "static const {} settings = {{\n{}}};\n\n#endif /* SETTINGS_H */\n",
+        root_type, init_vals
+    ));
+
+    Ok(out)
+}
+
+fn generate_c_structs(
+    map: &IndexMap<String, ConfigNode>,
+    struct_name: &str,
+    out: &mut String,
+) -> String {
+    let mut fields = Vec::new();
+
+    for (k, node) in map {
+        let field_name = sanitize_c_identifier(k);
+        match node {
+            ConfigNode::Null => {
+                fields.push(format!("    const void* {};", field_name));
+            }
+            ConfigNode::Value(v) => match v {
+                TomlValue::String(_) | TomlValue::Datetime(_) => {
+                    fields.push(format!("    const char* {};", field_name));
+                }
+                TomlValue::Integer(_) => {
+                    fields.push(format!("    long long {};", field_name));
+                }
+                TomlValue::Float(_) => {
+                    fields.push(format!("    double {};", field_name));
+                }
+                TomlValue::Boolean(_) => {
+                    fields.push(format!("    bool {};", field_name));
+                }
+                TomlValue::Array(arr) => {
+                    let (type_str, len) = c_array_type(arr);
+                    fields.push(format!("    {} {}[{}];", type_str, field_name, len.max(1)));
+                    fields.push(format!("    size_t {}_len;", field_name));
+                }
+                TomlValue::Table(tbl) => {
+                    let sub_name = format!("{}{}", struct_name, capitalize(k));
+                    let mut sub_map = IndexMap::new();
+                    for (sub_k, sub_v) in tbl {
+                        sub_map.insert(sub_k.clone(), ConfigNode::Value(sub_v.clone()));
+                    }
+                    let sub_type = generate_c_structs(&sub_map, &sub_name, out);
+                    fields.push(format!("    {} {};", sub_type, field_name));
+                }
+            },
+            ConfigNode::Map(sub_map) => {
+                let sub_name = format!("{}{}", struct_name, capitalize(k));
+                let sub_type = generate_c_structs(sub_map, &sub_name, out);
+                fields.push(format!("    {} {};", sub_type, field_name));
+            }
+        }
+    }
+
+    let struct_def = format!(
+        "typedef struct {{\n{}\n}} {};\n\n",
+        fields.join("\n"),
+        struct_name
+    );
+    out.push_str(&struct_def);
+    struct_name.to_string()
+}
+
+fn format_c_init(map: &IndexMap<String, ConfigNode>, indent_level: usize, out: &mut String) {
+    let indent = "    ".repeat(indent_level);
+
+    for (k, node) in map {
+        let field_name = sanitize_c_identifier(k);
+        match node {
+            ConfigNode::Null => {
+                out.push_str(&format!("{}.{} = NULL,\n", indent, field_name));
+            }
+            ConfigNode::Value(v) => match v {
+                TomlValue::Boolean(b) => {
+                    out.push_str(&format!("{}.{} = {},\n", indent, field_name, b));
+                }
+                TomlValue::Array(arr) => {
+                    let items: Vec<String> = arr
+                        .iter()
+                        .map(|item| match item {
+                            TomlValue::Boolean(b) => b.to_string(),
+                            _ => format_scalar_literal(item).unwrap_or_else(|| "\"\"".to_string()),
+                        })
+                        .collect();
+                    out.push_str(&format!(
+                        "{}.{} = {{ {} }},\n{}.{}_len = {},\n",
+                        indent,
+                        field_name,
+                        items.join(", "),
+                        indent,
+                        field_name,
+                        arr.len()
+                    ));
+                }
+                TomlValue::Table(tbl) => {
+                    out.push_str(&format!("{}.{} = {{\n", indent, field_name));
+                    let mut sub_map = IndexMap::new();
+                    for (sub_k, sub_v) in tbl {
+                        sub_map.insert(sub_k.clone(), ConfigNode::Value(sub_v.clone()));
+                    }
+                    format_c_init(&sub_map, indent_level + 1, out);
+                    out.push_str(&format!("{}}},\n", indent));
+                }
+                _ => {
+                    if let Some(lit) = format_scalar_literal(v) {
+                        out.push_str(&format!("{}.{} = {},\n", indent, field_name, lit));
+                    }
+                }
+            },
+            ConfigNode::Map(sub_map) => {
+                out.push_str(&format!("{}.{} = {{\n", indent, field_name));
+                format_c_init(sub_map, indent_level + 1, out);
+                out.push_str(&format!("{}}},\n", indent));
+            }
+        }
+    }
+}
+
+fn c_array_type(arr: &[TomlValue]) -> (&'static str, usize) {
+    if arr.is_empty() {
+        return ("const char*", 0);
+    }
+    let elem_type = match &arr[0] {
+        TomlValue::Integer(_) => "long long",
+        TomlValue::Float(_) => "double",
+        TomlValue::Boolean(_) => "bool",
+        _ => "const char*",
+    };
+    (elem_type, arr.len())
+}
+
+fn sanitize_c_identifier(name: &str) -> String {
+    let is_keyword = matches!(
+        name,
+        "auto"
+            | "break"
+            | "case"
+            | "char"
+            | "const"
+            | "continue"
+            | "default"
+            | "do"
+            | "double"
+            | "else"
+            | "enum"
+            | "extern"
+            | "float"
+            | "for"
+            | "goto"
+            | "if"
+            | "inline"
+            | "int"
+            | "long"
+            | "register"
+            | "restrict"
+            | "return"
+            | "short"
+            | "signed"
+            | "sizeof"
+            | "static"
+            | "struct"
+            | "switch"
+            | "typedef"
+            | "union"
+            | "unsigned"
+            | "void"
+            | "volatile"
+            | "while"
+    );
+
+    if is_keyword || !is_valid_identifier(name) {
+        format!(
+            "_{}",
+            name.replace(|c: char| !c.is_ascii_alphanumeric(), "_")
+        )
+    } else {
+        name.to_string()
+    }
+}
+
+fn capitalize(s: &str) -> String {
+    let mut c = s.chars();
+    match c.next() {
+        None => String::new(),
+        Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
+    }
+}