Merge pull request #12 from jprochazk/master

Add option to filter files using glob patterns

Cargo.toml

@@ -15,4 +15,6 @@ lscolors = { version = "0.13.0", features = ["ansi_term"] }
 once_cell = "1.17.0"
 
 [dev-dependencies]
+indoc = "2.0.0"
+strip-ansi-escapes = "0.1.1"
 tempdir = "0.3"

README.md

@@ -29,6 +29,9 @@ Options:
   -n, --num-threads <NUM_THREADS>  Number of threads to use [default: 4]
   -o, --order <ORDER>              Sort order to display directory content [default: none] [possible values: filename, size, none]
   -s, --show-hidden                Whether to show hidden files; disabled by default
+  -g, --glob <GLOB>                Include or exclude files using glob patterns
+      --iglob <GLOB>               Include or exclude files using glob patterns; case insensitive
+      --glob-case-insensitive      Process all glob patterns case insensitively
   -h, --help                       Print help (see more with '--help')
   -V, --version                    Print version
 

src/cli.rs

@@ -1,8 +1,13 @@
 use crate::fs::erdtree::order::Order;
 use clap::Parser;
-use ignore::{WalkBuilder, WalkParallel};
+use ignore::{
+    overrides::{Override, OverrideBuilder},
+    WalkBuilder, WalkParallel,
+};
 use std::{
     convert::From,
+    error::Error as StdError,
+    fmt::{self, Display, Formatter},
     path::{Path, PathBuf},
     usize,
 };
