Merge pull request #210 from noahbald/feat/181-update-hidden-file-handling

feat: #181 create separate `hidden` and `no-ignore` cli flags

Author: noahbald

crates/oxvg/src/commands/format.rs

@@ -32,9 +32,19 @@ pub struct Format {
     /// If the path is a directory, whether to walk through and optimise its subdirectories
     #[clap(long, short, default_value = "false")]
     pub recursive: bool,
-    /// Search through hidden files and directories
+    /// Search through hidden files and directories.
+    ///
+    /// A file or directory is considered hidden if its base name starts with a '.' or if the operating
+    /// system provides a "hidden" file attribute.
+    ///
+    /// Ignored files will continue to be skipped and can be enabled with the `--no-ignore` flag.
     #[clap(long, short = '.', default_value = "false")]
     pub hidden: bool,
+    /// When set, patterns defined in files such as `.gitigore` will be disregarded.
+    ///
+    /// Hidden files will continue to be skipped and can be enabled with the `--hidden` flag.
+    #[clap(long, default_value = "false")]
+    pub no_ignore: bool,
     /// Sets the approximate number of threads to use. A value of 0 (default) will automatically determine the appropriate number
     #[clap(long, short, default_value = "0")]
     pub threads: usize,
@@ -53,6 +63,7 @@ impl RunCommand for Format {
             output: self.output.as_ref().and_then(|output| output.first()),
             recursive: self.recursive,
             hidden: self.hidden,
+            no_ignore: self.no_ignore,
             threads: self.threads,
         };
         let error = Arc::new(AtomicBool::new(false));

crates/oxvg/src/commands/lint.rs

@@ -18,9 +18,19 @@ pub struct Check {
     /// If the path is a directory, whether to walk through and optimise its subdirectories
     #[clap(long, short, default_value = "false")]
     pub recursive: bool,
-    /// Search through hidden files and directories
+    /// Search through hidden files and directories.
+    ///
+    /// A file or directory is considered hidden if its base name starts with a '.' or if the operating
+    /// system provides a "hidden" file attribute.
+    ///
+    /// Ignored files will continue to be skipped and can be enabled with the `--no-ignore` flag.
     #[clap(long, short = '.', default_value = "false")]
     pub hidden: bool,
+    /// When set, patterns defined in files such as `.gitigore` will be disregarded.
+    ///
+    /// Hidden files will continue to be skipped and can be enabled with the `--hidden` flag.
+    #[clap(long, default_value = "false")]
+    pub no_ignore: bool,
     /// Sets the approximate number of threads to use. A value of 0 (default) will automatically determine the appropriate number
     #[clap(long, short, default_value = "0")]
     pub threads: usize,
@@ -40,6 +50,7 @@ impl Check {
             output: None,
             recursive: self.recursive,
             hidden: self.hidden,
+            no_ignore: self.no_ignore,
             threads: self.threads,
         };
         walk.run(|| {

crates/oxvg/src/commands/optimise.rs

@@ -33,9 +33,19 @@ pub struct Optimise {
     /// If the path is a directory, whether to walk through and optimise its subdirectories
     #[clap(long, short, default_value = "false")]
     pub recursive: bool,
-    /// Search through hidden files and directories
+    /// Search through hidden files and directories.
+    ///
+    /// A file or directory is considered hidden if its base name starts with a '.' or if the operating
+    /// system provides a "hidden" file attribute.
+    ///
+    /// Ignored files will continue to be skipped and can be enabled with the `--no-ignore` flag.
     #[clap(long, short = '.', default_value = "false")]
     pub hidden: bool,
+    /// When set, patterns defined in files such as `.gitigore` will be disregarded.
+    ///
+    /// Hidden files will continue to be skipped and can be enabled with the `--hidden` flag.
+    #[clap(long, default_value = "false")]
+    pub no_ignore: bool,
     /// Sets the approximate number of threads to use. A value of 0 (default) will automatically determine the appropriate number
     #[clap(long, short, default_value = "0")]
     pub threads: usize,
@@ -80,6 +90,7 @@ impl Optimise {
             output: self.output.as_ref().and_then(|output| output.first()),
             recursive: self.recursive,
             hidden: self.hidden,
+            no_ignore: self.no_ignore,
             threads: self.threads,
         };
         walk.run(move || {

crates/oxvg/src/walk.rs

@@ -23,6 +23,8 @@ pub struct Walk<'a> {
     pub recursive: bool,
     /// Whether to search through hidden files and directories
     pub hidden: bool,
+    /// Whether to disregard ignore patterns
+    pub no_ignore: bool,
     /// Sets the approximate number of threads to use. A value of 0 will
     /// automatically determine the appropriate number
     pub threads: usize,
@@ -114,11 +116,12 @@ impl Walk<'_> {
                 })
             })
         };
+        dbg!(&self.no_ignore);
         WalkBuilder::new(path)
             .max_depth(if self.recursive { None } else { Some(1) })
             .hidden(!self.hidden)
-            .git_ignore(!self.hidden)
-            .ignore(!self.hidden)
+            .git_ignore(!self.no_ignore)
+            .ignore(!self.no_ignore)
             .follow_links(true)
             .threads(self.threads)
             .build_parallel()