chore: update detail

crates/biome_configuration/src/analyzer/linter/rules.rs

@@ -3379,7 +3379,7 @@ pub struct Nursery {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub use_explicit_function_return_type:
         Option<RuleConfiguration<biome_js_analyze::options::UseExplicitFunctionReturnType>>,
-    #[doc = "Require for-in loops to include an if statement"]
+    #[doc = "Require for-in loops to include an if statement."]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub use_guard_for_in: Option<RuleConfiguration<biome_js_analyze::options::UseGuardForIn>>,
     #[doc = "Disallows package private imports."]

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

@@ -7,7 +7,14 @@ use biome_rowan::{AstNode, AstNodeList};
 
 declare_lint_rule! {
     ///
-    /// Require `for-in` loops to include an `if` statement
+    /// Require `for-in` loops to include an `if` statement.
+    ///
+    /// Looping over objects with a for in loop will include properties that are inherited through the prototype chain.
+    /// This behavior can lead to unexpected items in your for loop.
+    ///
+    /// For codebases that do not support ES2022, `Object.prototype.hasOwnProperty.call(foo, key)` can be used as a check that the property is not inherited.
+    ///
+    /// For codebases that do support ES2022, `Object.hasOwn(foo, key)` can be used as a shorter alternative.
     ///
     /// ## Examples
     ///
@@ -117,11 +124,13 @@ impl Rule for UseGuardForIn {
                 rule_category!(),
                 node.range(),
                 markup! {
-                    "Require `for-in` loops to include an `if` statement."
+                    "The body of a for-in should be wrapped in an `if` statement."
                 },
             )
             .note(markup! {
-                "The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype."
+                "Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop."
+            }).note(markup! {
+                "To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. "
             }),
         )
     }

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

@@ -16,38 +16,42 @@ for (var x in o) foo();
 ```
 invalid.js:1:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
   > 1 │ for (var x in o) { if (x) { f(); continue; } g(); }
       │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     2 │ for (var x in o) { if (x) { continue; f(); } g(); }
     3 │ for (var x in o) { if (x) { f(); } g(); }
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```
 
 ```
 invalid.js:2:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
     1 │ for (var x in o) { if (x) { f(); continue; } g(); }
   > 2 │ for (var x in o) { if (x) { continue; f(); } g(); }
       │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     3 │ for (var x in o) { if (x) { f(); } g(); }
     4 │ for (var x in o) { if (x) f(); g(); }
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```
 
 ```
 invalid.js:3:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
     1 │ for (var x in o) { if (x) { f(); continue; } g(); }
     2 │ for (var x in o) { if (x) { continue; f(); } g(); }
@@ -56,15 +60,17 @@ invalid.js:3:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━
     4 │ for (var x in o) { if (x) f(); g(); }
     5 │ for (var x in o) { foo() }
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```
 
 ```
 invalid.js:4:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
     2 │ for (var x in o) { if (x) { continue; f(); } g(); }
     3 │ for (var x in o) { if (x) { f(); } g(); }
@@ -73,38 +79,44 @@ invalid.js:4:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━
     5 │ for (var x in o) { foo() }
     6 │ for (var x in o) foo();
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```
 
 ```
 invalid.js:5:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
     3 │ for (var x in o) { if (x) { f(); } g(); }
     4 │ for (var x in o) { if (x) f(); g(); }
   > 5 │ for (var x in o) { foo() }
       │ ^^^^^^^^^^^^^^^^^^^^^^^^^^
     6 │ for (var x in o) foo();
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```
 
 ```
 invalid.js:6:1 lint/nursery/useGuardForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-  ! Require `for-in` loops to include an `if` statement.
+  ! The body of a for-in should be wrapped in an `if` statement.
   
     4 │ for (var x in o) { if (x) f(); g(); }
     5 │ for (var x in o) { foo() }
   > 6 │ for (var x in o) foo();
       │ ^^^^^^^^^^^^^^^^^^^^^^^
   
-  i The body of a for-in should be wrapped in an if statement to filter unwanted properties from the prototype.
+  i Looping over the object with for-in loop  will include properties that are inherited through the prototype chain, the behaviour can lead to some unexpected items in your loop.
+  
+  i To resolve this issue, add an if statement like `if (Object.hasOwn(foo, key)) {...}` to wrapper the body of for-in loop. 
   
 
 ```