fix(linter): find disabled directives using the message's Span. (#4010)

rzvxa · rzvxa · commit 432d6d93c907 · 2024-07-02T10:49:05.000Z
fixes #4005
diff --git a/crates/oxc_linter/src/context.rs b/crates/oxc_linter/src/context.rs
@@ -3,7 +3,7 @@ use std::{cell::RefCell, path::Path, rc::Rc, sync::Arc};
 use oxc_cfg::ControlFlowGraph;
 use oxc_diagnostics::{OxcDiagnostic, Severity};
 use oxc_semantic::{AstNodes, JSDocFinder, ScopeTree, Semantic, SymbolTable};
-use oxc_span::{SourceType, Span};
+use oxc_span::{GetSpan, SourceType, Span};
 use oxc_syntax::module_record::ModuleRecord;
 
 use crate::{
@@ -157,7 +157,7 @@ impl<'a> LintContext<'a> {
     }
 
     fn add_diagnostic(&self, message: Message<'a>) {
-        if !self.disable_directives.contains(self.current_rule_name, message.start()) {
+        if !self.disable_directives.contains(self.current_rule_name, message.span()) {
             let mut message = message;
             if message.error.severity != self.severity {
                 message.error = message.error.with_severity(self.severity);
diff --git a/crates/oxc_linter/src/disable_directives.rs b/crates/oxc_linter/src/disable_directives.rs
@@ -27,8 +27,8 @@ pub struct DisableDirectives<'a> {
 }
 
 impl<'a> DisableDirectives<'a> {
-    pub fn contains(&self, rule_name: &'static str, start: u32) -> bool {
-        self.intervals.find(start, start + 1).any(|interval| {
+    pub fn contains(&self, rule_name: &'static str, span: Span) -> bool {
+        self.intervals.find(span.start, span.end).any(|interval| {
             interval.val == DisabledRule::All
                 // Our rule name currently does not contain the prefix.
                 // For example, this will match `@typescript-eslint/no-var-requires` given
diff --git a/crates/oxc_linter/src/fixer.rs b/crates/oxc_linter/src/fixer.rs
@@ -189,15 +189,24 @@ impl<'a> Message<'a> {
         Self { error, start, end, fix, fixed: false }
     }
 
+    #[inline]
     pub fn start(&self) -> u32 {
         self.start
     }
 
+    #[inline]
     pub fn end(&self) -> u32 {
         self.end
     }
 }
 
+impl<'a> GetSpan for Message<'a> {
+    #[inline]
+    fn span(&self) -> Span {
+        Span::new(self.start(), self.end())
+    }
+}
+
 /// The fixer of the code.
 /// Note that our parser has handled the BOM, so we don't need to port the BOM test cases from `ESLint`.
 pub struct Fixer<'a> {
diff --git a/crates/oxc_linter/src/rules/unicorn/no_empty_file.rs b/crates/oxc_linter/src/rules/unicorn/no_empty_file.rs
@@ -58,7 +58,13 @@ impl Rule for NoEmptyFile {
             return;
         }
 
-        ctx.diagnostic(no_empty_file_diagnostic(Span::new(0, 0)));
+        let mut span = program.span;
+        // only show diagnostic for the first 100 characters to avoid huge diagnostic messages with
+        // empty programs containing a bunch of comments.
+        // NOTE: if the enable/disable directives come after the first 100 characters they won't be
+        // respected by this diagnostic.
+        span.end = std::cmp::min(span.end, 100);
+        ctx.diagnostic(no_empty_file_diagnostic(span));
     }
 }
 
@@ -104,6 +110,7 @@ fn test() {
         r"[]",
         r"(() => {})()",
         "(() => {})();",
+        "/* eslint-disable no-empty-file */",
     ];
 
     let fail = vec![
diff --git a/crates/oxc_linter/src/snapshots/no_empty_file.snap b/crates/oxc_linter/src/snapshots/no_empty_file.snap
@@ -9,141 +9,140 @@ source: crates/oxc_linter/src/tester.rs
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │  
-   · ▲
+   · ─
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │     
-   · ▲
+   · ────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ 
-   · ▲
+   · ─
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  0 │ 
-   · ▲
+   · ─
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ 
-   · ▲
+   · ─
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
- 1 │ 
-   · ▲
- 2 │ 
- 3 │         
+ 1 │ ╭─▶ 
+ 2 │ │   
+ 3 │ ╰─▶         
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ // comment
-   · ▲
+   · ──────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ /* comment */
-   · ▲
+   · ─────────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ #!/usr/bin/env node
-   · ▲
+   · ───────────────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ 'use asm';
-   · ▲
+   · ──────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ 'use strict';
-   · ▲
+   · ─────────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ "use strict"
-   · ▲
+   · ────────────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ ""
-   · ▲
+   · ──
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ ;
-   · ▲
+   · ─
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ ;;
-   · ▲
+   · ──
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ {}
-   · ▲
+   · ──
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ {;;}
-   · ▲
+   · ────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ {{}}
-   · ▲
+   · ────
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ "";
-   · ▲
+   · ───
    ╰────
   help: Delete this file or add some code to it.
 
   ⚠ eslint-plugin-unicorn(no-empty-file): Empty files are not allowed.
    ╭─[no_empty_file.tsx:1:1]
  1 │ "use strict";
-   · ▲
+   · ─────────────
    ╰────
   help: Delete this file or add some code to it.

Original file line number	Diff line number	Diff line change
`@@ -189,15 +189,24 @@ impl<'a> Message<'a> {`
`189`	`189`	`Self { error, start, end, fix, fixed: false }`
`190`	`190`	`}`
`191`	`191`
	`192`	`+ #[inline]`
`192`	`193`	`pub fn start(&self) -> u32 {`
`193`	`194`	`self.start`
`194`	`195`	`}`
`195`	`196`
	`197`	`+ #[inline]`
`196`	`198`	`pub fn end(&self) -> u32 {`
`197`	`199`	`self.end`
`198`	`200`	`}`
`199`	`201`	`}`
`200`	`202`
	`203`	`+impl<'a> GetSpan for Message<'a> {`
	`204`	`+ #[inline]`
	`205`	`+ fn span(&self) -> Span {`
	`206`	`+ Span::new(self.start(), self.end())`
	`207`	`+ }`
	`208`	`+}`
	`209`	`+`
`201`	`210`	`/// The fixer of the code.`
`202`	`211`	/// Note that our parser has handled the BOM, so we don't need to port the BOM test cases from `ESLint`.
`203`	`212`	`pub struct Fixer<'a> {`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,13 @@ impl Rule for NoEmptyFile {`
`58`	`58`	`return;`
`59`	`59`	`}`
`60`	`60`
`61`		`- ctx.diagnostic(no_empty_file_diagnostic(Span::new(0, 0)));`
	`61`	`+ let mut span = program.span;`
	`62`	`+ // only show diagnostic for the first 100 characters to avoid huge diagnostic messages with`
	`63`	`+ // empty programs containing a bunch of comments.`
	`64`	`+ // NOTE: if the enable/disable directives come after the first 100 characters they won't be`
	`65`	`+ // respected by this diagnostic.`
	`66`	`+ span.end = std::cmp::min(span.end, 100);`
	`67`	`+ ctx.diagnostic(no_empty_file_diagnostic(span));`
`62`	`68`	`}`
`63`	`69`	`}`
`64`	`70`
`@@ -104,6 +110,7 @@ fn test() {`
`104`	`110`	`r"[]",`
`105`	`111`	`r"(() => {})()",`
`106`	`112`	`"(() => {})();",`
	`113`	`+ "/* eslint-disable no-empty-file */",`
`107`	`114`	`];`
`108`	`115`
`109`	`116`	`let fail = vec![`