move jsdoc comment into separate crate

Author: minht11

.changeset/honest-bikes-smell.md

@@ -2,4 +2,4 @@
 "@biomejs/biome": minor
 ---
 
-Add [useSingleJsDocAsterisk](https://biomejs.dev/linter/rules/use-single-js-doc-asterisk/)
+Add [useSingleJsDocAsterisk](https://biomejs.dev/linter/rules/use-single-js-doc-asterisk/) which enforces JSDoc comment lines to start with a single asterisk.

Cargo.lock

@@ -140,6 +140,7 @@ biome_js_semantic            = { version = "0.5.7", path = "./crates/biome_js_se
 biome_js_syntax              = { version = "0.5.7", path = "./crates/biome_js_syntax" }
 biome_js_type_info           = { version = "0.0.1", path = "./crates/biome_js_type_info" }
 biome_js_type_info_macros    = { version = "0.0.1", path = "./crates/biome_js_type_info_macros" }
+biome_jsdoc_comment          = { version = "0.0.1", path = "./crates/biome_jsdoc_comment" }
 biome_json_analyze           = { version = "0.5.7", path = "./crates/biome_json_analyze" }
 biome_json_factory           = { version = "0.5.7", path = "./crates/biome_json_factory" }
 biome_json_formatter         = { version = "0.5.7", path = "./crates/biome_json_formatter" }

Cargo.toml

@@ -24,6 +24,7 @@ biome_js_factory         = { workspace = true }
 biome_js_semantic        = { workspace = true }
 biome_js_syntax          = { workspace = true }
 biome_js_type_info       = { workspace = true }
+biome_jsdoc_comment      = { workspace = true }
 biome_module_graph       = { workspace = true }
 biome_package            = { workspace = true }
 biome_project_layout     = { workspace = true }

crates/biome_js_analyze/Cargo.toml

@@ -3,7 +3,7 @@ use biome_analyze::{
 };
 use biome_console::markup;
 use biome_js_syntax::{JsModule, JsSyntaxToken};
-use biome_module_graph::JsdocComment;
+use biome_jsdoc_comment::JsdocComment;
 use biome_rowan::{
     AstNode, BatchMutationExt, Direction, TextLen, TextRange, TextSize, TriviaPiece,
 };
@@ -286,12 +286,9 @@ fn get_invalid_jsdoc_last_line(text: &str) -> Option<InvalidJsDocLineIndexes> {
             continue;
         }
 
-        if char_is_whitespace(b) {
-            continue;
+        if !char_is_whitespace(b) {
+            break;
         }
-
-        // Found non-whitespace character
-        break;
     }
 
     Some(InvalidJsDocLineIndexes {

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

@@ -0,0 +1,20 @@
+[package]
+authors.workspace    = true
+categories.workspace = true
+description          = "JSDoc comment handling helpers"
+edition.workspace    = true
+homepage.workspace   = true
+keywords.workspace   = true
+license.workspace    = true
+name                 = "biome_jsdoc_comment"
+repository.workspace = true
+version              = "0.0.1"
+
+[lints]
+workspace = true
+
+[dependencies]
+biome_formatter    = { workspace = true }
+biome_js_syntax    = { workspace = true }
+biome_js_type_info = { workspace = true }
+biome_rowan        = { workspace = true }

crates/biome_jsdoc_comment/Cargo.toml

@@ -0,0 +1,36 @@
+use crate::JsdocComment;
+use biome_formatter::prelude::*;
+use biome_formatter::{format_args, write};
+use biome_js_type_info::FormatTypeContext;
+use biome_rowan::TextSize;
+use std::ops::Deref;
+
+impl Format<FormatTypeContext> for JsdocComment {
+    fn fmt(
+        &self,
+        f: &mut biome_formatter::formatter::Formatter<FormatTypeContext>,
+    ) -> FormatResult<()> {
+        let comment = self.deref();
+
+        let comment = format_with(|f| {
+            let mut joiner = f.join_with(hard_line_break());
+            comment.lines().for_each(|line| {
+                joiner.entry(&format_args![dynamic_text(
+                    line.trim(),
+                    TextSize::default()
+                ),]);
+            });
+            joiner.finish()
+        });
+
+        write!(
+            f,
+            [&format_args![
+                text("JsDoc"),
+                text("("),
+                block_indent(&comment),
+                text(")")
+            ]]
+        )
+    }
+}

crates/biome_jsdoc_comment/src/format_jsdoc_comment.rs

@@ -0,0 +1,6 @@
+#![deny(clippy::use_self)]
+
+mod format_jsdoc_comment;
+mod jsdoc_comment;
+
+pub use jsdoc_comment::JsdocComment;

crates/biome_module_graph/src/jsdoc_comment.rs renamed to crates/biome_jsdoc_comment/src/jsdoc_comment.rs

@@ -19,6 +19,7 @@ biome_fs             = { workspace = true }
 biome_js_semantic    = { workspace = true }
 biome_js_syntax      = { workspace = true }
 biome_js_type_info   = { workspace = true }
+biome_jsdoc_comment  = { workspace = true }
 biome_package        = { workspace = true }
 biome_project_layout = { workspace = true }
 biome_rowan          = { workspace = true }

crates/biome_jsdoc_comment/src/lib.rs

@@ -1,5 +1,5 @@
 use crate::js_module_info::{Exports, Imports};
-use crate::{JsExport, JsImport, JsModuleInfo, JsOwnExport, JsReexport, JsdocComment};
+use crate::{JsExport, JsImport, JsModuleInfo, JsOwnExport, JsReexport};
 use biome_formatter::prelude::*;
 use biome_formatter::{format_args, write};
 use biome_js_type_info::FormatTypeContext;
@@ -315,36 +315,6 @@ impl Format<FormatTypeContext> for JsOwnExport {
     }
 }
 
-impl Format<FormatTypeContext> for JsdocComment {
-    fn fmt(
-        &self,
-        f: &mut biome_formatter::formatter::Formatter<FormatTypeContext>,
-    ) -> FormatResult<()> {
-        let comment = self.deref();
-
-        let comment = format_with(|f| {
-            let mut joiner = f.join_with(hard_line_break());
-            comment.lines().for_each(|line| {
-                joiner.entry(&format_args![dynamic_text(
-                    line.trim(),
-                    TextSize::default()
-                ),]);
-            });
-            joiner.finish()
-        });
-
-        write!(
-            f,
-            [&format_args![
-                text("JsDoc"),
-                text("("),
-                block_indent(&comment),
-                text(")")
-            ]]
-        )
-    }
-}
-
 impl Format<FormatTypeContext> for JsImport {
     fn fmt(
         &self,

crates/biome_module_graph/Cargo.toml

@@ -12,9 +12,10 @@ use biome_js_type_info::{
     GLOBAL_RESOLVER, GLOBAL_UNKNOWN_ID, ImportSymbol, ResolvedPath, ResolvedTypeId, Type, TypeData,
     TypeId, TypeReference, TypeReferenceQualifier, TypeResolver, TypeResolverLevel,
 };
+use biome_jsdoc_comment::JsdocComment;
 use biome_rowan::{AstNode, Text, TextRange, TokenText};
 
-use crate::{ModuleGraph, jsdoc_comment::JsdocComment};
+use crate::ModuleGraph;
 
 use binding::{BindingId, JsBindingData};
 use scope::{JsScope, JsScopeData};

crates/biome_module_graph/src/format_module_graph.rs

@@ -3,10 +3,9 @@ use std::sync::Arc;
 use biome_js_semantic::ScopeId;
 use biome_js_syntax::{AnyJsDeclaration, JsImport, JsSyntaxNode, JsVariableKind, TextRange};
 use biome_js_type_info::{TypeId, TypeReference};
+use biome_jsdoc_comment::JsdocComment;
 use biome_rowan::{AstNode, Text, TextSize};
 
-use crate::jsdoc_comment::JsdocComment;
-
 use super::{JsModuleInfoInner, scope::JsScope};
 
 #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)]

crates/biome_module_graph/src/js_module_info.rs

@@ -14,13 +14,13 @@ use biome_js_type_info::{
     TypeId, TypeImportQualifier, TypeReference, TypeReferenceQualifier, TypeResolver,
     TypeResolverLevel,
 };
+use biome_jsdoc_comment::JsdocComment;
 use biome_rowan::{AstNode, Text, TextSize, TokenText};
 use rust_lapper::{Interval, Lapper};
 use rustc_hash::FxHashMap;
 
-use crate::{
-    js_module_info::binding::{JsBindingReference, JsBindingReferenceKind, JsDeclarationKind},
-    jsdoc_comment::JsdocComment,
+use crate::js_module_info::binding::{
+    JsBindingReference, JsBindingReferenceKind, JsDeclarationKind,
 };
 
 use super::{

crates/biome_module_graph/src/js_module_info/binding.rs

@@ -6,13 +6,13 @@ use biome_js_syntax::{
     JsExportNamedSpecifierList, JsIdentifierBinding, JsVariableDeclaratorList, unescape_js_string,
 };
 use biome_js_type_info::{ImportSymbol, TypeData, TypeResolver};
+use biome_jsdoc_comment::JsdocComment;
 use biome_rowan::{AstNode, TokenText, WalkEvent};
 use camino::{Utf8Path, Utf8PathBuf};
 use oxc_resolver::{ResolveError, ResolverGeneric};
 
 use crate::{
-    JsExport, JsImport, JsModuleInfo, JsOwnExport, JsReexport, jsdoc_comment::JsdocComment,
-    resolver_cache::ResolverCache,
+    JsExport, JsImport, JsModuleInfo, JsOwnExport, JsReexport, resolver_cache::ResolverCache,
 };
 
 use super::{ResolvedPath, collector::JsModuleInfoCollector};

crates/biome_module_graph/src/js_module_info/collector.rs

@@ -2,7 +2,6 @@
 
 mod format_module_graph;
 mod js_module_info;
-mod jsdoc_comment;
 mod module_graph;
 mod resolver_cache;
 
@@ -11,5 +10,4 @@ pub use biome_js_type_info::{ImportSymbol, ResolvedPath};
 pub use js_module_info::{
     AdHocScopeResolver, JsExport, JsImport, JsModuleInfo, JsOwnExport, JsReexport,
 };
-pub use jsdoc_comment::JsdocComment;
 pub use module_graph::{ModuleGraph, SUPPORTED_EXTENSIONS};

crates/biome_module_graph/src/js_module_info/visitor.rs

@@ -6,12 +6,13 @@ use crate::snap::ModuleGraphSnapshot;
 use biome_deserialize::json::deserialize_from_json_str;
 use biome_fs::{BiomePath, FileSystem, MemoryFileSystem, OsFileSystem};
 use biome_js_type_info::{Type, TypeResolver};
+use biome_jsdoc_comment::JsdocComment;
 use biome_json_parser::JsonParserOptions;
 use biome_json_value::JsonString;
+use biome_module_graph::JsExport;
 use biome_module_graph::{
     AdHocScopeResolver, ImportSymbol, JsImport, JsReexport, ModuleGraph, ResolvedPath,
 };
-use biome_module_graph::{JsExport, JsdocComment};
 use biome_package::{Dependencies, PackageJson, Version};
 use biome_project_layout::ProjectLayout;
 use biome_rowan::Text;