refactor(oxfmt): Use custom ignore builder (#14850)

Preparation for #14836

Author: leaysgur

apps/oxfmt/src/walk.rs

@@ -3,7 +3,7 @@ use std::{
     sync::mpsc,
 };
 
-use ignore::overrides::OverrideBuilder;
+use ignore::{gitignore::GitignoreBuilder, overrides::OverrideBuilder};
 
 use oxc_formatter::get_supported_source_type;
 use oxc_span::SourceType;
@@ -33,6 +33,9 @@ impl Walk {
             }
         }
 
+        // NOTE: We are using `OverrideBuilder` only for exclusion.
+        // This means there is no way to "re-include" a file once ignored.
+
         // Treat all `!` prefixed patterns as overrides to exclude
         if !exclude_patterns.is_empty() {
             let mut builder = OverrideBuilder::new(cwd);
@@ -46,11 +49,15 @@ impl Walk {
         }
 
         // Handle ignore files
-        for ignore_path in load_ignore_paths(cwd, ignore_paths) {
-            if inner.add_ignore(&ignore_path).is_some() {
+        let mut builder = GitignoreBuilder::new(cwd);
+        for ignore_path in &load_ignore_paths(cwd, ignore_paths) {
+            if builder.add(ignore_path).is_some() {
                 return Err(format!("Failed to add ignore file: {}", ignore_path.display()));
             }
         }
+        // TODO: Support config.ignorePatterns
+        // Use `builder.add_line(None, pattern_str)` here
+        let ignores = builder.build().map_err(|_| "Failed to build ignores".to_string())?;
 
         // NOTE: If return `false` here, it will not be `visit()`ed at all
         inner.filter_entry(move |entry| {
@@ -59,7 +66,9 @@ impl Walk {
                 return false;
             };
 
-            if file_type.is_dir() {
+            let is_dir = file_type.is_dir();
+
+            if is_dir {
                 // We are setting `.hidden(false)` on the `WalkBuilder` below,
                 // it means we want to include hidden files and directories.
                 // However, we (and also Prettier) still skip traversing certain directories.
@@ -78,6 +87,12 @@ impl Walk {
                 }
             }
 
+            // Check ignore files, patterns
+            let matched = ignores.matched(entry.path(), is_dir);
+            if matched.is_ignore() && !matched.is_whitelist() {
+                return false;
+            }
+
             // NOTE: We can also check `get_supported_source_type()` here to skip.
             // But we want to pass parsed `SourceType` to `FormatService`,
             // so we do it later in the visitor instead.

apps/oxfmt/tests/fixtures/ignore_and_override/ignore1

@@ -0,0 +1,2 @@
+should_ignore
+should_format/*

apps/oxfmt/tests/fixtures/ignore_and_override/ignore2

@@ -0,0 +1,3 @@
+should_ignore
+should_format/*
+!should_format/ok.js

apps/oxfmt/tests/fixtures/ignore_and_override/should_format/ok.js

@@ -0,0 +1 @@
+const a=1

apps/oxfmt/tests/fixtures/ignore_and_override/should_ignore/err.js

@@ -0,0 +1 @@
+class {

apps/oxfmt/tests/mod.rs

@@ -182,3 +182,22 @@ fn ignore_patterns() {
             ],
         );
 }
+
+#[test]
+fn ignore_and_override() {
+    Tester::new()
+        .with_cwd(PathBuf::from("tests/fixtures/ignore_and_override"))
+        .test_and_snapshot_multiple(
+            "ignore_and_override",
+            &[
+                // Ignore err.js
+                &["--check", "!**/err.js"],
+                // Ignore every files
+                &["--check", "--ignore-path", "ignore1"],
+                // Override ignore for should_format/ok.js
+                &["--check", "--ignore-path", "ignore1", "should_format/ok.js"],
+                // ! prefixed line for should_format/ok.js
+                &["--check", "--ignore-path", "ignore2"],
+            ],
+        );
+}

apps/oxfmt/tests/snapshots/ignore_and_override@oxfmt.snap

@@ -0,0 +1,52 @@
+---
+source: apps/oxfmt/tests/tester.rs
+---
+########## 
+arguments: --check !**/err.js
+working directory: tests/fixtures/ignore_and_override
+----------
+Checking formatting...
+should_format/ok.js (<variable>ms)
+
+Format issues found in above 1 files. Run without `--check` to fix.
+Finished in <variable>ms on 1 files using 1 threads.
+----------
+CLI result: FormatMismatch
+----------
+
+########## 
+arguments: --check --ignore-path ignore1
+working directory: tests/fixtures/ignore_and_override
+----------
+Checking formatting...
+
+Expected at least one target file
+----------
+CLI result: NoFilesFound
+----------
+
+########## 
+arguments: --check --ignore-path ignore1 should_format/ok.js
+working directory: tests/fixtures/ignore_and_override
+----------
+Checking formatting...
+should_format/ok.js (<variable>ms)
+
+Format issues found in above 1 files. Run without `--check` to fix.
+Finished in <variable>ms on 1 files using 1 threads.
+----------
+CLI result: FormatMismatch
+----------
+
+########## 
+arguments: --check --ignore-path ignore2
+working directory: tests/fixtures/ignore_and_override
+----------
+Checking formatting...
+should_format/ok.js (<variable>ms)
+
+Format issues found in above 1 files. Run without `--check` to fix.
+Finished in <variable>ms on 1 files using 1 threads.
+----------
+CLI result: FormatMismatch
+----------