feat(linter): add fix capabilties to existing lint rules (#4560)

crates/oxc_linter/src/context.rs

@@ -7,6 +7,8 @@ use oxc_semantic::{AstNodes, JSDocFinder, ScopeTree, Semantic, SymbolTable};
 use oxc_span::{GetSpan, SourceType, Span};
 use oxc_syntax::module_record::ModuleRecord;
 
+#[cfg(debug_assertions)]
+use crate::rule::RuleFixMeta;
 use crate::{
     config::OxlintRules,
     disable_directives::{DisableDirectives, DisableDirectivesBuilder},
@@ -41,6 +43,8 @@ pub struct LintContext<'a> {
     // states
     current_plugin_prefix: &'static str,
     current_rule_name: &'static str,
+    #[cfg(debug_assertions)]
+    current_rule_fix_capabilities: RuleFixMeta,
 
     /// Current rule severity. Allows for user severity overrides, e.g.
     /// ```json
@@ -79,6 +83,8 @@ impl<'a> LintContext<'a> {
             eslint_config: Arc::new(OxlintConfig::default()),
             current_plugin_prefix: "eslint",
             current_rule_name: "",
+            #[cfg(debug_assertions)]
+            current_rule_fix_capabilities: RuleFixMeta::None,
             severity: Severity::Warning,
             frameworks: FrameworkFlags::empty(),
         }
@@ -105,6 +111,12 @@ impl<'a> LintContext<'a> {
         self
     }
 
+    #[cfg(debug_assertions)]
+    pub fn with_rule_fix_capabilities(mut self, capabilities: RuleFixMeta) -> Self {
+        self.current_rule_fix_capabilities = capabilities;
+        self
+    }
+
     pub fn with_severity(mut self, severity: AllowWarnDeny) -> Self {
         self.severity = Severity::from(severity);
         self
@@ -287,6 +299,7 @@ impl<'a> LintContext<'a> {
         self.diagnostic_with_fix_of_kind(diagnostic, FixKind::DangerousFix, fix);
     }
 
+    #[allow(clippy::missing_panics_doc)] // only panics in debug mode
     pub fn diagnostic_with_fix_of_kind<C, F>(
         &self,
         diagnostic: OxcDiagnostic,
@@ -296,24 +309,18 @@ impl<'a> LintContext<'a> {
         C: Into<RuleFix<'a>>,
         F: FnOnce(RuleFixer<'_, 'a>) -> C,
     {
-        // if let Some(accepted_fix_kind) = self.fix {
-        //     let fixer = RuleFixer::new(fix_kind, self);
-        //     let rule_fix: RuleFix<'a> = fix(fixer).into();
-        //     let diagnostic = match (rule_fix.message(), &diagnostic.help) {
-        //         (Some(message), None) => diagnostic.with_help(message.to_owned()),
-        //         _ => diagnostic,
-        //     };
-        //     if rule_fix.kind() <= accepted_fix_kind {
-        //         let fix = rule_fix.into_fix(self.source_text());
-        //         self.add_diagnostic(Message::new(diagnostic, Some(fix)));
-        //     } else {
-        //         self.diagnostic(diagnostic);
-        //     }
-        // } else {
-        //     self.diagnostic(diagnostic);
-        // }
         let fixer = RuleFixer::new(fix_kind, self);
         let rule_fix: RuleFix<'a> = fix(fixer).into();
+        #[cfg(debug_assertions)]
+        {
+            assert!(
+                self.current_rule_fix_capabilities.supports_fix(fix_kind),
+                "Rule `{}` does not support safe fixes. Did you forget to update fix capabilities in declare_oxc_lint?.\n\tSupported fix kinds: {:?}\n\tAttempted fix kind: {:?}",
+                self.current_rule_name,
+                FixKind::from(self.current_rule_fix_capabilities),
+                rule_fix.kind()
+            );
+        }
         let diagnostic = match (rule_fix.message(), &diagnostic.help) {
             (Some(message), None) => diagnostic.with_help(message.to_owned()),
             _ => diagnostic,

crates/oxc_linter/src/lib.rs

@@ -120,18 +120,7 @@ impl Linter {
             .rules
             .iter()
             .filter(|rule| rule.should_run(&ctx))
-            .map(|rule| {
-                let rule_name = rule.name();
-                let plugin_name = self.map_jest(rule.plugin_name(), rule_name);
-
-                (
-                    rule,
-                    ctx.clone()
-                        .with_plugin_name(plugin_name)
-                        .with_rule_name(rule_name)
-                        .with_severity(rule.severity),
-                )
-            })
+            .map(|rule| (rule, self.ctx_for_rule(&ctx, rule)))
             .collect::<Vec<_>>();
 
         for (rule, ctx) in &rules {
@@ -186,6 +175,18 @@ impl Linter {
         ctx
     }
 
+    fn ctx_for_rule<'a>(&self, ctx: &LintContext<'a>, rule: &RuleWithSeverity) -> LintContext<'a> {
+        let rule_name = rule.name();
+        let plugin_name = self.map_jest(rule.plugin_name(), rule_name);
+
+        #[cfg(debug_assertions)]
+        let ctx = ctx.clone().with_rule_fix_capabilities(rule.rule.fix());
+        #[cfg(not(debug_assertions))]
+        let ctx = ctx.clone();
+
+        ctx.with_plugin_name(plugin_name).with_rule_name(rule_name).with_severity(rule.severity)
+    }
+
     fn map_jest(&self, plugin_name: &'static str, rule_name: &str) -> &'static str {
         if self.options.vitest_plugin
             && plugin_name == "jest"

crates/oxc_linter/src/rules/eslint/eqeqeq.rs

@@ -35,7 +35,8 @@ declare_oxc_lint!(
     /// a == b
     /// ```
     Eqeqeq,
-    pedantic
+    pedantic,
+    conditional_fix
 );
 
 impl Rule for Eqeqeq {

crates/oxc_linter/src/rules/eslint/no_debugger.rs

@@ -27,7 +27,8 @@ declare_oxc_lint!(
     /// debugger;
     /// ```
     NoDebugger,
-    correctness
+    correctness,
+    fix
 );
 
 impl Rule for NoDebugger {

crates/oxc_linter/src/rules/eslint/no_div_regex.rs

@@ -30,6 +30,7 @@ declare_oxc_lint!(
     /// ```
     NoDivRegex,
     restriction,
+    fix
 );
 
 impl Rule for NoDivRegex {

crates/oxc_linter/src/rules/eslint/no_unsafe_negation.rs

@@ -39,7 +39,8 @@ declare_oxc_lint!(
     /// }
     /// ```
     NoUnsafeNegation,
-    correctness
+    correctness,
+    fix
 );
 
 impl Rule for NoUnsafeNegation {

crates/oxc_linter/src/rules/eslint/no_unused_labels.rs

@@ -35,7 +35,8 @@ declare_oxc_lint!(
     /// }
     /// ```
     NoUnusedLabels,
-    correctness
+    correctness,
+    fix
 );
 
 impl Rule for NoUnusedLabels {

crates/oxc_linter/src/rules/eslint/no_useless_constructor.rs

@@ -78,6 +78,7 @@ declare_oxc_lint!(
     ///```
     NoUselessConstructor,
     suspicious,
+    fix
 );
 
 impl Rule for NoUselessConstructor {

crates/oxc_linter/src/rules/eslint/no_useless_escape.rs

@@ -26,7 +26,8 @@ declare_oxc_lint!(
     /// ```javascript
     /// ```
     NoUselessEscape,
-    correctness
+    correctness,
+    fix
 );
 
 impl Rule for NoUselessEscape {

crates/oxc_linter/src/rules/eslint/sort_imports.rs

@@ -73,7 +73,8 @@ declare_oxc_lint!(
     /// import e from 'bar.js';
     /// ```
     SortImports,
-    style
+    style,
+    conditional_fix
 );
 
 impl Rule for SortImports {

crates/oxc_linter/src/rules/eslint/unicode_bom.rs

@@ -40,6 +40,7 @@ declare_oxc_lint!(
     /// ```
     UnicodeBom,
     restriction,
+    fix
 );
 
 impl Rule for UnicodeBom {

crates/oxc_linter/src/rules/eslint/use_isnan.rs

@@ -75,6 +75,7 @@ declare_oxc_lint!(
     /// ```
     UseIsnan,
     correctness,
+    conditional_fix
 );
 
 impl Rule for UseIsnan {

crates/oxc_linter/src/rules/eslint/valid_typeof.rs

@@ -50,6 +50,7 @@ declare_oxc_lint!(
     /// ```
     ValidTypeof,
     correctness,
+    conditional_fix
 );
 
 impl Rule for ValidTypeof {

crates/oxc_linter/src/rules/jest/consistent_test_it.rs

@@ -164,6 +164,7 @@ declare_oxc_lint!(
     /// }
     ConsistentTestIt,
     style,
+    fix
 );
 
 impl Rule for ConsistentTestIt {

crates/oxc_linter/src/rules/jest/no_alias_methods.rs

@@ -54,7 +54,8 @@ declare_oxc_lint!(
     /// }
     /// ```
     NoAliasMethods,
-    style
+    style,
+    fix
 );
 
 impl Rule for NoAliasMethods {

crates/oxc_linter/src/rules/jest/no_deprecated_functions.rs

@@ -75,6 +75,7 @@ declare_oxc_lint!(
     /// ```
     NoDeprecatedFunctions,
     style,
+    fix
 );
 
 const DEPRECATED_FUNCTIONS_MAP: Map<&'static str, (usize, &'static str)> = phf_map! {

crates/oxc_linter/src/rules/jest/no_focused_tests.rs

@@ -61,7 +61,8 @@ declare_oxc_lint!(
     /// }
     /// ```
     NoFocusedTests,
-    correctness
+    correctness,
+    fix
 );
 
 impl Rule for NoFocusedTests {

crates/oxc_linter/src/rules/jest/no_jasmine_globals.rs

@@ -34,7 +34,8 @@ declare_oxc_lint!(
     /// });
     /// ```
     NoJasmineGlobals,
-    style
+    style,
+    conditional_fix
 );
 
 const NON_JASMINE_PROPERTY_NAMES: [&str; 4] = ["spyOn", "spyOnProperty", "fail", "pending"];

crates/oxc_linter/src/rules/jest/no_test_prefixes.rs

@@ -53,7 +53,8 @@ declare_oxc_lint!(
     /// }
     /// ```
     NoTestPrefixes,
-    style
+    style,
+    fix
 );
 
 impl Rule for NoTestPrefixes {

crates/oxc_linter/src/rules/jest/no_untyped_mock_factory.rs

@@ -88,6 +88,7 @@ declare_oxc_lint!(
     ///
     NoUntypedMockFactory,
     style,
+    conditional_fix
 );
 
 impl Rule for NoUntypedMockFactory {

crates/oxc_linter/src/rules/jest/prefer_comparison_matcher.rs

@@ -56,6 +56,7 @@ declare_oxc_lint!(
     ///
     PreferComparisonMatcher,
     style,
+    fix
 );
 
 impl Rule for PreferComparisonMatcher {

crates/oxc_linter/src/rules/jest/prefer_expect_resolves.rs

@@ -72,6 +72,7 @@ declare_oxc_lint!(
     /// ```
     PreferExpectResolves,
     style,
+    fix
 );
 
 impl Rule for PreferExpectResolves {

crates/oxc_linter/src/rules/jest/prefer_jest_mocked.rs

@@ -51,6 +51,7 @@ declare_oxc_lint!(
     /// ```
     PreferJestMocked,
     style,
+    fix
 );
 
 impl Rule for PreferJestMocked {

crates/oxc_linter/src/rules/jest/prefer_lowercase_title.rs

@@ -129,6 +129,7 @@ declare_oxc_lint!(
     ///
     PreferLowercaseTitle,
     style,
+    fix
 );
 
 impl Rule for PreferLowercaseTitle {

crates/oxc_linter/src/rules/jest/prefer_mock_promise_shorthand.rs

@@ -52,6 +52,7 @@ declare_oxc_lint!(
     ///
     PreferMockPromiseShorthand,
     style,
+    conditional_fix
 );
 
 impl Rule for PreferMockPromiseShorthand {

crates/oxc_linter/src/rules/jest/prefer_spy_on.rs

@@ -53,6 +53,7 @@ declare_oxc_lint!(
     /// ```
     PreferSpyOn,
     style,
+    fix
 );
 
 impl Rule for PreferSpyOn {

crates/oxc_linter/src/rules/jest/prefer_strict_equal.rs

@@ -35,6 +35,7 @@ declare_oxc_lint!(
     ///
     PreferStrictEqual,
     style,
+    fix
 );
 
 impl Rule for PreferStrictEqual {

crates/oxc_linter/src/rules/jest/prefer_to_be.rs

@@ -66,6 +66,7 @@ declare_oxc_lint!(
     /// ```
     PreferToBe,
     style,
+    fix
 );
 
 #[derive(Clone, Debug, PartialEq)]

crates/oxc_linter/src/rules/jest/prefer_to_have_length.rs

@@ -51,6 +51,7 @@ declare_oxc_lint!(
     ///
     PreferToHaveLength,
     style,
+    fix
 );
 
 impl Rule for PreferToHaveLength {

crates/oxc_linter/src/rules/jest/prefer_todo.rs

@@ -47,6 +47,7 @@ declare_oxc_lint!(
     /// ```
     PreferTodo,
     style,
+    fix
 );
 
 impl Rule for PreferTodo {

crates/oxc_linter/src/rules/jsx_a11y/aria_props.rs

@@ -41,7 +41,8 @@ declare_oxc_lint!(
     /// <input aria-labelledby="address_label" />
     /// ```
     AriaProps,
-    correctness
+    correctness,
+    conditional_fix
 );
 
 impl Rule for AriaProps {

crates/oxc_linter/src/rules/jsx_a11y/no_autofocus.rs

@@ -58,7 +58,8 @@ declare_oxc_lint!(
     /// ```
     ///
     NoAutofocus,
-    correctness
+    correctness,
+    fix
 );
 
 impl NoAutofocus {

crates/oxc_linter/src/rules/oxc/no_const_enum.rs

@@ -36,6 +36,7 @@ declare_oxc_lint!(
     /// ```
     NoConstEnum,
     restriction,
+    fix
 );
 
 impl Rule for NoConstEnum {