feat(lint/useDefaultCase): add rule notes

crates/biome_js_analyze/src/lint/nursery/use_default_case.rs

@@ -96,12 +96,7 @@ impl Rule for UseDefaultCase {
 
     fn run(ctx: &RuleContext<Self>) -> Self::Signals {
         let node = ctx.query();
-        let options = ctx.options();
-        let comment_pattern = options
-            .comment_pattern
-            .clone()
-            .unwrap_or(String::from("^no default$"))
-            .replace("\\\\", "\\");
+        let comment_pattern = get_comment_pattern(ctx);
 
         let has_case_clauses = node.cases().into_iter().len() > 0;
         let is_missing_default_case = node
@@ -145,17 +140,34 @@ impl Rule for UseDefaultCase {
 
     fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> {
         let node = ctx.query();
+        let comment_pattern = get_comment_pattern(ctx);
 
-        Some(RuleDiagnostic::new(
+        Some(
+            RuleDiagnostic::new(
             rule_category!(),
             node.range(),
             markup! {
                 "Expected a default case."
             },
-        ))
+            )
+            .note(markup! {
+                "The lack of a default clause can result in unexpected behaviors in your code."
+            }).note(markup! {
+                "Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /" {comment_pattern} "/"
+            }),
+        )
     }
 }
 
+fn get_comment_pattern(ctx: &RuleContext<UseDefaultCase>) -> String {
+    return ctx
+        .options()
+        .comment_pattern
+        .clone()
+        .unwrap_or(String::from("^no default$"))
+        .replace("\\\\", "\\");
+}
+
 fn has_disable_comment(trivia: Option<SyntaxTrivia<JsLanguage>>, comment_pattern: &str) -> bool {
     if trivia.is_some() {
         let comment_regex = Regex::new(comment_pattern).unwrap();

crates/biome_js_analyze/tests/specs/nursery/useDefaultCase/invalid.js.snap

@@ -39,6 +39,10 @@ invalid.js:1:1 lint/nursery/useDefaultCase ━━━━━━━━━━━━
     5 │ 
     6 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /^no default$/
+  
 
 ```
 
@@ -59,6 +63,10 @@ invalid.js:6:1 lint/nursery/useDefaultCase ━━━━━━━━━━━━
     11 │ 
     12 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /^no default$/
+  
 
 ```
 
@@ -79,5 +87,9 @@ invalid.js:12:1 lint/nursery/useDefaultCase ━━━━━━━━━━━━
        │ ^
     18 │ 
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /^no default$/
+  
 
 ```

crates/biome_js_analyze/tests/specs/nursery/useDefaultCase/invalidCommentPattern.js.snap

@@ -51,6 +51,10 @@ invalidCommentPattern.js:1:1 lint/nursery/useDefaultCase ━━━━━━━
     5 │ 
     6 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /skip default(\s\d)*/
+  
 
 ```
 
@@ -71,6 +75,10 @@ invalidCommentPattern.js:6:1 lint/nursery/useDefaultCase ━━━━━━━
     11 │ 
     12 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /skip default(\s\d)*/
+  
 
 ```
 
@@ -92,6 +100,10 @@ invalidCommentPattern.js:12:1 lint/nursery/useDefaultCase ━━━━━━━
     18 │ 
     19 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /skip default(\s\d)*/
+  
 
 ```
 
@@ -112,6 +124,10 @@ invalidCommentPattern.js:19:1 lint/nursery/useDefaultCase ━━━━━━━
     24 │ 
     25 │ switch (a) {
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /skip default(\s\d)*/
+  
 
 ```
 
@@ -131,5 +147,9 @@ invalidCommentPattern.js:25:1 lint/nursery/useDefaultCase ━━━━━━━
        │ ^
     30 │ 
   
+  i The lack of a default clause can result in unexpected behaviors in your code.
+  
+  i Consider adding a default clause or a comment explicitly stating that the default clause is not required, following the regex /skip default(\s\d)*/
+  
 
 ```