fix(analyze): improve diagnostic message for unused suppression comme…

…nts (#4200)
biomejs · Oct 7, 2024 · 055b0db · 055b0db
1 parent d04ab5b
commit 055b0db
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b
 
 ### Analyzer
 
+#### Bug fixes
+
+- Improved the message for unused suppression comments. Contributed by @dyc3
+
 ### CLI
 
 ### Configuration

diff --git a/crates/biome_analyze/src/lib.rs b/crates/biome_analyze/src/lib.rs
@@ -182,7 +182,7 @@ where
                 SuppressionDiagnostic::new(
                     category!("suppressions/unused"),
                     suppression.comment_span,
-                    "Suppression comment is not being used",
+                    "Suppression comment has no effect. Remove the suppression or make sure you are suppressing the correct rule.",
                 )
             });
 

diff --git a/crates/biome_js_analyze/tests/specs/correctness/noUnreachable/SuppressionComments.js.snap b/crates/biome_js_analyze/tests/specs/correctness/noUnreachable/SuppressionComments.js.snap
@@ -92,7 +92,7 @@ SuppressionComments.js:11:5 suppressions/deprecatedSuppressionComment  FIXABLE
 ```
 SuppressionComments.js:1:1 suppressions/unused ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Suppression comment is not being used
+  ! Suppression comment has no effect. Remove the suppression or make sure you are suppressing the correct rule.
   
   > 1 │ // rome-ignore lint/correctness/noUnreachable: this comment does nothing
       │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/..._js_analyze/tests/specs/correctness/useExhaustiveDependencies/ignoredDependencies.js.snap b/..._js_analyze/tests/specs/correctness/useExhaustiveDependencies/ignoredDependencies.js.snap
@@ -57,7 +57,7 @@ ignoredDependencies.js:8:5 lint/correctness/useExhaustiveDependencies ━━━
 ```
 ignoredDependencies.js:16:5 suppressions/unused ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Suppression comment is not being used
+  ! Suppression comment has no effect. Remove the suppression or make sure you are suppressing the correct rule.
   
     14 │ function IgnoredDependencies2() {
     15 │     let a = 1;