add help message

oxc-project · Dec 29, 2024 · a1dfdf6 · a1dfdf6
1 parent 1297d3a
commit a1dfdf6
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/crates/oxc_linter/src/rules/eslint/vars_on_top.rs b/crates/oxc_linter/src/rules/eslint/vars_on_top.rs
@@ -8,6 +8,7 @@ use crate::{context::LintContext, rule::Rule, AstNode};
 
 fn vars_on_top_diagnostic(span: Span) -> OxcDiagnostic {
     OxcDiagnostic::warn("All 'var' declarations must be at the top of the function scope.")
+        .with_help("Consider moving this to the top of the functions scope or using let or const to declare this variable.")
         .with_label(span)
 }
 

diff --git a/crates/oxc_linter/src/snapshots/eslint_vars_on_top.snap b/crates/oxc_linter/src/snapshots/eslint_vars_on_top.snap
@@ -8,6 +8,7 @@ snapshot_kind: text
  6 │             var second = 0;
    ·             ───────────────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:7:7]
@@ -16,6 +17,7 @@ snapshot_kind: text
    ·                ───────────────
  8 │                second = 2;
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:11]
@@ -24,6 +26,7 @@ snapshot_kind: text
    ·                    ──────────────────
  5 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:2:12]
@@ -32,6 +35,7 @@ snapshot_kind: text
    ·                     ─────────
  3 │                    alert(i);
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:5:11]
@@ -40,6 +44,7 @@ snapshot_kind: text
    ·                    ───────────────
  6 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:6:15]
@@ -48,6 +53,7 @@ snapshot_kind: text
    ·                        ──────────────
  7 │                        break;
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:5:11]
@@ -56,6 +62,7 @@ snapshot_kind: text
    ·                    ──────────────
  6 │                } catch (e) {
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:7:11]
@@ -64,6 +71,7 @@ snapshot_kind: text
    ·                    ──────────────
  8 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:11]
@@ -72,6 +80,7 @@ snapshot_kind: text
    ·                    ──────────────
  5 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:11]
@@ -80,6 +89,7 @@ snapshot_kind: text
    ·                    ──────────────
  5 │                } while (first == 10);
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:3:12]
@@ -88,6 +98,7 @@ snapshot_kind: text
    ·                     ────────
  4 │                    item++;
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:5:11]
@@ -96,6 +107,7 @@ snapshot_kind: text
    ·                    ─────────────────
  6 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:5:11]
@@ -104,65 +116,75 @@ snapshot_kind: text
    ·                    ─────────────────
  6 │                }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:1:18]
  1 │ 'use strict'; 0; var x; f();
    ·                  ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:1:35]
  1 │ 'use strict'; var x; 'directive'; var y; f();
    ·                                   ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:1:33]
  1 │ function f() { 'use strict'; 0; var x; f(); }
    ·                                 ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:1:51]
  1 │ function f() { 'use strict'; var x; 'directive';  var y; f(); }
    ·                                                   ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:2:4]
  1 │ export function f() {}
  2 │             var x;
    ·             ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:3:4]
  2 │             export function f() {}
  3 │             var y;
    ·             ──────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:3:4]
  2 │             export {foo};
  3 │             var test = 1;
    ·             ─────────────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:2:4]
  1 │ export {foo} from 'foo';
  2 │             var test = 1;
    ·             ─────────────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:2:4]
  1 │ export * from 'foo';
  2 │             var test = 1;
    ·             ─────────────
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:12]
@@ -171,6 +193,7 @@ snapshot_kind: text
    ·                     ──────
  5 │                 }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:12]
@@ -179,6 +202,7 @@ snapshot_kind: text
    ·                     ──────
  5 │                 }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:5:12]
@@ -187,6 +211,7 @@ snapshot_kind: text
    ·                     ──────
  6 │                 }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:16]
@@ -195,6 +220,7 @@ snapshot_kind: text
    ·                         ──────
  5 │                     }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.
 
   ⚠ eslint(vars-on-top): All 'var' declarations must be at the top of the function scope.
    ╭─[vars_on_top.tsx:4:16]
@@ -203,3 +229,4 @@ snapshot_kind: text
    ·                         ──────
  5 │                 }
    ╰────
+  help: Consider moving this to the top of the functions scope or using let or const to declare this variable.