reactor(linter): move Walk from oxlint to oxc_linter with own options struct

Author: Sysix

Cargo.lock

@@ -4,7 +4,6 @@ mod output_formatter;
 mod result;
 mod runner;
 mod tester;
-mod walk;
 
 pub mod cli {
 

apps/oxlint/src/lib.rs

@@ -12,16 +12,15 @@ use cow_utils::CowUtils;
 use ignore::{gitignore::Gitignore, overrides::OverrideBuilder};
 use oxc_diagnostics::{DiagnosticService, GraphicalReportHandler, OxcDiagnostic};
 use oxc_linter::{
-    AllowWarnDeny, Config, ConfigStore, ConfigStoreBuilder, InvalidFilterKind, LintFilter,
-    LintOptions, LintService, LintServiceOptions, Linter, Oxlintrc,
+    AllowWarnDeny, Config, ConfigStore, ConfigStoreBuilder, FileWalker, FileWalkerOptions,
+    InvalidFilterKind, LintFilter, LintOptions, LintService, LintServiceOptions, Linter, Oxlintrc,
 };
 use rustc_hash::{FxHashMap, FxHashSet};
 use serde_json::Value;
 
 use crate::{
     cli::{CliRunResult, LintCommand, MiscOptions, ReportUnusedDirectives, Runner, WarningOptions},
     output_formatter::{LintCommandInfo, OutputFormatter},
-    walk::Walk,
 };
 
 #[derive(Debug)]
@@ -165,7 +164,15 @@ impl Runner for LintRunner {
             paths.push(self.cwd.clone());
         }
 
-        let walker = Walk::new(&paths, &ignore_options, override_builder);
+        let walker = FileWalker::new(
+            &paths,
+            &FileWalkerOptions {
+                no_ignore: ignore_options.no_ignore,
+                ignore_path: ignore_options.ignore_path.clone(),
+                symlinks: ignore_options.symlinks,
+            },
+            override_builder,
+        );
         let paths = walker.paths();
         let number_of_files = paths.len();
 

apps/oxlint/src/lint.rs

@@ -49,6 +49,7 @@ convert_case = { workspace = true }
 cow-utils = { workspace = true }
 fast-glob = { workspace = true }
 globset = { workspace = true }
+ignore = { workspace = true, features = ["simd-accel"] }
 indexmap = { workspace = true, features = ["rayon"] }
 itertools = { workspace = true }
 javascript-globals = { workspace = true }

crates/oxc_linter/Cargo.toml

@@ -39,7 +39,7 @@ pub use crate::{
     options::LintOptions,
     options::{AllowWarnDeny, InvalidFilterKind, LintFilter, LintFilterKind},
     rule::{RuleCategory, RuleFixMeta, RuleMeta},
-    service::{LintService, LintServiceOptions, RuntimeFileSystem},
+    service::{FileWalker, FileWalkerOptions, LintService, LintServiceOptions, RuntimeFileSystem},
     utils::read_to_string,
 };
 use crate::{

apps/oxlint/fixtures/walk_dir/bar.vue renamed to crates/oxc_linter/fixtures/walk_dir/bar.vue

@@ -1,9 +1,12 @@
-use std::{ffi::OsStr, path::PathBuf, sync::Arc, sync::mpsc};
+use std::{
+    ffi::{OsStr, OsString},
+    path::PathBuf,
+    sync::{Arc, mpsc},
+};
 
 use ignore::{DirEntry, overrides::Override};
-use oxc_linter::LINTABLE_EXTENSIONS;
 
-use crate::cli::IgnoreOptions;
+use crate::LINTABLE_EXTENSIONS;
 
 #[derive(Clone)]
 pub struct Extensions(pub Vec<&'static str>);
@@ -14,7 +17,7 @@ impl Default for Extensions {
     }
 }
 
-pub struct Walk {
+pub struct FileWalker {
     inner: ignore::WalkParallel,
     /// The file extensions to include during the traversal.
     extensions: Extensions,
@@ -52,7 +55,7 @@ impl ignore::ParallelVisitor for WalkCollector {
     fn visit(&mut self, entry: Result<ignore::DirEntry, ignore::Error>) -> ignore::WalkState {
         match entry {
             Ok(entry) => {
-                if Walk::is_wanted_entry(&entry, &self.extensions) {
+                if FileWalker::is_wanted_entry(&entry, &self.extensions) {
                     self.paths.push(entry.path().as_os_str().into());
                 }
                 ignore::WalkState::Continue
@@ -61,22 +64,27 @@ impl ignore::ParallelVisitor for WalkCollector {
         }
     }
 }
-impl Walk {
+
+pub struct FileWalkerOptions {
+    pub no_ignore: bool,
+    pub symlinks: bool,
+    pub ignore_path: OsString,
+}
+
+impl FileWalker {
     /// Will not canonicalize paths.
     /// # Panics
     pub fn new(
         paths: &[PathBuf],
-        options: &IgnoreOptions,
+        options: &FileWalkerOptions,
         override_builder: Option<Override>,
     ) -> Self {
-        assert!(!paths.is_empty(), "At least one path must be provided to Walk::new");
+        assert!(!paths.is_empty(), "At least one path must be provided to FileWalker::new");
 
-        let mut inner = ignore::WalkBuilder::new(
-            paths
-                .iter()
-                .next()
-                .expect("Expected paths parameter to Walk::new() to contain at least one path."),
-        );
+        let mut inner =
+            ignore::WalkBuilder::new(paths.iter().next().expect(
+                "Expected paths parameter to FileWalker::new() to contain at least one path.",
+            ));
 
         if let Some(paths) = paths.get(1..) {
             for path in paths {
@@ -108,7 +116,8 @@ impl Walk {
         receiver.into_iter().flatten().collect()
     }
 
-    #[cfg_attr(not(test), expect(dead_code))]
+    #[cfg(test)]
+    #[must_use]
     pub fn with_extensions(mut self, extensions: Extensions) -> Self {
         self.extensions = extensions;
         self
@@ -133,25 +142,22 @@ impl Walk {
 mod test {
     use std::{env, ffi::OsString, path::Path};
 
+    use super::{Extensions, FileWalker, FileWalkerOptions};
     use ignore::overrides::OverrideBuilder;
 
-    use super::{Extensions, Walk};
-    use crate::cli::IgnoreOptions;
-
     #[test]
     fn test_walk_with_extensions() {
         let fixture = env::current_dir().unwrap().join("fixtures/walk_dir");
         let fixtures = vec![fixture.clone()];
-        let ignore_options = IgnoreOptions {
+        let ignore_options = FileWalkerOptions {
             no_ignore: false,
             ignore_path: OsString::from(".gitignore"),
-            ignore_pattern: vec![],
             symlinks: false,
         };
 
         let override_builder = OverrideBuilder::new("/").build().unwrap();
 
-        let mut paths = Walk::new(&fixtures, &ignore_options, Some(override_builder))
+        let mut paths = FileWalker::new(&fixtures, &ignore_options, Some(override_builder))
             .with_extensions(Extensions(["js", "vue"].to_vec()))
             .paths()
             .into_iter()

apps/oxlint/fixtures/walk_dir/foo.js renamed to crates/oxc_linter/fixtures/walk_dir/foo.js

@@ -4,12 +4,13 @@ use std::{
     sync::Arc,
 };
 
+use crate::Linter;
+pub use file_walker::{FileWalker, FileWalkerOptions};
 use oxc_diagnostics::DiagnosticSender;
 use runtime::Runtime;
 pub use runtime::RuntimeFileSystem;
 
-use crate::Linter;
-
+mod file_walker;
 mod runtime;
 
 #[cfg(feature = "language_server")]