feat(linter): introduce ExternalLinter struct

Author: camc314

Cargo.lock

@@ -10,14 +10,16 @@ pub mod cli {
     pub use crate::{command::*, lint::LintRunner, result::CliRunResult, runner::Runner};
 }
 
+pub use oxc_linter::{ExternalLinter, ExternalLinterCb, ExternalLinterLoadPluginCb};
+
 #[cfg(all(feature = "allocator", not(miri), not(target_family = "wasm")))]
 #[global_allocator]
 static GLOBAL: mimalloc_safe::MiMalloc = mimalloc_safe::MiMalloc;
 
 use cli::{CliRunResult, LintRunner, Runner};
 use std::{ffi::OsStr, io::BufWriter};
 
-pub fn lint() -> CliRunResult {
+pub fn lint(external_linter: Option<ExternalLinter>) -> CliRunResult {
     init_tracing();
     init_miette();
 
@@ -49,7 +51,7 @@ pub fn lint() -> CliRunResult {
     // See `https://github.com/rust-lang/rust/issues/60673`.
     let mut stdout = BufWriter::new(std::io::stdout());
 
-    LintRunner::new(command).run(&mut stdout)
+    LintRunner::new(command, external_linter).run(&mut stdout)
 }
 
 // Initialize the data which relies on `is_atty` system calls so they don't block subsequent threads.

apps/oxlint/src/lib.rs

@@ -13,8 +13,8 @@ use ignore::{gitignore::Gitignore, overrides::OverrideBuilder};
 use oxc_allocator::AllocatorPool;
 use oxc_diagnostics::{DiagnosticService, GraphicalReportHandler, OxcDiagnostic};
 use oxc_linter::{
-    AllowWarnDeny, Config, ConfigStore, ConfigStoreBuilder, InvalidFilterKind, LintFilter,
-    LintOptions, LintService, LintServiceOptions, Linter, Oxlintrc,
+    AllowWarnDeny, Config, ConfigStore, ConfigStoreBuilder, ExternalLinter, InvalidFilterKind,
+    LintFilter, LintOptions, LintService, LintServiceOptions, Linter, Oxlintrc,
 };
 use rustc_hash::{FxHashMap, FxHashSet};
 use serde_json::Value;
@@ -29,13 +29,18 @@ use crate::{
 pub struct LintRunner {
     options: LintCommand,
     cwd: PathBuf,
+    external_linter: Option<ExternalLinter>,
 }
 
 impl Runner for LintRunner {
     type Options = LintCommand;
 
-    fn new(options: Self::Options) -> Self {
-        Self { options, cwd: env::current_dir().expect("Failed to get current working directory") }
+    fn new(options: Self::Options, external_linter: Option<ExternalLinter>) -> Self {
+        Self {
+            options,
+            cwd: env::current_dir().expect("Failed to get current working directory"),
+            external_linter,
+        }
     }
 
     fn run(self, stdout: &mut dyn Write) -> CliRunResult {
@@ -63,6 +68,8 @@ impl Runner for LintRunner {
             ..
         } = self.options;
 
+        let external_linter = self.external_linter.as_ref();
+
         let search_for_nested_configs = !disable_nested_config &&
             // If the `--config` option is explicitly passed, we should not search for nested config files
             // as the passed config file takes absolute precedence.
@@ -173,7 +180,7 @@ impl Runner for LintRunner {
         let handler = GraphicalReportHandler::new();
 
         let nested_configs = if search_for_nested_configs {
-            match Self::get_nested_configs(stdout, &handler, &filters, &paths) {
+            match Self::get_nested_configs(stdout, &handler, &filters, &paths, external_linter) {
                 Ok(v) => v,
                 Err(v) => return v,
             }
@@ -192,20 +199,21 @@ impl Runner for LintRunner {
         } else {
             None
         };
-        let config_builder = match ConfigStoreBuilder::from_oxlintrc(false, oxlintrc) {
-            Ok(builder) => builder,
-            Err(e) => {
-                print_and_flush_stdout(
-                    stdout,
-                    &format!(
-                        "Failed to parse configuration file.\n{}\n",
-                        render_report(&handler, &OxcDiagnostic::error(e.to_string()))
-                    ),
-                );
-                return CliRunResult::InvalidOptionConfig;
+        let config_builder =
+            match ConfigStoreBuilder::from_oxlintrc(false, oxlintrc, external_linter) {
+                Ok(builder) => builder,
+                Err(e) => {
+                    print_and_flush_stdout(
+                        stdout,
+                        &format!(
+                            "Failed to parse configuration file.\n{}\n",
+                            render_report(&handler, &OxcDiagnostic::error(e.to_string()))
+                        ),
+                    );
+                    return CliRunResult::InvalidOptionConfig;
+                }
             }
-        }
-        .with_filters(&filters);
+            .with_filters(&filters);
 
         if let Some(basic_config_file) = oxlintrc_for_print {
             let config_file = config_builder.resolve_final_config_file(basic_config_file);
@@ -387,6 +395,7 @@ impl LintRunner {
         handler: &GraphicalReportHandler,
         filters: &Vec<LintFilter>,
         paths: &Vec<Arc<OsStr>>,
+        external_linter: Option<&ExternalLinter>,
     ) -> Result<FxHashMap<PathBuf, Config>, CliRunResult> {
         // TODO(perf): benchmark whether or not it is worth it to store the configurations on a
         // per-file or per-directory basis, to avoid calling `.parent()` on every path.
@@ -417,7 +426,8 @@ impl LintRunner {
         // iterate over each config and build the ConfigStore
         for (dir, oxlintrc) in nested_oxlintrc {
             // TODO(refactor): clean up all of the error handling in this function
-            let builder = match ConfigStoreBuilder::from_oxlintrc(false, oxlintrc) {
+            let builder = match ConfigStoreBuilder::from_oxlintrc(false, oxlintrc, external_linter)
+            {
                 Ok(builder) => builder,
                 Err(e) => {
                     print_and_flush_stdout(

apps/oxlint/src/lint.rs

@@ -1,5 +1,5 @@
 use oxlint::{cli::CliRunResult, lint};
 
 fn main() -> CliRunResult {
-    lint()
+    lint(None)
 }

apps/oxlint/src/main.rs

@@ -1,12 +1,14 @@
 use std::io::Write;
 
+use oxc_linter::ExternalLinter;
+
 use crate::cli::CliRunResult;
 
 /// A trait for exposing functionality to the CLI.
 pub trait Runner {
     type Options;
 
-    fn new(matches: Self::Options) -> Self;
+    fn new(matches: Self::Options, external_linter: Option<ExternalLinter>) -> Self;
 
     /// Executes the runner, providing some result to the CLI.
     fn run(self, stdout: &mut dyn Write) -> CliRunResult;

apps/oxlint/src/runner.rs

@@ -37,7 +37,7 @@ impl Tester {
 
         let options = lint_command().run_inner(new_args.as_slice()).unwrap();
         let mut output = Vec::new();
-        let _ = LintRunner::new(options).with_cwd(self.cwd.clone()).run(&mut output);
+        let _ = LintRunner::new(options, None).with_cwd(self.cwd.clone()).run(&mut output);
     }
 
     pub fn test_and_snapshot(&self, args: &[&str]) {
@@ -59,7 +59,7 @@ impl Tester {
                 format!("working directory: {}\n", relative_dir.to_str().unwrap()).as_bytes(),
             );
             output.extend_from_slice(b"----------\n");
-            let result = LintRunner::new(options).with_cwd(self.cwd.clone()).run(&mut output);
+            let result = LintRunner::new(options, None).with_cwd(self.cwd.clone()).run(&mut output);
 
             output.extend_from_slice(b"----------\n");
             output.extend_from_slice(format!("CLI result: {result:?}\n").as_bytes());

apps/oxlint/src/tester.rs

@@ -54,7 +54,7 @@ impl ServerLinter {
 
         // clone because we are returning it for ignore builder
         let config_builder =
-            ConfigStoreBuilder::from_oxlintrc(false, oxlintrc.clone()).unwrap_or_default();
+            ConfigStoreBuilder::from_oxlintrc(false, oxlintrc.clone(), None).unwrap_or_default();
 
         // TODO(refactor): pull this into a shared function, because in oxlint we have the same functionality.
         let use_nested_config = options.use_nested_configs();
@@ -131,7 +131,7 @@ impl ServerLinter {
                 warn!("Skipping invalid config file: {}", file_path.display());
                 continue;
             };
-            let Ok(config_store_builder) = ConfigStoreBuilder::from_oxlintrc(false, oxlintrc)
+            let Ok(config_store_builder) = ConfigStoreBuilder::from_oxlintrc(false, oxlintrc, None)
             else {
                 warn!("Skipping config (builder failed): {}", file_path.display());
                 continue;

crates/oxc_language_server/src/linter/server_linter.rs

@@ -57,6 +57,8 @@ language-tags = { workspace = true }
 lazy-regex = { workspace = true }
 lazy_static = { workspace = true }
 memchr = { workspace = true }
+napi = { workspace = true }
+napi-derive = { workspace = true }
 nonmax = { workspace = true }
 phf = { workspace = true, features = ["macros"] }
 rayon = { workspace = true }

crates/oxc_linter/Cargo.toml

@@ -11,6 +11,7 @@ use oxc_span::{CompactStr, format_compact_str};
 use crate::{
     AllowWarnDeny, LintConfig, LintFilter, LintFilterKind, Oxlintrc, RuleCategory, RuleEnum,
     config::{ESLintRule, LintPlugins, OxlintOverrides, OxlintRules, overrides::OxlintOverride},
+    external_linter::ExternalLinter,
     rules::RULES,
 };
 
@@ -83,6 +84,7 @@ impl ConfigStoreBuilder {
     pub fn from_oxlintrc(
         start_empty: bool,
         oxlintrc: Oxlintrc,
+        _external_linter: Option<&ExternalLinter>,
     ) -> Result<Self, ConfigBuilderError> {
         // TODO: this can be cached to avoid re-computing the same oxlintrc
         fn resolve_oxlintrc_config(
@@ -375,7 +377,7 @@ impl TryFrom<Oxlintrc> for ConfigStoreBuilder {
 
     #[inline]
     fn try_from(oxlintrc: Oxlintrc) -> Result<Self, Self::Error> {
-        Self::from_oxlintrc(false, oxlintrc)
+        Self::from_oxlintrc(false, oxlintrc, None)
     }
 }
 
@@ -640,7 +642,7 @@ mod test {
         "#,
         )
         .unwrap();
-        let builder = ConfigStoreBuilder::from_oxlintrc(false, oxlintrc).unwrap();
+        let builder = ConfigStoreBuilder::from_oxlintrc(false, oxlintrc, None).unwrap();
         for (rule, severity) in &builder.rules {
             let name = rule.name();
             let plugin = rule.plugin_name();
@@ -815,6 +817,7 @@ mod test {
                 "fixtures/extends_config/extends_invalid_config.json",
             ))
             .unwrap(),
+            None,
         );
         let err = invalid_config.unwrap_err();
         assert!(matches!(err, ConfigBuilderError::InvalidConfigFile { .. }));
@@ -943,12 +946,18 @@ mod test {
     }
 
     fn config_store_from_path(path: &str) -> Config {
-        ConfigStoreBuilder::from_oxlintrc(true, Oxlintrc::from_file(&PathBuf::from(path)).unwrap())
-            .unwrap()
-            .build()
+        ConfigStoreBuilder::from_oxlintrc(
+            true,
+            Oxlintrc::from_file(&PathBuf::from(path)).unwrap(),
+            None,
+        )
+        .unwrap()
+        .build()
     }
 
     fn config_store_from_str(s: &str) -> Config {
-        ConfigStoreBuilder::from_oxlintrc(true, serde_json::from_str(s).unwrap()).unwrap().build()
+        ConfigStoreBuilder::from_oxlintrc(true, serde_json::from_str(s).unwrap(), None)
+            .unwrap()
+            .build()
     }
 }

crates/oxc_linter/src/config/config_builder.rs

@@ -0,0 +1,37 @@
+use std::{fmt::Debug, sync::Arc};
+
+use napi::{Status, bindgen_prelude::Promise, threadsafe_function::ThreadsafeFunction};
+use napi_derive::napi;
+
+#[napi]
+pub type ExternalLinterCb =
+    Arc<ThreadsafeFunction<(), /* TODO: correct return type */ (), (), Status, false>>;
+
+#[napi]
+pub type ExternalLinterLoadPluginCb =
+    Arc<ThreadsafeFunction<String, Promise<PluginLoadResult>, String, Status, false>>;
+
+#[napi]
+pub enum PluginLoadResult {
+    Success,
+    Failure(String),
+}
+
+#[derive(Clone)]
+#[expect(dead_code)]
+pub struct ExternalLinter {
+    pub(crate) load_plugin: ExternalLinterLoadPluginCb,
+    pub(crate) run: ExternalLinterCb,
+}
+
+impl ExternalLinter {
+    pub fn new(run: ExternalLinterCb, load_plugin: ExternalLinterLoadPluginCb) -> Self {
+        ExternalLinter { load_plugin, run }
+    }
+}
+
+impl Debug for ExternalLinter {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("ExternalLinter").finish()
+    }
+}