added TUCKR_USER_* environment variables for convenience

Author: RaphGL

book/src/path-finding/env.md

@@ -13,3 +13,13 @@ program
 ```
 Tuckr will expand it to `/home/user/Documents/program/config.txt`.
 
+## Default paths
+Tuckr sets a few default environment variables when it runs that are useful to prevent duplicated config file for each 
+conditional target.
+
+- [`TUCKR_USER_CONFIG`](https://docs.rs/dirs/latest/dirs/fn.config_dir.html)
+- [`TUCKR_USER_DOWNLOADS`](https://docs.rs/dirs/latest/dirs/fn.download_dir.html)
+- [`TUCKR_USER_DOCUMENTS`](https://docs.rs/dirs/latest/dirs/fn.document_dir.html)
+- [`TUCKR_USER_DESKTOP`](https://docs.rs/dirs/latest/dirs/fn.desktop_dir.html) 
+- [`TUCKR_USER_DATA`](https://docs.rs/dirs/latest/dirs/fn.data_dir.html)
+- [`TUCKR_USER_PICTURES`](https://docs.rs/dirs/latest/dirs/fn.picture_dir.html)

src/main.rs

@@ -16,6 +16,8 @@ mod secrets;
 mod symlinks;
 
 use clap::{Parser, Subcommand};
+use std::env;
+use std::path::PathBuf;
 use std::process::ExitCode;
 
 rust_i18n::i18n!("locales", minify_key = true, fallback = "en");
@@ -267,6 +269,22 @@ enum ListType {
     Hooks,
 }
 
+unsafe fn default_var(var: &str, default_path: Option<PathBuf>) {
+    let Some(default_path) = default_path else {
+        return;
+    };
+
+    if !default_path.exists() || env::var(var).is_ok() {
+        return;
+    }
+
+    if let Ok(default_path) = default_path.canonicalize() {
+        unsafe {
+            env::set_var(var, default_path.to_str().unwrap());
+        }
+    }
+}
+
 fn main() -> ExitCode {
     let cli = {
         // custom targets can be set permanently through env vars or set temporarily through the cli
@@ -284,6 +302,15 @@ fn main() -> ExitCode {
 
     rust_i18n::set_locale(sys_locale::get_locale().unwrap_or_default().as_str());
 
+    unsafe {
+        default_var("TUCKR_USER_CONFIG", dirs::config_dir());
+        default_var("TUCKR_USER_DESKTOP", dirs::desktop_dir());
+        default_var("TUCKR_USER_DOCUMENTS", dirs::document_dir());
+        default_var("TUCKR_USER_DATA", dirs::data_dir());
+        default_var("TUCKR_USER_DOWNLOADS", dirs::download_dir());
+        default_var("TUCKR_USER_PICTURES", dirs::picture_dir());
+    }
+
     let exit_code = match cli.command {
         Command::Set {
             groups,

src/symlinks.rs

@@ -1196,7 +1196,7 @@ mod tests {
 
     impl Test {
         fn start() -> Self {
-            let target_dir =  dotfiles::get_dotfiles_target_dir_path().unwrap();
+            let target_dir = dotfiles::get_dotfiles_target_dir_path().unwrap();
             fs::create_dir_all(&target_dir).unwrap();
 
             crate::fileops::init_cmd(&Context::default()).unwrap();
@@ -1209,7 +1209,6 @@ mod tests {
             let filepaths = [
                 new_config_dir.join("group_file"),
                 group_dir.join("group_file_0"),
-
                 configs_dir
                     .join("shared_group1")
                     .join("shared_dir")
@@ -1325,7 +1324,7 @@ mod tests {
         let shared_dir_target = target_dir.join("shared_dir");
         _ = fs::remove_dir_all(&shared_dir_target);
 
-        let test = Test::start();
+        let _test = Test::start();
 
         assert!(!shared_dir_target.exists());