settingspec 0.4.0__tar.gz → 0.5.1__tar.gz

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

@@ -282,6 +282,15 @@ dependencies = [
  "generic-array",
 ]
 
+[[package]]
+name = "block2"
+version = "0.6.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cdeb9d870516001442e364c5220d3574d2da8dc765554b4a617230d33fa58ef5"
+dependencies = [
+ "objc2",
+]
+
 [[package]]
 name = "blowfish"
 version = "0.9.1"
@@ -324,6 +333,12 @@ version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
 
+[[package]]
+name = "cfg_aliases"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527"
+
 [[package]]
 name = "chacha20"
 version = "0.9.1"
@@ -519,6 +534,17 @@ dependencies = [
  "cipher",
 ]
 
+[[package]]
+name = "ctrlc"
+version = "3.5.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e0b1fab2ae45819af2d0731d60f2afe17227ebb1a1538a236da84c93e9a60162"
+dependencies = [
+ "dispatch2",
+ "nix",
+ "windows-sys",
+]
+
 [[package]]
 name = "curve25519-dalek"
 version = "4.1.3"
@@ -584,6 +610,18 @@ dependencies = [
  "crypto-common 0.2.2",
 ]
 
+[[package]]
+name = "dispatch2"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e0e367e4e7da84520dedcac1901e4da967309406d1e51017ae1abfb97adbd38"
+dependencies = [
+ "bitflags",
+ "block2",
+ "libc",
+ "objc2",
+]
+
 [[package]]
 name = "displaydoc"
 version = "0.2.7"
@@ -1180,6 +1218,18 @@ dependencies = [
  "sha3",
 ]
 
+[[package]]
+name = "nix"
+version = "0.31.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf20d2fde8ff38632c426f1165ed7436270b44f199fc55284c38276f9db47c3d"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "cfg_aliases",
+ "libc",
+]
+
 [[package]]
 name = "nom"
 version = "8.0.0"
@@ -1240,6 +1290,21 @@ dependencies = [
  "libm",
 ]
 
+[[package]]
+name = "objc2"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3a12a8ed07aefc768292f076dc3ac8c48f3781c8f2d5851dd3d98950e8c5a89f"
+dependencies = [
+ "objc2-encode",
+]
+
+[[package]]
+name = "objc2-encode"
+version = "4.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ef25abbcd74fb2609453eb695bd2f860d389e457f67dc17cafc8b8cbc89d0c33"
+
 [[package]]
 name = "once_cell"
 version = "1.21.4"
