docs(linter): Use backticks for code elements across more rule diagnostics (#15958)

Improves the consistency of diagnostic formatting in 30ish rules, and improves the diagnostic messages in editors that render markdown, plus makes it clearer which parts refer to code for end-users, even with the raw text.

-lso adjust the phrasing of some diagnostics slightly.

Author: connorshea

apps/oxlint/src/snapshots/_--ignore-path fixtures__linter__.customignore --no-ignore [email protected]

@@ -13,12 +13,12 @@ working directory:
    `----
   help: Consider using this expression or removing it
 
-  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to isNaN() when checking for NaN
+  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to `isNaN()` when checking for NaN
    ,-[fixtures/linter/nan.js:1:8]
  1 | 123 == NaN;
    :        ^^^
    `----
-  help: Use the isNaN function to compare with NaN.
+  help: Use the `isNaN` function to compare with NaN.
 
 Found 2 warnings and 0 errors.
 Finished in <variable>ms on 1 file with 89 rules using 1 threads.

apps/oxlint/src/snapshots/[email protected]

@@ -28,12 +28,12 @@ working directory:
    `----
   help: Consider using this expression or removing it
 
-  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to isNaN() when checking for NaN
+  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to `isNaN()` when checking for NaN
    ,-[fixtures/linter/nan.js:1:8]
  1 | 123 == NaN;
    :        ^^^
    `----
-  help: Use the isNaN function to compare with NaN.
+  help: Use the `isNaN` function to compare with NaN.
 
 Found 4 warnings and 0 errors.
 Finished in <variable>ms on 3 files with 89 rules using 1 threads.

apps/oxlint/src/snapshots/_fixtures__linter__debugger.js [email protected]

@@ -20,12 +20,12 @@ working directory:
    `----
   help: Consider using this expression or removing it
 
-  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to isNaN() when checking for NaN
+  ! ]8;;https://oxc.rs/docs/guide/usage/linter/rules/eslint/use-isnan.html\eslint(use-isnan)]8;;\: Requires calls to `isNaN()` when checking for NaN
    ,-[fixtures/linter/nan.js:1:8]
  1 | 123 == NaN;
    :        ^^^
    `----
-  help: Use the isNaN function to compare with NaN.
+  help: Use the `isNaN` function to compare with NaN.
 
 Found 3 warnings and 0 errors.
 Finished in <variable>ms on 2 files with 89 rules using 1 threads.

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

@@ -7,7 +7,7 @@ use crate::{AstNode, context::LintContext, rule::Rule};
 
 fn no_self_compare_diagnostic(left_span: Span, right_span: Span) -> OxcDiagnostic {
     OxcDiagnostic::warn("Both sides of this comparison are exactly the same")
-        .with_help("If you are testing for NaN, you can use Number.isNaN function.")
+        .with_help("If you are testing for NaN, you can use the `Number.isNaN()` function.")
         .with_labels([left_span, right_span])
 }
 

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

@@ -9,7 +9,7 @@ use serde_json::Value;
 const PRE_DEFINE_VAR: [&str; 5] = ["Infinity", "NaN", "arguments", "eval", "undefined"];
 
 fn no_shadow_restricted_names_diagnostic(shadowed_name: &str, span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Shadowing of global properties such as 'undefined' is not allowed.")
+    OxcDiagnostic::warn("Shadowing of global properties such as `undefined` is not allowed.")
         .with_help(format!("Rename '{shadowed_name}' to avoid shadowing the global property."))
         .with_label(span)
 }

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

@@ -15,8 +15,8 @@ use rustc_hash::{FxHashMap, FxHashSet};
 use crate::{AstNode, context::LintContext, rule::Rule};
 
 fn no_this_before_super_diagnostic(span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Expected to always call super() before this/super property access.")
-        .with_help("Call super() before this/super property access.")
+    OxcDiagnostic::warn("Expected to always call `super()` before `this`/`super` property access.")
+        .with_help("Call `super()` before `this`/`super` property access.")
         .with_label(span)
 }
 

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

@@ -9,8 +9,10 @@ use oxc_span::{GetSpan, Span};
 use crate::{AstNode, context::LintContext, rule::Rule};
 
 fn no_unsafe_finally_diagnostic(span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Unsafe finally block")
-        .with_help("Control flow inside try or catch blocks will be overwritten by this statement")
+    OxcDiagnostic::warn("Unsafe `finally` block.")
+        .with_help(
+            "Control flow inside `try` or `catch` blocks will be overwritten by this statement.",
+        )
         .with_label(span)
 }
 
@@ -20,7 +22,7 @@ pub struct NoUnsafeFinally;
 declare_oxc_lint!(
     /// ### What it does
     ///
-    /// Disallow control flow statements in finally blocks
+    /// Disallow control flow statements in `finally` blocks.
     ///
     /// ### Why is this bad?
     ///

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

@@ -11,27 +11,27 @@ use schemars::JsonSchema;
 use crate::{AstNode, context::LintContext, rule::Rule};
 
 fn comparison_with_na_n(span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Requires calls to isNaN() when checking for NaN")
-        .with_help("Use the isNaN function to compare with NaN.")
+    OxcDiagnostic::warn("Requires calls to `isNaN()` when checking for NaN")
+        .with_help("Use the `isNaN` function to compare with NaN.")
         .with_label(span)
 }
 
 fn switch_na_n(span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Requires calls to isNaN() when checking for NaN")
+    OxcDiagnostic::warn("Requires calls to `isNaN()` when checking for NaN.")
         .with_help(
-            "'switch(NaN)' can never match a case clause. Use Number.isNaN instead of the switch.",
+            "`switch(NaN)` can never match a case clause. Use `Number.isNaN` instead of the switch.",
         )
         .with_label(span)
 }
 
 fn case_na_n(span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Requires calls to isNaN() when checking for NaN")
-        .with_help("'case NaN' can never match. Use Number.isNaN before the switch.")
+    OxcDiagnostic::warn("Requires calls to `isNaN()` when checking for NaN")
+        .with_help("`case NaN` can never match. Use `Number.isNaN` before the switch.")
         .with_label(span)
 }
 
 fn index_of_na_n(method_name: &str, span: Span) -> OxcDiagnostic {
-    OxcDiagnostic::warn("Requires calls to isNaN() when checking for NaN")
+    OxcDiagnostic::warn("Requires calls to `isNaN()` when checking for NaN")
         .with_help(format!("Array prototype method '{method_name}' cannot find NaN."))
         .with_label(span)
 }

crates/oxc_linter/src/rules/import/default.rs

@@ -6,7 +6,7 @@ use crate::{context::LintContext, module_record::ImportImportName, rule::Rule};
 
 fn default_diagnostic(imported_name: &str, span: Span) -> OxcDiagnostic {
     OxcDiagnostic::warn(format!("No default export found in imported module {imported_name:?}"))
-        .with_help(format!("does {imported_name:?} have the default export?"))
+        .with_help(format!("Does {imported_name:?} have the default export?"))
         .with_label(span)
 }
 

crates/oxc_linter/src/rules/import/named.rs

@@ -10,7 +10,7 @@ use crate::{
 
 fn named_diagnostic(imported_name: &str, module_name: &str, span: Span) -> OxcDiagnostic {
     OxcDiagnostic::warn(format!("named import {imported_name:?} not found"))
-        .with_help(format!("does {module_name:?} have the export {imported_name:?}?"))
+        .with_help(format!("Does {module_name:?} have the export {imported_name:?}?"))
         .with_label(span)
 }