feat: ignore files globally

Author: santikid

README.md

@@ -15,6 +15,9 @@ either be `all`, the wanted OS (`macos` | `linux`) or a custom command.
 Clink is configured in a `clink.yaml` file.
 
 ```yaml
+ignore:     # ignore file or folder names, applies to all directories and subdirectories
+  - .DS_Store
+
 features:
   - slug: all
     enabled: all # all, macos, linux or custom command

clink.example.yaml

@@ -1,3 +1,7 @@
+ignore: # optional
+  - ".git" # only needed if you have a submodule in your tree
+  - ".DS_Store"
+
 features:
   - slug: all
     target: ~/.config

src/link.rs

@@ -29,8 +29,8 @@ impl LinkGroup {
             sources: Vec::new(),
         }
     }
-    pub fn add_source(&mut self, source: &PathBuf) -> Result<(), Vec<PathBuf>> {
-        let source_files = get_all_paths(source);
+    pub fn add_source(&mut self, source: &PathBuf, ignore: &Vec<String>) -> Result<(), Vec<PathBuf>> {
+        let source_files = get_all_paths(source, ignore);
 
         let sources = source_files
             .iter()
@@ -139,9 +139,10 @@ impl LinkGroup {
         Ok(())
     }
 }
-pub fn get_all_paths(source: &Path) -> HashSet<PathBuf> {
+pub fn get_all_paths(source: &Path, ignore: &Vec<String>) -> HashSet<PathBuf> {
     walkdir::WalkDir::new(source)
         .into_iter()
+        .filter_entry(|e| !ignore.contains(&e.file_name().to_string_lossy().to_string()))
         .filter_map(|e| e.ok())
         .filter(|e| e.file_type().is_file())
         .map(|e| e.path().to_path_buf())

src/main.rs

@@ -9,6 +9,7 @@ mod link;
 
 #[derive(Debug, serde::Deserialize)]
 struct Config {
+    ignore: Option<Vec<String>>,
     features: feature::FeatureList,
 }
 
@@ -80,6 +81,8 @@ fn run(action: Action) {
             })
             .collect::<Vec<_>>();
 
+    let ignore = config.ignore.unwrap_or_default();
+
     // create LinkGroup for each target
     let target_links =
         source_features
@@ -108,7 +111,7 @@ fn run(action: Action) {
                 };
 
                 // add current directory to LinkGroup
-                match entry.add_source(source) {
+                match entry.add_source(source, &ignore) {
                     Err(e) => panic!("conflicts in target {:?}: {:?}", target, e),
                     Ok(_) => acc,
                 }