@@ -36,6 +41,18 @@ pub struct Clargs {
     /// Whether to show hidden files; disabled by default
     #[arg(short, long)]
     pub show_hidden: bool,
+
+    /// Include or exclude files using glob patterns
+    #[arg(short, long)]
+    glob: Vec<String>,
+
+    /// Include or exclude files using glob patterns; case insensitive
+    #[arg(long)]
+    iglob: Vec<String>,
+
+    /// Process all glob patterns case insensitively
+    #[arg(long)]
+    glob_case_insensitive: bool,
 }
 
 impl Clargs {
@@ -58,15 +75,64 @@ impl Clargs {
     pub fn max_depth(&self) -> Option<usize> {
         self.max_depth
     }
+
+    /// Ignore file overrides.
+    pub fn overrides(&self) -> Result<Override, ignore::Error> {
+        if self.glob.is_empty() && self.iglob.is_empty() {
+            return Ok(Override::empty());
+        }
+
+        let mut builder = OverrideBuilder::new(self.dir());
+        if self.glob_case_insensitive {
+            builder.case_insensitive(true).unwrap();
+        }
+
+        for glob in self.glob.iter() {
+            builder.add(glob)?;
+        }
+
+        // all subsequent patterns are case insensitive
+        builder.case_insensitive(true).unwrap();
+        for glob in self.iglob.iter() {
+            builder.add(glob)?;
+        }
+
+        builder.build()
+    }
 }
 
-impl From<&Clargs> for WalkParallel {
-    fn from(clargs: &Clargs) -> WalkParallel {
-        WalkBuilder::new(clargs.dir())
+impl TryFrom<&Clargs> for WalkParallel {
+    type Error = Error;
+
+    fn try_from(clargs: &Clargs) -> Result<Self, Self::Error> {
+        Ok(WalkBuilder::new(clargs.dir())
             .follow_links(false)
+            .overrides(clargs.overrides()?)
             .git_ignore(!clargs.ignore_git_ignore)
             .hidden(!clargs.show_hidden)
             .threads(clargs.num_threads)
-            .build_parallel()
+            .build_parallel())
+    }
+}
+
+/// Errors which may occur during command-line argument parsing.
+#[derive(Debug)]
+pub enum Error {
+    InvalidGlobPatterns(ignore::Error),
+}
+
+impl Display for Error {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        match self {
+            Error::InvalidGlobPatterns(e) => write!(f, "Invalid glob patterns: {e}"),
+        }
+    }
+}
+
+impl StdError for Error {}
+
+impl From<ignore::Error> for Error {
+    fn from(value: ignore::Error) -> Self {
+        Self::InvalidGlobPatterns(value)
     }
 }

src/main.rs

@@ -1,3 +1,5 @@
+use std::process::ExitCode;
+
 use clap::Parser;
 use cli::Clargs;
 use fs::erdtree::{self, tree::Tree};
@@ -9,10 +11,19 @@ mod cli;
 /// Filesystem operations.
 mod fs;
 
-fn main() -> Result<(), fs::error::Error> {
+fn main() -> ExitCode {
+    if let Err(e) = run() {
+        eprintln!("{e}");
+        return ExitCode::FAILURE;
+    }
+
+    ExitCode::SUCCESS
+}
+
+fn run() -> Result<(), Box<dyn std::error::Error>> {
     erdtree::init_ls_colors();
     let clargs = Clargs::parse();
-    let walker = WalkParallel::from(&clargs);
+    let walker = WalkParallel::try_from(&clargs)?;
     let tree = Tree::new(walker, clargs.order(), clargs.max_depth())?;
 
     println!("{tree}");

tests/data/a.txt

@@ -0,0 +1 @@
+asdf

tests/data/b.txt

@@ -0,0 +1 @@
+bvcx

tests/data/c.md

@@ -0,0 +1 @@
+# File

tests/data/nested/other.md

@@ -0,0 +1 @@
+# Nested file

tests/glob.rs

@@ -0,0 +1,89 @@
+use indoc::indoc;
+use std::process::Command;
+use std::process::Stdio;
+use strip_ansi_escapes::strip as strip_ansi_escapes;
+
+fn run_cmd(args: &[&str]) -> String {
+    let mut cmd = Command::new("cargo");
+    cmd.arg("run")
+        .arg("--")
+        .arg("tests/data")
+        .arg("--num-threads")
+        .arg("1")
+        .arg("--order")
+        .arg("filename");
+
+    for arg in args {
+        cmd.arg(arg);
+    }
+
+    let output = cmd
+        .stdout(Stdio::piped())
+        .stderr(Stdio::piped())
+        .spawn()
+        .unwrap()
+        .wait_with_output()
+        .unwrap();
+    assert!(output.status.success());
+
+    String::from_utf8(strip_ansi_escapes(output.stdout).unwrap())
+        .unwrap()
+        .trim()
+        .to_string()
+}
+
+#[test]
+fn glob() {
+    assert_eq!(
+        run_cmd(&["--glob", "*.txt"]),
+        indoc!(
+            "
+            data (10.00 B)
+            ├─ a.txt (5.00 B)
+            ├─ b.txt (5.00 B)
+            └─ nested"
+        )
+    )
+}
+
+#[test]
+fn glob_negative() {
+    assert_eq!(
+        run_cmd(&["--glob", "!*.txt"]),
+        indoc!(
+            "
+            data (21.00 B)
+            ├─ c.md (7.00 B)
+            └─ nested (14.00 B)
+               └─ other.md (14.00 B)"
+        )
+    )
+}
+
+#[test]
+fn glob_case_insensitive() {
+    assert_eq!(
+        run_cmd(&["--glob", "*.TXT", "--glob-case-insensitive"]),
+        indoc!(
+            "
+            data (10.00 B)
+            ├─ a.txt (5.00 B)
+            ├─ b.txt (5.00 B)
+            └─ nested"
+        )
+    )
+}
+
+#[test]
+fn iglob() {
+    assert_eq!(
+        run_cmd(&["--iglob", "*.TXT"]),
+        indoc!(
+            "
+            data (10.00 B)
+            ├─ a.txt (5.00 B)
+            ├─ b.txt (5.00 B)
+            └─ nested"
+        )
+    )
+}