feat(linter): introduce maxWarnings config option (#19777)

camc314 · camc314 · commit a60711957ea4 · 2026-03-02T12:26:56.000Z
diff --git a/apps/oxlint/fixtures/linter/config-max-warnings.json b/apps/oxlint/fixtures/linter/config-max-warnings.json
@@ -0,0 +1,8 @@
+{
+  "rules": {
+    "no-debugger": "warn"
+  },
+  "options": {
+    "maxWarnings": 0
+  }
+}
diff --git a/apps/oxlint/src-js/package/config.generated.ts b/apps/oxlint/src-js/package/config.generated.ts
@@ -324,6 +324,12 @@ export interface OxlintOptions {
    * Equivalent to passing `--type-check` on the CLI.
    */
   typeCheck?: boolean | null;
+  /**
+   * Specify a warning threshold. Exits with an error status if warnings exceed this value.
+   *
+   * Equivalent to passing `--max-warnings` on the CLI.
+   */
+  maxWarnings?: number | null;
 }
 export interface OxlintOverride {
   /**
diff --git a/apps/oxlint/src/config_loader.rs b/apps/oxlint/src/config_loader.rs
@@ -387,6 +387,12 @@ impl<'a> ConfigLoader<'a> {
                         .push(ConfigLoadError::Diagnostic(nested_type_check_not_supported(&path)));
                     continue;
                 }
+                if builder.max_warnings().is_some() {
+                    errors.push(ConfigLoadError::Diagnostic(nested_max_warnings_not_supported(
+                        &path,
+                    )));
+                    continue;
+                }
             }
 
             let extended_paths = builder.extended_paths.clone();
@@ -649,6 +655,14 @@ fn nested_type_check_not_supported(path: &Path) -> OxcDiagnostic {
     .with_help("Move `options.typeCheck` to the root configuration file.")
 }
 
+fn nested_max_warnings_not_supported(path: &Path) -> OxcDiagnostic {
+    OxcDiagnostic::error(format!(
+        "The `options.maxWarnings` option is only supported in the root config, but it was found in {}.",
+        path.display()
+    ))
+    .with_help("Move `options.maxWarnings` to the root configuration file.")
+}
+
 #[cfg(test)]
 mod test {
     use std::path::{Path, PathBuf};
diff --git a/apps/oxlint/src/lint.rs b/apps/oxlint/src/lint.rs
@@ -338,17 +338,22 @@ impl CliRunner {
         let mut options =
             LintServiceOptions::new(self.cwd.clone()).with_cross_module(use_cross_module);
 
+        let config_store = ConfigStore::new(lint_config, nested_configs, external_plugin_store);
+        let type_aware = self.options.type_aware || config_store.type_aware_enabled();
+        let type_check = self.options.type_check || config_store.type_check_enabled();
+        let max_warnings = warning_options.max_warnings.or(config_store.max_warnings());
+
         let report_unused_directives = match inline_config_options.report_unused_directives {
             ReportUnusedDirectives::WithoutSeverity(true) => Some(AllowWarnDeny::Warn),
             ReportUnusedDirectives::WithSeverity(Some(severity)) => Some(severity),
             _ => None,
         };
-        let (mut diagnostic_service, tx_error) =
-            Self::get_diagnostic_service(&output_formatter, &warning_options, &misc_options);
-
-        let config_store = ConfigStore::new(lint_config, nested_configs, external_plugin_store);
-        let type_aware = self.options.type_aware || config_store.type_aware_enabled();
-        let type_check = self.options.type_check || config_store.type_check_enabled();
+        let (mut diagnostic_service, tx_error) = Self::get_diagnostic_service(
+            &output_formatter,
+            &warning_options,
+            &misc_options,
+            max_warnings,
+        );
 
         // Send JS plugins config to JS side
         if let Some(external_linter) = &external_linter {
@@ -466,13 +471,14 @@ impl CliRunner {
         reporter: &OutputFormatter,
         warning_options: &WarningOptions,
         misc_options: &MiscOptions,
+        max_warnings: Option<usize>,
     ) -> (DiagnosticService, DiagnosticSender) {
         let (service, sender) = DiagnosticService::new(reporter.get_diagnostic_reporter());
         (
             service
                 .with_quiet(warning_options.quiet)
                 .with_silent(misc_options.silent)
-                .with_max_warnings(warning_options.max_warnings),
+                .with_max_warnings(max_warnings),
             sender,
         )
     }
@@ -1311,6 +1317,18 @@ mod test {
         Tester::new().with_cwd("fixtures/tsgolint_type_error".into()).test_and_snapshot(args);
     }
 
+    #[test]
+    fn test_max_warnings_via_config_file() {
+        let args = &["-c", "config-max-warnings.json", "debugger.js"];
+        Tester::new().with_cwd("fixtures/linter".into()).test_and_snapshot(args);
+    }
+
+    #[test]
+    fn test_max_warnings_overridden_by_cli_flag() {
+        let args = &["--max-warnings", "1", "-c", "config-max-warnings.json", "debugger.js"];
+        Tester::new().with_cwd("fixtures/linter".into()).test_and_snapshot(args);
+    }
+
     #[test]
     #[cfg(not(target_endian = "big"))]
     fn test_tsgolint_no_typescript_files() {
diff --git a/apps/oxlint/src/snapshots/fixtures__linter_--max-warnings 1 -c config-max-warnings.json debugger.js@oxlint.snap b/apps/oxlint/src/snapshots/fixtures__linter_--max-warnings 1 -c config-max-warnings.json debugger.js@oxlint.snap
@@ -0,0 +1,21 @@
+---
+source: apps/oxlint/src/tester.rs
+assertion_line: 134
+---
+########## 
+arguments: --max-warnings 1 -c config-max-warnings.json debugger.js
+working directory: fixtures/linter
+----------
+
+  ! eslint(no-debugger): `debugger` statement is not allowed
+   ,-[debugger.js:1:1]
+ 1 | debugger;
+   : ^^^^^^^^^
+   `----
+  help: Remove the debugger statement
+
+Found 1 warning and 0 errors.
+Finished in <variable>ms on 1 file with 93 rules using 1 threads.
+----------
+CLI result: LintSucceeded
+----------
diff --git a/apps/oxlint/src/snapshots/fixtures__linter_-c config-max-warnings.json debugger.js@oxlint.snap b/apps/oxlint/src/snapshots/fixtures__linter_-c config-max-warnings.json debugger.js@oxlint.snap
@@ -0,0 +1,22 @@
+---
+source: apps/oxlint/src/tester.rs
+assertion_line: 134
+---
+########## 
+arguments: -c config-max-warnings.json debugger.js
+working directory: fixtures/linter
+----------
+
+  ! eslint(no-debugger): `debugger` statement is not allowed
+   ,-[debugger.js:1:1]
+ 1 | debugger;
+   : ^^^^^^^^^
+   `----
+  help: Remove the debugger statement
+
+Found 1 warning and 0 errors.
+Exceeded maximum number of warnings. Found 1.
+Finished in <variable>ms on 1 file with 93 rules using 1 threads.
+----------
+CLI result: LintMaxWarningsExceeded
+----------
diff --git a/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/files/test.js b/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/files/test.js
@@ -0,0 +1 @@
+debugger;
diff --git a/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/output.snap.md b/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/output.snap.md
@@ -0,0 +1,20 @@
+# Exit code
+1
+
+# stdout
+```
+  ! eslint(no-debugger): `debugger` statement is not allowed
+   ,-[files/test.js:1:1]
+ 1 | debugger;
+   : ^^^^^^^^^
+   `----
+  help: Remove the debugger statement
+
+Found 1 warning and 0 errors.
+Exceeded maximum number of warnings. Found 1.
+Finished in Xms on 1 file with 1 rules using X threads.
+```
+
+# stderr
+```
+```
diff --git a/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/oxlint.config.ts b/apps/oxlint/test/fixtures/js_config_dynamic_max_warnings/oxlint.config.ts
@@ -0,0 +1,14 @@
+import { defineConfig } from "#oxlint";
+
+const warningLimit = 0;
+const options = {
+  maxWarnings: warningLimit,
+};
+
+export default defineConfig({
+  categories: { correctness: "off" },
+  rules: {
+    "no-debugger": "warn",
+  },
+  options,
+});
diff --git a/crates/oxc_linter/fixtures/extends_config/options/max_warnings_0.json b/crates/oxc_linter/fixtures/extends_config/options/max_warnings_0.json
@@ -0,0 +1,5 @@
+{
+  "options": {
+    "maxWarnings": 0
+  }
+}
diff --git a/crates/oxc_linter/fixtures/extends_config/options/max_warnings_10.json b/crates/oxc_linter/fixtures/extends_config/options/max_warnings_10.json
@@ -0,0 +1,5 @@
+{
+  "options": {
+    "maxWarnings": 10
+  }
+}
diff --git a/crates/oxc_linter/src/config/config_builder.rs b/crates/oxc_linter/src/config/config_builder.rs
@@ -342,6 +342,11 @@ impl ConfigStoreBuilder {
         self.config.options.type_check
     }
 
+    #[inline]
+    pub fn max_warnings(&self) -> Option<usize> {
+        self.config.options.max_warnings
+    }
+
     #[cfg(test)]
     pub(crate) fn with_rule(mut self, rule: RuleEnum, severity: AllowWarnDeny) -> Self {
         self.rules.insert(rule, severity);
@@ -1415,6 +1420,26 @@ mod test {
             r#"{ "extends": ["fixtures/extends_config/options/type_check_false.json"] }"#,
         );
         assert_eq!(config.base.config.options.type_check, Some(false));
+
+        let config = config_store_from_str(
+            r#"{ "extends": ["fixtures/extends_config/options/max_warnings_10.json"] }"#,
+        );
+        assert_eq!(config.base.config.options.max_warnings, Some(10));
+
+        let config = config_store_from_str(
+            r#"
+            {
+                "extends": ["fixtures/extends_config/options/max_warnings_10.json"],
+                "options": {"maxWarnings": 1 }
+            }
+            "#,
+        );
+        assert_eq!(config.base.config.options.max_warnings, Some(1));
+
+        let config = config_store_from_str(
+            r#"{ "extends": ["fixtures/extends_config/options/max_warnings_0.json"] }"#,
+        );
+        assert_eq!(config.base.config.options.max_warnings, Some(0));
     }
 
     #[test]
diff --git a/crates/oxc_linter/src/config/config_store.rs b/crates/oxc_linter/src/config/config_store.rs
@@ -330,6 +330,11 @@ impl ConfigStore {
         self.base.base.config.options.type_check.unwrap_or(false)
     }
 
+    /// Max warnings configured in the root config.
+    pub fn max_warnings(&self) -> Option<usize> {
+        self.base.base.config.options.max_warnings
+    }
+
     pub(crate) fn get_related_config(&self, path: &Path) -> &Config {
         if self.nested_configs.is_empty() {
             &self.base
@@ -1209,4 +1214,33 @@ mod test {
         let store = ConfigStore::new(base, FxHashMap::default(), ExternalPluginStore::default());
         assert!(!store.type_check_enabled());
     }
+
+    #[test]
+    fn test_max_warnings_from_root_config() {
+        let base = Config::new(
+            vec![],
+            vec![],
+            OxlintCategories::default(),
+            LintConfig {
+                options: OxlintOptions { max_warnings: Some(3), ..OxlintOptions::default() },
+                ..LintConfig::default()
+            },
+            ResolvedOxlintOverrides::new(vec![]),
+        );
+        let store = ConfigStore::new(base, FxHashMap::default(), ExternalPluginStore::default());
+        assert_eq!(store.max_warnings(), Some(3));
+    }
+
+    #[test]
+    fn test_max_warnings_disabled_by_default() {
+        let base = Config::new(
+            vec![],
+            vec![],
+            OxlintCategories::default(),
+            LintConfig::default(),
+            ResolvedOxlintOverrides::new(vec![]),
+        );
+        let store = ConfigStore::new(base, FxHashMap::default(), ExternalPluginStore::default());
+        assert_eq!(store.max_warnings(), None);
+    }
 }
diff --git a/crates/oxc_linter/src/config/oxlintrc.rs b/crates/oxc_linter/src/config/oxlintrc.rs
@@ -36,19 +36,25 @@ pub struct OxlintOptions {
     /// Equivalent to passing `--type-check` on the CLI.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub type_check: Option<bool>,
+    /// Specify a warning threshold. Exits with an error status if warnings exceed this value.
+    ///
+    /// Equivalent to passing `--max-warnings` on the CLI.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub max_warnings: Option<usize>,
 }
 
 impl OxlintOptions {
     #[must_use]
     pub fn is_empty(&self) -> bool {
-        self.type_aware.is_none() && self.type_check.is_none()
+        self.type_aware.is_none() && self.type_check.is_none() && self.max_warnings.is_none()
     }
 
     #[must_use]
     pub fn merge(&self, other: &OxlintOptions) -> Self {
         Self {
             type_aware: self.type_aware.or(other.type_aware),
             type_check: self.type_check.or(other.type_check),
+            max_warnings: self.max_warnings.or(other.max_warnings),
         }
     }
 }
@@ -399,6 +405,7 @@ mod test {
         assert_eq!(config.extends, Vec::<PathBuf>::default());
         assert_eq!(config.options.type_aware, None);
         assert_eq!(config.options.type_check, None);
+        assert_eq!(config.options.max_warnings, None);
     }
 
     #[test]
@@ -418,6 +425,14 @@ mod test {
         let config: Oxlintrc =
             serde_json::from_value(json!({ "options": { "typeCheck": false } })).unwrap();
         assert_eq!(config.options.type_check, Some(false));
+
+        let config: Oxlintrc =
+            serde_json::from_value(json!({ "options": { "maxWarnings": 10 } })).unwrap();
+        assert_eq!(config.options.max_warnings, Some(10));
+
+        let config: Result<Oxlintrc, _> =
+            serde_json::from_value(json!({ "options": { "maxWarnings": -1 } }));
+        assert!(config.is_err());
     }
 
     #[test]
@@ -427,23 +442,29 @@ mod test {
 
         let config: Result<Oxlintrc, _> = serde_json::from_value(json!({ "typeCheck": true }));
         assert!(config.is_err());
+
+        let config: Result<Oxlintrc, _> = serde_json::from_value(json!({ "maxWarnings": 1 }));
+        assert!(config.is_err());
     }
 
     #[test]
     fn test_oxlintrc_merge_options() {
-        let mut root: Oxlintrc =
-            serde_json::from_value(json!({ "options": { "typeAware": true, "typeCheck": false } }))
-                .unwrap();
+        let mut root: Oxlintrc = serde_json::from_value(
+            json!({ "options": { "typeAware": true, "typeCheck": false, "maxWarnings": 1 } }),
+        )
+        .unwrap();
         root.path = PathBuf::from("/root/.oxlintrc.json");
 
-        let mut base: Oxlintrc =
-            serde_json::from_value(json!({ "options": { "typeAware": false, "typeCheck": true } }))
-                .unwrap();
+        let mut base: Oxlintrc = serde_json::from_value(
+            json!({ "options": { "typeAware": false, "typeCheck": true, "maxWarnings": 10 } }),
+        )
+        .unwrap();
         base.path = PathBuf::from("/root/base.json");
 
         let merged = root.merge(base);
         assert_eq!(merged.options.type_aware, Some(true));
         assert_eq!(merged.options.type_check, Some(false));
+        assert_eq!(merged.options.max_warnings, Some(1));
     }
 
     #[test]
diff --git a/npm/oxlint/configuration_schema.json b/npm/oxlint/configuration_schema.json
diff --git a/tasks/website_linter/src/snapshots/schema_json.snap b/tasks/website_linter/src/snapshots/schema_json.snap
diff --git a/tasks/website_linter/src/snapshots/schema_markdown.snap b/tasks/website_linter/src/snapshots/schema_markdown.snap

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "options": {
 +    "maxWarnings": 0
 +  }
 +}