@@ -1758,7 +1823,7 @@ dependencies = [
 
 [[package]]
 name = "settingspec"
-version = "0.4.0"
+version = "0.5.1"
 dependencies = [
  "age",
  "anyhow",
@@ -1766,6 +1831,7 @@ dependencies = [
  "assert_fs",
  "clap",
  "clap_complete",
+ "ctrlc",
  "dotenvy",
  "indexmap",
  "predicates",

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

@@ -1,6 +1,6 @@
 [package]
 name = "settingspec"
-version = "0.4.0"
+version = "0.5.1"
 edition = "2024"
 description = "One file for all environments, all languages, all submodules."
 readme = "README.md"
@@ -40,6 +40,7 @@ serde_yaml = "0.9"
 indexmap = { version = "2", features = ["serde"] }
 dotenvy = "0.15.7"
 age = { version = "0.12.1", features = ["armor", "ssh"] }
+ctrlc = "3.5.2"
 
 [dev-dependencies]
 assert_fs = "1.1.4"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: settingspec
-Version: 0.4.0
+Version: 0.5.1
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -19,7 +19,7 @@ Project-URL: Source Code, https://github.com/sayanarijit/settingspec
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://s15.gifyu.com/images/buXVO.png">
     <source media="(prefers-color-scheme: light)" srcset="https://s15.gifyu.com/images/buXZJ.png">
-    <img alt="The settingspec cover" width="600" src="https://s15.gifyu.com/images/buXZJ.png">
+    <img alt="The settingspec cover" width="100%" src="https://s15.gifyu.com/images/buXZJ.png">
   </picture>
 </p>
 
@@ -28,16 +28,17 @@ Project-URL: Source Code, https://github.com/sayanarijit/settingspec
 [![PyPI Version](https://img.shields.io/pypi/v/settingspec)](https://pypi.org/project/settingspec)
 [![NPM Version](https://img.shields.io/npm/v/%40sayanarijit%2Fsettingspec)](https://www.npmjs.com/package/@sayanarijit/settingspec)
 
-# Table of contents
+# SettingSpec
 
-1.  [Concepts](#concepts)
-    1. [Single file convenience](#single-file-convenience)
-    2. [Declarative profiles as environments](#declarative-profiles-as-environments)
-    3. [Language independent](#language-independent)
-    4. [Easy secrets](#easy-secrets)
-       1. [SecretSpec](#secretspec)
-       2. [Dotenv](#dotenv)
-2.  [Learn more](#learn-more)
+1. [Concepts](#concepts)
+   1. [Single file convenience](#single-file-convenience)
+   2. [Declarative profiles as environments](#declarative-profiles-as-environments)
+   3. [Language independent](#language-independent)
+   4. [Easy secrets](#easy-secrets)
+      1. [SecretSpec](#secretspec)
+      2. [Dotenv](#dotenv)
+      3. [Cottage or agebox](#cottage-or-agebox)
+2. [Learn more](#learn-more)
 
 ## Concepts
 
@@ -109,6 +110,12 @@ Now export the final settings as declared.
 settingspec export
 ```
 
+Or keep watching to export when `settingspec.toml` changes.
+
+```bash
+settingspec watch
+```
+
 Or directly run the program with exported settings.
 
 ```bash
@@ -182,6 +189,22 @@ envfile.prod = "-"          # Read from stdin, encrypted or not
 secret1.default.env = "SECRET1"     # Load value from $SECRET1
 ```
 
+#### Cottage or agebox
+
+Too simple? Use [Cottage](https://cottage-cli.pages.dev) or [agebox](https://github.com/slok/agebox).
+
+```toml
+[spec]
+envfile.default = ".env.cott.age"
+
+# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
+# decryption.key.env = "COTTAGE_IDENTITY"
+decryption.key.path = "~/.config/cottage/identity:~/.ssh"
+
+[settings]
+secret.default.env = "SECRET"
+```
+
 ## Learn more
 
 Check out the [settingspec.toml](./settingspec.toml) example file and [full specification](./SPECIFICATION.md) for more details.

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

@@ -2,7 +2,7 @@
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://s15.gifyu.com/images/buXVO.png">
     <source media="(prefers-color-scheme: light)" srcset="https://s15.gifyu.com/images/buXZJ.png">
-    <img alt="The settingspec cover" width="600" src="https://s15.gifyu.com/images/buXZJ.png">
+    <img alt="The settingspec cover" width="100%" src="https://s15.gifyu.com/images/buXZJ.png">
   </picture>
 </p>
 
@@ -11,16 +11,17 @@
 [![PyPI Version](https://img.shields.io/pypi/v/settingspec)](https://pypi.org/project/settingspec)
 [![NPM Version](https://img.shields.io/npm/v/%40sayanarijit%2Fsettingspec)](https://www.npmjs.com/package/@sayanarijit/settingspec)
 
-# Table of contents
+# SettingSpec
 
-1.  [Concepts](#concepts)
-    1. [Single file convenience](#single-file-convenience)
-    2. [Declarative profiles as environments](#declarative-profiles-as-environments)
-    3. [Language independent](#language-independent)
-    4. [Easy secrets](#easy-secrets)
-       1. [SecretSpec](#secretspec)
-       2. [Dotenv](#dotenv)
-2.  [Learn more](#learn-more)
+1. [Concepts](#concepts)
+   1. [Single file convenience](#single-file-convenience)
+   2. [Declarative profiles as environments](#declarative-profiles-as-environments)
+   3. [Language independent](#language-independent)
+   4. [Easy secrets](#easy-secrets)
+      1. [SecretSpec](#secretspec)
+      2. [Dotenv](#dotenv)
+      3. [Cottage or agebox](#cottage-or-agebox)
+2. [Learn more](#learn-more)
 
 ## Concepts
 
@@ -92,6 +93,12 @@ Now export the final settings as declared.
 settingspec export
 ```
 
+Or keep watching to export when `settingspec.toml` changes.
+
+```bash
+settingspec watch
+```
+
 Or directly run the program with exported settings.
 
 ```bash
@@ -165,6 +172,22 @@ envfile.prod = "-"          # Read from stdin, encrypted or not
 secret1.default.env = "SECRET1"     # Load value from $SECRET1
 ```
 
+#### Cottage or agebox
+
+Too simple? Use [Cottage](https://cottage-cli.pages.dev) or [agebox](https://github.com/slok/agebox).
+
+```toml
+[spec]
+envfile.default = ".env.cott.age"
+
+# decryption.key.env = "AGEBOX_PRIVATE_KEYS"
+# decryption.key.env = "COTTAGE_IDENTITY"
+decryption.key.path = "~/.config/cottage/identity:~/.ssh"
+
+[settings]
+secret.default.env = "SECRET"
+```
+
 ## Learn more
 
 Check out the [settingspec.toml](./settingspec.toml) example file and [full specification](./SPECIFICATION.md) for more details.

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

@@ -7,8 +7,29 @@ use crate::parser::parse_config_str;
 use crate::profile::resolve_active_profile;
 use crate::resolver::resolve_settings;
 use clap::{Parser, Subcommand};
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
+use std::io::Write;
 use std::path::{Path, PathBuf};
+use std::sync::mpsc;
+use std::time::Duration;
+
+#[derive(Default)]
+struct CleanupGuard {
+    keep: bool,
+    paths: HashSet<PathBuf>,
+}
+
+impl Drop for CleanupGuard {
+    fn drop(&mut self) {
+        if !self.keep {
+            self.paths.iter().for_each(|path| {
+                if std::fs::exists(path).unwrap_or(false) {
+                    let _ = std::fs::remove_file(path);
+                }
+            });
+        }
+    }
+}
 
 #[derive(Parser, Debug)]
 #[command(
@@ -34,6 +55,8 @@ pub enum Commands {
         #[arg(last = true, required = true)]
         command: Vec<String>,
     },
+    /// Watches settingspec.toml and regenerates exports whenever it changes
+    Watch,
 }
 
 pub const INIT_CONFIG: &str = r#"[spec]
@@ -145,9 +168,83 @@ pub fn run_cli() -> Result<()> {
             let ctx = load_and_resolve()?;
             execute_run(&ctx, &command)
         }
+        Commands::Watch => run_watch(),
     }
 }
 
+fn run_watch() -> Result<()> {
+    let ctx = load_and_resolve()?;
+    let config_path = ctx.project_root.join("settingspec.toml");
+    let mut guard = CleanupGuard::default();
+
+    let (tx, rx) = mpsc::channel();
+    let (txsig, rxsig) = mpsc::channel();
+
+    ctrlc::set_handler(move || txsig.send(()).expect("Could not send signal on channel."))
+        .expect("Error setting Ctrl-C handler");
+
+    std::thread::spawn(move || {
+        let _ = tx.send(true); // Trigger initial export
+
+        let mut modified = std::fs::metadata(&config_path)
+            .ok()
+            .and_then(|m| m.modified().ok());
+
+        loop {
+            std::thread::sleep(Duration::from_secs(1));
+            if rxsig.try_recv().is_ok() {
+                let _ = tx.send(false);
+                break;
+            } else {
+                let new_modified = std::fs::metadata(&config_path)
+                    .ok()
+                    .and_then(|m| m.modified().ok());
+                if new_modified != modified {
+                    modified = new_modified;
+                    let _ = tx.send(true);
+                }
+            }
+        }
+    });
+
+    while rx.recv().unwrap_or(false) {
+        match load_and_resolve() {
+            Ok(mut ctx) => {
+                guard.keep = ctx.doc.spec.export.keep;
+                if ctx.doc.spec.export.file.is_empty() {
+                    eprintln!("No export files configured, skipping export.");
+                    continue;
+                }
+                ctx.doc.spec.export.stdout = None;
+                ctx.doc.spec.export.stdin = None;
+                ctx.doc.spec.export.env = None;
+
+                eprintln!("Exporting files...");
+                if let Err(e) = perform_export(&ctx) {
+                    eprintln!("Error during export: {}", e);
+                }
+                ctx.doc
+                    .spec
+                    .export
+                    .file
+                    .iter()
+                    .for_each(|(file_path_str, filter)| {
+                        if !matches!(filter, ExportFilter::Disabled) {
+                            guard.paths.insert(PathBuf::from(file_path_str));
+                            println!("{file_path_str}");
+                        }
+                    });
+            }
+            Err(e) => {
+                eprintln!("Error loading configuration: {}", e);
+            }
+        }
+    }
+
+    eprintln!("Exiting watch mode.");
+    Ok(())
+}
+
 fn perform_export(ctx: &ExecutionContext) -> Result<Vec<PathBuf>> {
     auto_append_gitignore(ctx)?;
 
@@ -189,28 +286,10 @@ fn execute_run(ctx: &ExecutionContext, command_args: &[String]) -> Result<()> {
     }
 
     // Export all files
-    let generated_files = perform_export(ctx)?;
-
-    // Setup cleanup guard
-    struct CleanupGuard {
-        files: Vec<PathBuf>,
-        keep: bool,
-    }
-
-    impl Drop for CleanupGuard {
-        fn drop(&mut self) {
-            if !self.keep {
-                for f in &self.files {
-                    let _ = std::fs::remove_file(f);
-                }
-            }
-        }
-    }
-
-    let _guard = CleanupGuard {
-        files: generated_files,
+    let _guard = perform_export(ctx).map(|files| CleanupGuard {
         keep: ctx.doc.spec.export.keep,
-    };
+        paths: files.into_iter().collect(),
+    })?;
 
     let stdin_payload = if let Some(ref stdin_fmt) = ctx.doc.spec.export.stdin {
         Some(generate_by_format(stdin_fmt, &ctx.resolved_settings)?)
@@ -250,7 +329,6 @@ fn execute_run(ctx: &ExecutionContext, command_args: &[String]) -> Result<()> {
         let child_stdin = child.stdin.take();
         let writer = std::thread::spawn(move || {
             if let Some(mut stdin) = child_stdin {
-                use std::io::Write;
                 let _ = stdin.write_all(payload.as_bytes());
             }
         });
@@ -372,16 +450,14 @@ pub fn auto_append_gitignore(ctx: &ExecutionContext) -> Result<()> {
         return Ok(());
     }
 
-    let current_dir = &ctx.project_root;
-    let git_root = match find_git_root(current_dir) {
-        Some(root) => root,
-        None => return Ok(()),
-    };
+    if find_git_root(&ctx.project_root).is_none() {
+        return Ok(());
+    }
 
-    let git_root_canon = git_root.canonicalize().unwrap_or_else(|_| git_root.clone());
-    let current_dir_canon = current_dir
+    let project_root = &ctx.project_root;
+    let project_root_canon = project_root
         .canonicalize()
-        .unwrap_or_else(|_| current_dir.clone());
+        .unwrap_or_else(|_| project_root.clone());
 
     let mut entries_to_add = Vec::new();
 
@@ -392,13 +468,13 @@ pub fn auto_append_gitignore(ctx: &ExecutionContext) -> Result<()> {
 
         let target_path = Path::new(file_path_str);
         let full_target = if target_path.is_relative() {
-            current_dir_canon.join(target_path)
+            project_root_canon.join(target_path)
         } else {
             target_path.to_path_buf()
         };
 
         let normalized = normalize_path(&full_target);
-        let rel_path = match normalized.strip_prefix(&git_root_canon) {
+        let rel_path = match normalized.strip_prefix(&project_root_canon) {
             Ok(rel) => rel,
             Err(_) => continue,
         };
@@ -422,7 +498,7 @@ pub fn auto_append_gitignore(ctx: &ExecutionContext) -> Result<()> {
         return Ok(());
     }
 
-    let gitignore_path = git_root.join(".gitignore");
+    let gitignore_path = project_root.join(".gitignore");
     let existing_content = if gitignore_path.exists() {
         std::fs::read_to_string(&gitignore_path)?
     } else {
@@ -449,7 +525,6 @@ pub fn auto_append_gitignore(ctx: &ExecutionContext) -> Result<()> {
         to_append.push('\n');
     }
 
-    use std::io::Write;
     let mut file = std::fs::OpenOptions::new()
         .create(true)
         .append(true)