feat: add blank line group separator

Author: Conaclos

crates/biome_js_analyze/src/assist/source/organize_imports.rs

@@ -10,14 +10,33 @@ use crate::globals::is_node_builtin_module;
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub struct ImportGroups(Box<[ImportGroup]>);
 impl ImportGroups {
+    /// Returns `true` if no explicit group is set.
+    pub fn is_empty(&self) -> bool {
+        self.0.is_empty()
+    }
+
     /// Returns the index of the first group containing `candidate`.
     /// If no group contains `candidate`, then the returned value corresponds to the index of the implicit group.
     /// The index of the implicit group correspond to the number of groups.
-    pub fn index(&self, candidate: &ImportSourceCandidate) -> usize {
+    pub fn index(&self, candidate: &ImportSourceCandidate) -> u16 {
         self.0
             .iter()
             .position(|group| group.contains(candidate))
-            .unwrap_or(self.0.len())
+            .unwrap_or(self.0.len()) as u16
+    }
+
+    /// Returns how many blank lines must separate `first_group` and `second_group`.
+    pub fn separated_by_blank_line(&self, first_group: u16, second_group: u16) -> bool {
+        self.0
+            .get((first_group as usize)..(second_group as usize))
+            .is_some_and(|groups| {
+                groups.iter().any(|group| {
+                    matches!(
+                        group,
+                        ImportGroup::Predefined(PredefinedImportGroup::BlankLine)
+                    )
+                })
+            })
     }
 }
 
@@ -62,6 +81,8 @@ impl Deserializable for ImportGroup {
 #[derive(Clone, Debug, Deserializable, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 pub enum PredefinedImportGroup {
+    #[serde(rename = ":BLANK-LINE:")]
+    BlankLine,
     #[serde(rename = ":BUN:")]
     Bun,
     #[serde(rename = ":NODE:")]
@@ -71,6 +92,7 @@ impl PredefinedImportGroup {
     fn contains(&self, candidate: &ImportSourceCandidate) -> bool {
         let import_source = candidate.as_str();
         match self {
+            Self::BlankLine => false,
             Self::Bun => import_source == "bun" || import_source.starts_with("bun:"),
             Self::Node => {
                 import_source.starts_with("node:") || is_node_builtin_module(import_source)

crates/biome_js_analyze/src/assist/source/organize_imports/import_groups.rs

@@ -21,10 +21,10 @@ pub struct ImportKey {
     pub slot_index: u32,
 }
 impl ImportKey {
-    pub fn new(info: ImportInfo, groups: Option<&import_groups::ImportGroups>) -> Self {
+    pub fn new(info: ImportInfo, groups: &import_groups::ImportGroups) -> Self {
         let candidate = import_groups::ImportSourceCandidate::new(info.source.inner().0.text());
         Self {
-            group: groups.map_or(0, |groups| groups.index(&candidate) as u16),
+            group: groups.index(&candidate),
             source: info.source,
             has_no_attributes: info.has_no_attributes,
             kind: info.kind,

crates/biome_js_analyze/src/assist/source/organize_imports/import_key.rs

@@ -59,9 +59,6 @@ pub fn sort_import_specifiers(
     named_specifiers: JsNamedImportSpecifiers,
 ) -> Option<JsNamedImportSpecifiers> {
     let list = named_specifiers.specifiers();
-    if list.len() <= 1 {
-        return Some(named_specifiers);
-    }
     let mut last_has_separator = false;
     let mut sorted = Vec::with_capacity(list.len());
     for AstSeparatedElement {
@@ -117,11 +114,8 @@ pub fn are_export_specifiers_sorted(specifiers: &JsExportNamedFromSpecifierList)
 }
 
 pub fn sort_export_specifiers(
-    named_specifiers: JsExportNamedFromSpecifierList,
+    named_specifiers: &JsExportNamedFromSpecifierList,
 ) -> Option<JsExportNamedFromSpecifierList> {
-    if named_specifiers.len() <= 1 {
-        return Some(named_specifiers);
-    }
     let mut last_has_separator = false;
     let mut sorted = Vec::with_capacity(named_specifiers.len());
     for AstSeparatedElement {
@@ -178,9 +172,6 @@ pub fn are_import_attributes_sorted(attributes: &JsImportAssertion) -> Option<bo
 
 pub fn sort_attributes(attributes: JsImportAssertion) -> Option<JsImportAssertion> {
     let attributes_list = attributes.assertions();
-    if attributes_list.len() <= 1 {
-        return Some(attributes);
-    }
     let mut last_has_separator = false;
     let mut sorted = Vec::new();
     for AstSeparatedElement {

crates/biome_js_analyze/src/assist/source/organize_imports/specifiers_attributes.rs

@@ -1,13 +1,13 @@
 use biome_js_syntax::{JsLanguage, JsSyntaxNode, JsSyntaxTrivia};
 use biome_rowan::SyntaxTriviaPiece;
 
-pub fn leading_newline_count(syntax: &JsSyntaxNode) -> usize {
-    syntax.first_leading_trivia().map_or(0, |trivia| {
-        trivia
-            .pieces()
-            .take_while(|piece| piece.is_newline())
-            .count()
-    })
+pub fn leading_newlines(
+    syntax: &JsSyntaxNode,
+) -> impl Iterator<Item = SyntaxTriviaPiece<JsLanguage>> {
+    syntax
+        .first_leading_trivia()
+        .into_iter()
+        .flat_map(|trivia| trivia.pieces().take_while(|piece| piece.is_newline()))
 }
 
 /// Returns the index of the last blank line of `trivia`.

crates/biome_js_analyze/src/assist/source/organize_imports/util.rs

@@ -0,0 +1,3 @@
+import { test as testBun } from "bun:test"
+import { test as testNode } from "node:test"
+import bare from "bare"

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-sorted-imports-missing-blank-lines.js

@@ -0,0 +1,22 @@
+---
+source: crates/biome_js_analyze/tests/spec_tests.rs
+expression: custom-order-sorted-imports-missing-blank-lines.js
+---
+# Input
+```js
+import { test as testBun } from "bun:test"
+import { test as testNode } from "node:test"
+import bare from "bare"
+
+```
+
+# Actions
+```diff
+@@ -1,3 +1,5 @@
+ import { test as testBun } from "bun:test"
++
+ import { test as testNode } from "node:test"
++
+ import bare from "bare"
+
+```

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-sorted-imports-missing-blank-lines.js.snap

@@ -0,0 +1,20 @@
+{
+	"$schema": "../../../../../packages/@biomejs/biome/configuration_schema.json",
+	"assist": {
+		"actions": {
+			"source": {
+				"organizeImports": {
+					"level": "on",
+					"options": {
+                        "groups": [
+                            ":BUN:",
+							":BLANK-LINE:",
+                            ":NODE:",
+							":BLANK-LINE:"
+                        ]
+					}
+				}
+			}
+		}
+	}
+}

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-sorted-imports-missing-blank-lines.options.json

@@ -0,0 +1,3 @@
+import { test as testBun } from "bun:test"
+import { test as testNode } from "node:test"
+import path from "node:path"

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-unsorted-imports-missing-blank-lines.js

@@ -0,0 +1,22 @@
+---
+source: crates/biome_js_analyze/tests/spec_tests.rs
+expression: custom-order-unsorted-imports-missing-blank-lines.js
+---
+# Input
+```js
+import { test as testBun } from "bun:test"
+import { test as testNode } from "node:test"
+import path from "node:path"
+
+```
+
+# Actions
+```diff
+@@ -1,3 +1,4 @@
+ import { test as testBun } from "bun:test"
+-import { test as testNode } from "node:test"
++
+ import path from "node:path"
++import { test as testNode } from "node:test"
+
+```

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-unsorted-imports-missing-blank-lines.js.snap

@@ -0,0 +1,20 @@
+{
+	"$schema": "../../../../../packages/@biomejs/biome/configuration_schema.json",
+	"assist": {
+		"actions": {
+			"source": {
+				"organizeImports": {
+					"level": "on",
+					"options": {
+                        "groups": [
+                            ":BUN:",
+							":BLANK-LINE:",
+                            ":NODE:",
+							":BLANK-LINE:"
+                        ]
+					}
+				}
+			}
+		}
+	}
+}

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order-unsorted-imports-missing-blank-lines.options.json

@@ -16,16 +16,16 @@ import { test as testNode } from "@scopeB/lib"
 
 # Actions
 ```diff
-@@ -1,7 +1,7 @@
-+import { test as testNode } from "node:test"
+@@ -1,7 +1,8 @@
  import { test as testBun } from "bun:test"
--import { test as testNode } from "node:test"
+ import { test as testNode } from "node:test"
 -import { test as testNode } from "@scopeX/special/subpath"
 -import { test as testNode } from "@scopeX/special"
  import { test as testNode } from "@scopeX/lib"
-+import { test as testNode } from "@scopeB/lib"
- import { test as testNode } from "@scopeA/lib"
--import { test as testNode } from "@scopeB/lib"
+-import { test as testNode } from "@scopeA/lib"
++
+ import { test as testNode } from "@scopeB/lib"
++import { test as testNode } from "@scopeA/lib"
 +import { test as testNode } from "@scopeX/special"
 +import { test as testNode } from "@scopeX/special/subpath"
 

crates/biome_js_analyze/tests/specs/source/organizeImports/custom-order.js.snap

@@ -7,9 +7,10 @@
 					"level": "on",
 					"options": {
                         "groups": [
-                            ":NODE:",
                             ":BUN:",
+                            ":NODE:",
 							["@scopeX/**", "!@scopeX/special", "!@scopeX/special/**"],
+							":BLANK-LINE:",
 							"@scopeB/**",
 							"@scopeA/**"
                         ]