feat(js_analyze): implement noForIn (#8085)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: Netail

.changeset/five-rats-train.md

@@ -0,0 +1,13 @@
+---
+"@biomejs/biome": patch
+---
+
+Added the nursery rule [`noForIn`](https://biomejs.dev/linter/rules/no-for-in/). Disallow iterating using a for-in loop.
+
+**Invalid:**
+
+```js
+for (const i in array) {
+  console.log(i, array[i]);
+}
+```

crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs

@@ -170,6 +170,7 @@ define_categories! {
     "lint/nursery/noDuplicateDependencies": "https://biomejs.dev/linter/rules/no-duplicate-dependencies",
     "lint/nursery/noEmptySource": "https://biomejs.dev/linter/rules/no-empty-source",
     "lint/nursery/noFloatingPromises": "https://biomejs.dev/linter/rules/no-floating-promises",
+    "lint/nursery/noForIn": "https://biomejs.dev/linter/rules/no-for-in",
     "lint/nursery/noImplicitCoercion": "https://biomejs.dev/linter/rules/no-implicit-coercion",
     "lint/nursery/noImportCycles": "https://biomejs.dev/linter/rules/no-import-cycles",
     "lint/nursery/noIncrementDecrement": "https://biomejs.dev/linter/rules/no-increment-decrement",
@@ -190,22 +191,14 @@ define_categories! {
     "lint/nursery/noUselessUndefined": "https://biomejs.dev/linter/rules/no-useless-undefined",
     "lint/nursery/noVueDataObjectDeclaration": "https://biomejs.dev/linter/rules/no-vue-data-object-declaration",
     "lint/nursery/noVueDuplicateKeys": "https://biomejs.dev/linter/rules/no-vue-duplicate-keys",
-    "lint/nursery/useVueValidVBind": "https://biomejs.dev/linter/rules/use-vue-valid-v-bind",
-    "lint/nursery/useVueValidVIf": "https://biomejs.dev/linter/rules/use-vue-valid-v-if",
-    "lint/nursery/useVueValidVElse": "https://biomejs.dev/linter/rules/use-vue-valid-v-else",
-    "lint/nursery/useVueValidVElseIf": "https://biomejs.dev/linter/rules/use-vue-valid-v-else-if",
-    "lint/nursery/useVueValidVFor": "https://biomejs.dev/linter/rules/use-vue-valid-v-for",
-    "lint/nursery/useVueValidVHtml": "https://biomejs.dev/linter/rules/use-vue-valid-v-html",
-    "lint/nursery/useVueValidVModel": "https://biomejs.dev/linter/rules/use-vue-valid-v-model",
-    "lint/nursery/useVueValidVOn": "https://biomejs.dev/linter/rules/use-vue-valid-v-on",
     "lint/nursery/noVueReservedKeys": "https://biomejs.dev/linter/rules/no-vue-reserved-keys",
     "lint/nursery/noVueReservedProps": "https://biomejs.dev/linter/rules/no-vue-reserved-props",
     "lint/nursery/useAnchorHref": "https://biomejs.dev/linter/rules/use-anchor-href",
     "lint/nursery/useArraySortCompare": "https://biomejs.dev/linter/rules/use-array-sort-compare",
     "lint/nursery/useBiomeSuppressionComment": "https://biomejs.dev/linter/rules/use-biome-suppression-comment",
     "lint/nursery/useConsistentArrowReturn": "https://biomejs.dev/linter/rules/use-consistent-arrow-return",
-    "lint/nursery/useConsistentObjectDefinition": "https://biomejs.dev/linter/rules/use-consistent-object-definition",
     "lint/nursery/useConsistentGraphqlDescriptions": "https://biomejs.dev/linter/rules/use-consistent-graphql-descriptions",
+    "lint/nursery/useConsistentObjectDefinition": "https://biomejs.dev/linter/rules/use-consistent-object-definition",
     "lint/nursery/useDeprecatedDate": "https://biomejs.dev/linter/rules/use-deprecated-date",
     "lint/nursery/useExhaustiveSwitchCases": "https://biomejs.dev/linter/rules/use-exhaustive-switch-cases",
     "lint/nursery/useExplicitFunctionReturnType": "https://biomejs.dev/linter/rules/use-explicit-type",
@@ -218,6 +211,14 @@ define_categories! {
     "lint/nursery/useSortedClasses": "https://biomejs.dev/linter/rules/use-sorted-classes",
     "lint/nursery/useVueDefineMacrosOrder": "https://biomejs.dev/linter/rules/use-vue-define-macros-order",
     "lint/nursery/useVueMultiWordComponentNames": "https://biomejs.dev/linter/rules/use-vue-multi-word-component-names",
+    "lint/nursery/useVueValidVBind": "https://biomejs.dev/linter/rules/use-vue-valid-v-bind",
+    "lint/nursery/useVueValidVElse": "https://biomejs.dev/linter/rules/use-vue-valid-v-else",
+    "lint/nursery/useVueValidVElseIf": "https://biomejs.dev/linter/rules/use-vue-valid-v-else-if",
+    "lint/nursery/useVueValidVFor": "https://biomejs.dev/linter/rules/use-vue-valid-v-for",
+    "lint/nursery/useVueValidVHtml": "https://biomejs.dev/linter/rules/use-vue-valid-v-html",
+    "lint/nursery/useVueValidVIf": "https://biomejs.dev/linter/rules/use-vue-valid-v-if",
+    "lint/nursery/useVueValidVModel": "https://biomejs.dev/linter/rules/use-vue-valid-v-model",
+    "lint/nursery/useVueValidVOn": "https://biomejs.dev/linter/rules/use-vue-valid-v-on",
     "lint/performance/noAccumulatingSpread": "https://biomejs.dev/linter/rules/no-accumulating-spread",
     "lint/performance/noAwaitInLoops": "https://biomejs.dev/linter/rules/no-await-in-loops",
     "lint/performance/noBarrelFile": "https://biomejs.dev/linter/rules/no-barrel-file",

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

@@ -7,6 +7,7 @@ pub mod no_continue;
 pub mod no_deprecated_imports;
 pub mod no_empty_source;
 pub mod no_floating_promises;
+pub mod no_for_in;
 pub mod no_import_cycles;
 pub mod no_increment_decrement;
 pub mod no_jsx_literals;
@@ -35,4 +36,4 @@ pub mod use_qwik_valid_lexical_scope;
 pub mod use_sorted_classes;
 pub mod use_vue_define_macros_order;
 pub mod use_vue_multi_word_component_names;
-declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_continue :: NoContinue , self :: no_deprecated_imports :: NoDeprecatedImports , self :: no_empty_source :: NoEmptySource , self :: no_floating_promises :: NoFloatingPromises , self :: no_import_cycles :: NoImportCycles , self :: no_increment_decrement :: NoIncrementDecrement , self :: no_jsx_literals :: NoJsxLiterals , self :: no_misused_promises :: NoMisusedPromises , self :: no_next_async_client_component :: NoNextAsyncClientComponent , self :: no_parameters_only_used_in_recursion :: NoParametersOnlyUsedInRecursion , self :: no_react_forward_ref :: NoReactForwardRef , self :: no_shadow :: NoShadow , self :: no_unknown_attribute :: NoUnknownAttribute , self :: no_unnecessary_conditions :: NoUnnecessaryConditions , self :: no_unresolved_imports :: NoUnresolvedImports , self :: no_unused_expressions :: NoUnusedExpressions , self :: no_useless_catch_binding :: NoUselessCatchBinding , self :: no_useless_undefined :: NoUselessUndefined , self :: no_vue_data_object_declaration :: NoVueDataObjectDeclaration , self :: no_vue_duplicate_keys :: NoVueDuplicateKeys , self :: no_vue_reserved_keys :: NoVueReservedKeys , self :: no_vue_reserved_props :: NoVueReservedProps , self :: use_array_sort_compare :: UseArraySortCompare , self :: use_consistent_arrow_return :: UseConsistentArrowReturn , self :: use_exhaustive_switch_cases :: UseExhaustiveSwitchCases , self :: use_explicit_type :: UseExplicitType , self :: use_max_params :: UseMaxParams , self :: use_qwik_method_usage :: UseQwikMethodUsage , self :: use_qwik_valid_lexical_scope :: UseQwikValidLexicalScope , self :: use_sorted_classes :: UseSortedClasses , self :: use_vue_define_macros_order :: UseVueDefineMacrosOrder , self :: use_vue_multi_word_component_names :: UseVueMultiWordComponentNames ,] } }
+declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_continue :: NoContinue , self :: no_deprecated_imports :: NoDeprecatedImports , self :: no_empty_source :: NoEmptySource , self :: no_floating_promises :: NoFloatingPromises , self :: no_for_in :: NoForIn , self :: no_import_cycles :: NoImportCycles , self :: no_increment_decrement :: NoIncrementDecrement , self :: no_jsx_literals :: NoJsxLiterals , self :: no_misused_promises :: NoMisusedPromises , self :: no_next_async_client_component :: NoNextAsyncClientComponent , self :: no_parameters_only_used_in_recursion :: NoParametersOnlyUsedInRecursion , self :: no_react_forward_ref :: NoReactForwardRef , self :: no_shadow :: NoShadow , self :: no_unknown_attribute :: NoUnknownAttribute , self :: no_unnecessary_conditions :: NoUnnecessaryConditions , self :: no_unresolved_imports :: NoUnresolvedImports , self :: no_unused_expressions :: NoUnusedExpressions , self :: no_useless_catch_binding :: NoUselessCatchBinding , self :: no_useless_undefined :: NoUselessUndefined , self :: no_vue_data_object_declaration :: NoVueDataObjectDeclaration , self :: no_vue_duplicate_keys :: NoVueDuplicateKeys , self :: no_vue_reserved_keys :: NoVueReservedKeys , self :: no_vue_reserved_props :: NoVueReservedProps , self :: use_array_sort_compare :: UseArraySortCompare , self :: use_consistent_arrow_return :: UseConsistentArrowReturn , self :: use_exhaustive_switch_cases :: UseExhaustiveSwitchCases , self :: use_explicit_type :: UseExplicitType , self :: use_max_params :: UseMaxParams , self :: use_qwik_method_usage :: UseQwikMethodUsage , self :: use_qwik_valid_lexical_scope :: UseQwikValidLexicalScope , self :: use_sorted_classes :: UseSortedClasses , self :: use_vue_define_macros_order :: UseVueDefineMacrosOrder , self :: use_vue_multi_word_component_names :: UseVueMultiWordComponentNames ,] } }

