Merge pull request #37 from uroybd/autoclean

feat: Autoclean

Author: uroybd

README.md

@@ -84,6 +84,14 @@ For detailed documentation, guides, and examples, visit the [DotR Wiki](https://
 - Profile-based deployments for different machines/environments
 - Directory structure preservation
 
+### 🧹 Clean Mode
+- **Clean by default** - automatically removes files in destination that don't exist in source
+- Keeps your deployed configurations synchronized with your repository
+- **Package-level control** - disable cleaning per package with `clean = false` in config
+- **CLI override** - use `--clean=false` to skip cleaning for a single operation
+- Perfect for maintaining tidy config directories without manual cleanup
+- Respects ignore patterns - won't remove files matching your ignore rules
+
 ## Quick Start
 
 1. **Initialize** a dotfiles repository:
@@ -315,14 +323,49 @@ dotr update --dry-run
 
 # Combine with other options
 dotr deploy --dry-run --profile work --packages nvim,bashrc
-dotr update --dry-run --clean
+
+# Preview deploy without cleaning extra files
+dotr deploy --dry-run --clean=false
 ```
 
 Dry run mode shows what would happen during deploy or update operations without:
 - Creating or modifying any files
 - Creating backups
 - Executing pre/post actions
-- Removing files (when using --clean)
+- Removing extra files (clean operations run by default)
+
+## Clean Mode
+
+By default, DotR cleans up destination directories by removing files that don't exist in your dotfiles repository. This keeps your configurations synchronized.
+
+```bash
+# Deploy with cleaning (default behavior)
+dotr deploy
+
+# Deploy without cleaning extra files
+dotr deploy --clean=false
+
+# Update with cleaning (default)
+dotr update
+
+# Update without cleaning
+dotr update --clean=false
+```
+
+**Package-level configuration:**
+```toml
+[packages.nvim]
+src = "dotfiles/nvim"
+dest = "~/.config/nvim/"
+clean = false  # Disable cleaning for this package
+```
+
+**How it works:**
+- Files in destination that aren't in source are removed during deploy/update
+- Backup files (`.dotrbak` extension) are never removed
+- Files matching ignore patterns are preserved
+- CLI `--clean` flag overrides package-level settings
+- Use `--clean=false` to keep extra files in destination
 
 ## Installation
 

src/cli/mod.rs

@@ -101,8 +101,8 @@ pub struct UpdateArgs {
     #[arg(long, default_value_t = false)]
     pub ignore_errors: bool,
 
-    #[arg(long, default_value_t = false)]
-    pub clean: bool,
+    #[arg(long)]
+    pub clean: Option<bool>,
 
     #[arg(long, default_value_t = false)]
     pub dry_run: bool,
@@ -120,8 +120,8 @@ pub struct DeployArgs {
     #[arg(long, default_value_t = false)]
     pub ignore_errors: bool,
 
-    #[arg(long, default_value_t = false)]
-    pub clean: bool,
+    #[arg(long)]
+    pub clean: Option<bool>,
 
     #[arg(long, default_value_t = false)]
     pub dry_run: bool,

src/config/mod.rs

@@ -145,7 +145,7 @@ impl Config {
             packages: None,
             profile: Some(profile_name.clone()),
             ignore_errors: false,
-            clean: false,
+            clean: Some(false),
             dry_run: false,
         };
         package.backup(ctx, &backup_args)?;
@@ -167,7 +167,7 @@ impl Config {
                     packages: Some(vec![pkg_name.clone()]),
                     profile: Some(profile_name),
                     ignore_errors: false,
-                    clean: false,
+                    clean: Some(false),
                     dry_run: false,
                 },
             )?;

src/package/mod.rs

@@ -43,6 +43,12 @@ pub struct Package {
     pub ignore: Vec<String>, // Patterns to ignore during deployment
     // Symlinks defaults to false
     pub symlink: bool,
+    #[serde(default = "default_clean")]
+    pub clean: bool,
+}
+
+fn default_clean() -> bool {
+    true
 }
 
 impl Default for Package {
@@ -60,6 +66,7 @@ impl Default for Package {
             prompts: HashMap::new(),
             ignore: Vec::new(),
             symlink: false,
+            clean: true,
         }
     }
 }
@@ -86,6 +93,7 @@ impl Package {
             prompts: HashMap::new(),
             ignore: Vec::new(),
             symlink: false,
+            clean: true,
         }
     }
 
@@ -147,6 +155,10 @@ impl Package {
             .get("symlink")
             .and_then(|v| v.as_bool())
             .unwrap_or(false);
+        let clean = pkg_val
+            .get("clean")
+            .and_then(|v| v.as_bool())
+            .unwrap_or(true);
 
         Ok(Self {
             name: pkg_name.to_string(),
@@ -161,6 +173,7 @@ impl Package {
             prompts,
             ignore,
             symlink,
+            clean,
         })
     }
 
@@ -210,6 +223,9 @@ impl Package {
         if self.symlink {
             pkg_table.insert("symlink".to_string(), toml::Value::Boolean(true));
         }
+        if !self.clean {
+            pkg_table.insert("clean".to_string(), toml::Value::Boolean(false));
+        }
         pkg_table
     }
 
@@ -318,7 +334,7 @@ impl Package {
                     all_copied_paths.push(dest_path);
                 }
             }
-            if args.clean {
+            if self.should_clean(args.clean) {
                 // Remove any files in copy_to that were not copied in this operation
                 clean(&copy_to, &all_copied_paths, &self.ignore, args.dry_run)?;
             }
@@ -328,6 +344,13 @@ impl Package {
         Ok(BackupDeployResult::Success)
     }
 
+    pub fn should_clean(&self, arg_val: Option<bool>) -> bool {
+        match arg_val {
+            Some(v) => v,
+            None => self.clean,
+        }
+    }
+
     pub fn resolve_dest(&self, ctx: &Context) -> anyhow::Result<PathBuf> {
         let mut dest = match self.targets.get(ctx.profile.name.as_str()) {
             Some(d) => d.clone(),
@@ -515,7 +538,7 @@ impl Package {
                 }
                 all_deployed_paths.push(dest_path);
             }
-            if args.clean {
+            if self.should_clean(args.clean) {
                 // Remove any files in copy_to that were not deployed in this operation
                 clean(&copy_to, &all_deployed_paths, &self.ignore, args.dry_run)?;
             }
@@ -699,6 +722,11 @@ pub fn clean(
     ignore: &[String],
     dry_run: bool,
 ) -> anyhow::Result<()> {
+    // If the operation path doesn't exist, there's nothing to clean
+    if !operation_path.exists() {
+        return Ok(());
+    }
+
     let mut dirs = vec![];
     for entry in walkdir::WalkDir::new(operation_path) {
         let entry = entry?;

tests/actions_tests.rs

@@ -46,7 +46,7 @@ impl TestFixture {
                 packages,
                 profile: None,
                 ignore_errors: false,
-                clean: false,
+                clean: Some(false),
                 dry_run: false,
             }))),
         )
@@ -587,7 +587,7 @@ fn test_pre_action_failure() {
             packages: Some(vec!["f_pre_fail".to_string()]),
             profile: None,
             ignore_errors: false,
-            clean: false,
+            clean: Some(false),
             dry_run: false,
         }))),
     );
@@ -641,7 +641,7 @@ fn test_post_action_failure() {
             packages: Some(vec!["f_post_fail".to_string()]),
             profile: None,
             ignore_errors: false,
-            clean: false,
+            clean: Some(false),
             dry_run: false,
         }))),
     );
@@ -677,7 +677,7 @@ fn test_action_with_nonexistent_command() {
             packages: Some(vec!["f_bad_cmd".to_string()]),
             profile: None,
             ignore_errors: false,
-            clean: false,
+            clean: Some(false),
             dry_run: false,
         }))),
     );
@@ -716,7 +716,7 @@ fn test_action_failure_with_error_message() {
             packages: Some(vec!["f_err_msg".to_string()]),
             profile: None,
             ignore_errors: false,
-            clean: false,
+            clean: Some(false),
             dry_run: false,
         }))),
     );