crates/biome_diagnostics_categories/src/categories.rs

@@ -0,0 +1,87 @@
+use biome_analyze::{
+    Ast, Rule, RuleDiagnostic, RuleSource, context::RuleContext, declare_lint_rule,
+};
+use biome_console::markup;
+use biome_js_syntax::JsForInStatement;
+use biome_rowan::AstNode;
+use biome_rule_options::no_for_in::NoForInOptions;
+
+declare_lint_rule! {
+    /// Disallow iterating using a for-in loop.
+    ///
+    /// A for-in loop (`for (const i in o)`) iterates over the properties of an Object. While it is legal to use for-in loops with array values, it is not common. There are several potential bugs with this:
+    ///
+    /// 1. It iterates over all enumerable properties, including non-index ones and the entire prototype chain. For example, [`RegExp.prototype.exec`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/exec) returns an array with additional properties, and `for-in` will iterate over them. Some libraries or even your own code may add additional methods to `Array.prototype` (either as polyfill or as custom methods), and if not done properly, they may be iterated over as well.
+    /// 2. It skips holes in the array. While sparse arrays are rare and advised against, they are still possible and your code should be able to handle them.
+    /// 3. The "index" is returned as a string, not a number. This can be caught by TypeScript, but can still lead to subtle bugs.
+    ///
+    /// You may have confused for-in with for-of, which iterates over the elements of the array. If you actually need the index, use a regular `for` loop or the `forEach` method.
+    ///
+    /// ## Examples
+    ///
+    /// ### Invalid
+    ///
+    /// ```js,expect_diagnostic
+    /// for (const i in array) {
+    ///   console.log(i, array[i]);
+    /// }
+    /// ```
+    ///
+    /// ### Valid
+    ///
+    /// ```js
+    /// for (const value of array) {
+    ///   console.log(value);
+    /// }
+    /// ```
+    /// ```js
+    /// for (let i = 0; i < array.length; i += 1) {
+    ///   console.log(i, array[i]);
+    /// }
+    /// ```
+    /// ```js
+    /// array.forEach((value, i) => {
+    ///   console.log(i, value);
+    /// });
+    /// ```
+    /// ```js
+    /// for (const [i, value] of array.entries()) {
+    ///   console.log(i, value);
+    /// }
+    /// ```
+    ///
+    pub NoForIn {
+        version: "next",
+        name: "noForIn",
+        language: "js",
+        recommended: false,
+        sources: &[RuleSource::EslintTypeScript("no-for-in-array").inspired()],
+    }
+}
+
+impl Rule for NoForIn {
+    type Query = Ast<JsForInStatement>;
+    type State = ();
+    type Signals = Option<Self::State>;
+    type Options = NoForInOptions;
+
+    fn run(_ctx: &RuleContext<Self>) -> Self::Signals {
+        Some(())
+    }
+
+    fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> {
+        let node = ctx.query();
+        Some(
+            RuleDiagnostic::new(
+                rule_category!(),
+                node.range(),
+                markup! {
+                    "Unexpected for-in loop."
+                },
+            )
+            .note(markup! {
+                "For-in loops are confusing and easy to misuse. You likely want to use a regular loop, for-of loop or forEach instead."
+            }),
+        )
+    }
+}

crates/biome_js_analyze/src/lint/nursery.rs

@@ -0,0 +1,9 @@
+const array = [];
+
+for (const i in array) {
+	console.log(array[i]);
+}
+
+for (const i in array) {
+	console.log(i, array[i]);
+}

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

@@ -0,0 +1,57 @@
+---
+source: crates/biome_js_analyze/tests/spec_tests.rs
+expression: invalid.js
+---
+# Input
+```js
+const array = [];
+
+for (const i in array) {
+	console.log(array[i]);
+}
+
+for (const i in array) {
+	console.log(i, array[i]);
+}
+
+```
+
+# Diagnostics
+```
+invalid.js:3:1 lint/nursery/noForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  i Unexpected for-in loop.
+  
+    1 │ const array = [];
+    2 │ 
+  > 3 │ for (const i in array) {
+      │ ^^^^^^^^^^^^^^^^^^^^^^^^
+  > 4 │ 	console.log(array[i]);
+  > 5 │ }
+      │ ^
+    6 │ 
+    7 │ for (const i in array) {
+  
+  i For-in loops are confusing and easy to misuse. You likely want to use a regular loop, for-of loop or forEach instead.
+  
+
+```
+
+```
+invalid.js:7:1 lint/nursery/noForIn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  i Unexpected for-in loop.
+  
+     5 │ }
+     6 │ 
+   > 7 │ for (const i in array) {
+       │ ^^^^^^^^^^^^^^^^^^^^^^^^
+   > 8 │ 	console.log(i, array[i]);
+   > 9 │ }
+       │ ^
+    10 │ 
+  
+  i For-in loops are confusing and easy to misuse. You likely want to use a regular loop, for-of loop or forEach instead.
+  
+
+```

crates/biome_js_analyze/tests/specs/nursery/noForIn/invalid.js

@@ -0,0 +1,18 @@
+/* should not generate diagnostics */
+const array = [];
+
+for (const value of array) {
+	console.log(value);
+}
+
+for (let i = 0; i < array.length; i += 1) {
+	console.log(i, array[i]);
+}
+
+array.forEach((value, i) => {
+	console.log(i, value);
+});
+
+for (const [i, value] of array.entries()) {
+	console.log(i, value);
+}

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

@@ -0,0 +1,26 @@
+---
+source: crates/biome_js_analyze/tests/spec_tests.rs
+expression: valid.js
+---
+# Input
+```js
+/* should not generate diagnostics */
+const array = [];
+
+for (const value of array) {
+	console.log(value);
+}
+
+for (let i = 0; i < array.length; i += 1) {
+	console.log(i, array[i]);
+}
+
+array.forEach((value, i) => {
+	console.log(i, value);
+});
+
+for (const [i, value] of array.entries()) {
+	console.log(i, value);
+}
+
+```