feat(workspace): add debug_type_info

ematipico · ematipico · commit 9d8ddf128784 · 2025-04-27T17:16:20.000+01:00
diff --git a/crates/biome_js_type_info/src/format_type_info.rs b/crates/biome_js_type_info/src/format_type_info.rs
@@ -261,15 +261,15 @@ impl Format<FormatTypeContext> for FunctionParameter {
             });
             write!(
                 f,
-                [&group(&format_args![
+                [&group(&block_indent(&format_args![
                     optional,
                     space(),
                     self.name.as_ref().unwrap_or(&Text::Static("(unnamed)")),
                     text(":"),
                     space(),
                     &self.ty,
                     bindings
-                ])]
+                ]))]
             )
         }
     }
@@ -653,7 +653,7 @@ impl Format<FormatTypeContext> for FmtFunctionParameters<'_> {
         }
 
         let function_parameters = format_with(|f| {
-            let separator = format_with(|f| write!(f, [&format_args![text(","), space()]]));
+            let separator = format_with(|f| write!(f, [&format_args![soft_line_break_or_space()]]));
             let mut joiner = f.join_with(separator);
             for part in self.0 {
                 joiner.entry(&format_args![part]);
@@ -679,19 +679,15 @@ impl Format<FormatTypeContext> for FmtFunctionParameterBindings<'_> {
         }
 
         let function_parameters = format_with(|f| {
-            let separator = format_with(|f| write!(f, [&format_args![text(","), space()]]));
+            let separator =
+                format_with(|f| write!(f, [&format_args![text(","), soft_line_break_or_space()]]));
             let mut joiner = f.join_with(separator);
             for part in self.0 {
                 joiner.entry(&format_args![&part.name, text(":"), &part.ty]);
             }
             joiner.finish()
         });
-        write!(
-            f,
-            [&format_args![&group(&soft_block_indent(
-                &function_parameters
-            )),]]
-        )
+        write!(f, [&function_parameters])
     }
 }
 
diff --git a/crates/biome_js_type_info/tests/snapshots/infer_type_of_function_with_destructured_arguments.snap b/crates/biome_js_type_info/tests/snapshots/infer_type_of_function_with_destructured_arguments.snap
@@ -1,6 +1,7 @@
 ---
 source: crates/biome_js_type_info/tests/utils/mod.rs
 expression: content
+snapshot_kind: text
 ---
 ```ts
 function destruct(
@@ -14,20 +15,7 @@ function destruct(
 sync Function "destruct" {
   accepts: {
     params: [
-      required (unnamed): Object {
-        prototype: No prototype
-        members: {TypeMembers(
-          Property(
-            [a, required]
-            Type(number)
-          )
-          Property(
-            [b, required]
-            Type(string)
-          )
-        )}
-      } (bindings:
-        a:Object {
+        required (unnamed): Object {
           prototype: No prototype
           members: {TypeMembers(
             Property(
@@ -39,7 +27,7 @@ sync Function "destruct" {
               Type(string)
             )
           )}
-        }.a, b:Object {
+        } (bindings: a:Object {
           prototype: No prototype
           members: {TypeMembers(
             Property(
@@ -51,19 +39,31 @@ sync Function "destruct" {
               Type(string)
             )
           )}
-        }.b
-      ), required (unnamed): "Array" {
-        resolved: unknown
-        type_args: boolean
-      } (bindings:
-        first:"Array" {
+        }.a,
+        b:Object {
+          prototype: No prototype
+          members: {TypeMembers(
+            Property(
+              [a, required]
+              Type(number)
+            )
+            Property(
+              [b, required]
+              Type(string)
+            )
+          )}
+        }.b)
+        required (unnamed): "Array" {
+          resolved: unknown
+          type_args: boolean
+        } (bindings: first:"Array" {
           resolved: unknown
           type_args: boolean
-        }[0], rest:[(1 others)..."Array" {
+        }[0],
+        rest:[(1 others)..."Array" {
           resolved: unknown
           type_args: boolean
-        }]
-      )
+        }])
     ]
     type_args: []
   }
diff --git a/crates/biome_service/src/file_handlers/astro.rs b/crates/biome_service/src/file_handlers/astro.rs
@@ -80,6 +80,7 @@ impl ExtensionHandler for AstroFileHandler {
                 debug_syntax_tree: None,
                 debug_control_flow: None,
                 debug_formatter_ir: None,
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/css.rs b/crates/biome_service/src/file_handlers/css.rs
@@ -328,6 +328,7 @@ impl ExtensionHandler for CssFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: None,
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/graphql.rs b/crates/biome_service/src/file_handlers/graphql.rs
@@ -275,6 +275,7 @@ impl ExtensionHandler for GraphqlFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: None,
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/grit.rs b/crates/biome_service/src/file_handlers/grit.rs
@@ -247,6 +247,7 @@ impl ExtensionHandler for GritFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: None,
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/html.rs b/crates/biome_service/src/file_handlers/html.rs
@@ -206,6 +206,7 @@ impl ExtensionHandler for HtmlFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: None,
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/javascript.rs b/crates/biome_service/src/file_handlers/javascript.rs
@@ -47,11 +47,13 @@ use biome_js_formatter::format_node;
 use biome_js_parser::JsParserOptions;
 use biome_js_semantic::{SemanticModelOptions, semantic_model};
 use biome_js_syntax::{
-    AnyJsRoot, JsFileSource, JsLanguage, JsSyntaxNode, LanguageVariant, TextRange, TextSize,
+    AnyJsRoot, JsClassDeclaration, JsClassExpression, JsFileSource, JsFunctionDeclaration,
+    JsLanguage, JsSyntaxNode, JsVariableDeclarator, LanguageVariant, TextRange, TextSize,
     TokenAtOffset,
 };
+use biome_js_type_info::Type;
 use biome_parser::AnyParse;
-use biome_rowan::{AstNode, BatchMutationExt, Direction, NodeCache};
+use biome_rowan::{AstNode, BatchMutationExt, Direction, NodeCache, WalkEvent};
 use camino::Utf8Path;
 use serde::{Deserialize, Serialize};
 use std::borrow::Cow;
@@ -481,6 +483,7 @@ impl ExtensionHandler for JsFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: Some(debug_control_flow),
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: Some(debug_type_info),
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
@@ -630,6 +633,37 @@ fn debug_formatter_ir(
     Ok(root_element.to_string())
 }
 
+fn debug_type_info(_path: &BiomePath, parse: AnyParse) -> Result<String, WorkspaceError> {
+    let tree: AnyJsRoot = parse.tree();
+    let mut result = String::new();
+    let preorder = tree.syntax().preorder();
+
+    for event in preorder {
+        match event {
+            WalkEvent::Enter(node) => {
+                if let Some(node) = JsVariableDeclarator::cast_ref(&node) {
+                    if let Some(ty) = Type::from_js_variable_declarator(&node) {
+                        result.push_str(&ty.to_string());
+                        result.push('\n');
+                    }
+                } else if let Some(function) = JsFunctionDeclaration::cast_ref(&node) {
+                    result.push_str(&Type::from_js_function_declaration(&function).to_string());
+                    result.push('\n');
+                } else if let Some(class) = JsClassDeclaration::cast_ref(&node) {
+                    result.push_str(&Type::from_js_class_declaration(&class).to_string());
+                    result.push('\n');
+                } else if let Some(expression) = JsClassExpression::cast_ref(&node) {
+                    result.push_str(&Type::from_js_class_expression(&expression).to_string());
+                    result.push('\n');
+                }
+            }
+            WalkEvent::Leave(_) => {}
+        }
+    }
+
+    Ok(result)
+}
+
 pub(crate) fn lint(params: LintParams) -> LintResults {
     let _ =
         debug_span!("Linting JavaScript file", path =? params.path, language =? params.language)
diff --git a/crates/biome_service/src/file_handlers/json.rs b/crates/biome_service/src/file_handlers/json.rs
@@ -327,6 +327,7 @@ impl ExtensionHandler for JsonFileHandler {
                 debug_syntax_tree: Some(debug_syntax_tree),
                 debug_control_flow: None,
                 debug_formatter_ir: Some(debug_formatter_ir),
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/mod.rs b/crates/biome_service/src/file_handlers/mod.rs
@@ -450,6 +450,7 @@ type DebugFormatterIR = fn(
     AnyParse,
     WorkspaceSettingsHandle,
 ) -> Result<String, WorkspaceError>;
+type DebugTypeInfo = fn(&BiomePath, AnyParse) -> Result<String, WorkspaceError>;
 
 #[derive(Default)]
 pub struct DebugCapabilities {
@@ -459,6 +460,8 @@ pub struct DebugCapabilities {
     pub(crate) debug_control_flow: Option<DebugControlFlow>,
     /// Prints the formatter IR
     pub(crate) debug_formatter_ir: Option<DebugFormatterIR>,
+    /// Prints the type info
+    pub(crate) debug_type_info: Option<DebugTypeInfo>,
 }
 
 #[derive(Debug)]
diff --git a/crates/biome_service/src/file_handlers/svelte.rs b/crates/biome_service/src/file_handlers/svelte.rs
@@ -93,6 +93,7 @@ impl ExtensionHandler for SvelteFileHandler {
                 debug_syntax_tree: None,
                 debug_control_flow: None,
                 debug_formatter_ir: None,
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/file_handlers/vue.rs b/crates/biome_service/src/file_handlers/vue.rs
@@ -93,6 +93,7 @@ impl ExtensionHandler for VueFileHandler {
                 debug_syntax_tree: None,
                 debug_control_flow: None,
                 debug_formatter_ir: None,
+                debug_type_info: None,
             },
             analyzer: AnalyzerCapabilities {
                 lint: Some(lint),
diff --git a/crates/biome_service/src/snapshots/biome_service__workspace__tests__debug_type_info.snap b/crates/biome_service/src/snapshots/biome_service__workspace__tests__debug_type_info.snap
@@ -0,0 +1,22 @@
+---
+source: crates/biome_service/src/workspace.tests.rs
+expression: result.unwrap()
+snapshot_kind: text
+---
+sync Function "foo" {
+  accepts: {
+    params: [
+        required name: string (bindings: name:string)
+        required age: number (bindings: age:number)
+    ]
+    type_args: []
+  }
+  returns: "Person" {
+    resolved: unknown
+    type_args: No types
+  }
+}
+"Person" {
+  extends: none
+  type_args: []
+}
diff --git a/crates/biome_service/src/workspace.rs b/crates/biome_service/src/workspace.rs
@@ -634,6 +634,14 @@ pub struct GetControlFlowGraphParams {
     pub cursor: TextSize,
 }
 
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct GetTypeInfoParams {
+    pub project_key: ProjectKey,
+    pub path: BiomePath,
+}
+
 #[derive(Debug, serde::Serialize, serde::Deserialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[serde(rename_all = "camelCase")]
@@ -1152,6 +1160,10 @@ pub trait Workspace: Send + Sync + RefUnwindSafe {
     /// document.
     fn get_formatter_ir(&self, params: GetFormatterIRParams) -> Result<String, WorkspaceError>;
 
+    /// Returns a textual, debug representation of the control flow graph at a
+    /// given position in the document.
+    fn get_type_info(&self, params: GetTypeInfoParams) -> Result<String, WorkspaceError>;
+
     /// Returns the content of a given file.
     fn get_file_content(&self, params: GetFileContentParams) -> Result<String, WorkspaceError>;
 
@@ -1298,6 +1310,13 @@ impl<'app, W: Workspace + ?Sized> FileGuard<'app, W> {
             })
     }
 
+    pub fn get_type_info(&self) -> Result<String, WorkspaceError> {
+        self.workspace.get_type_info(GetTypeInfoParams {
+            project_key: self.project_key,
+            path: self.path.clone(),
+        })
+    }
+
     pub fn change_file(&self, version: i32, content: String) -> Result<(), WorkspaceError> {
         self.workspace.change_file(ChangeFileParams {
             project_key: self.project_key,
diff --git a/crates/biome_service/src/workspace.tests.rs b/crates/biome_service/src/workspace.tests.rs
@@ -7,7 +7,7 @@ use biome_configuration::{Configuration, FilesConfiguration};
 use biome_fs::{BiomePath, MemoryFileSystem};
 use biome_js_syntax::{JsFileSource, TextSize};
 use camino::Utf8PathBuf;
-use insta::assert_debug_snapshot;
+use insta::{assert_debug_snapshot, assert_snapshot};
 
 use crate::file_handlers::DocumentFileSource;
 use crate::projects::ProjectKey;
@@ -630,3 +630,37 @@ fn test_order() {
         assert!(items[0] < items[1], "{} < {}", items[0], items[1]);
     }
 }
+
+#[test]
+fn debug_type_info() {
+    let (workspace, project_key) = create_server();
+
+    let file = FileGuard::open(
+        workspace.as_ref(),
+        OpenFileParams {
+            project_key,
+            path: BiomePath::new("file.ts"),
+            content: FileContent::from_client(
+                r#"
+function foo(name: string, age: number): Person {
+    return new Person(string, age)
+}
+class Person {
+    #name: string
+    #age: number
+    constructor(name: string, age: number) {
+        this.#name = name;
+        this.#age = age;
+    }
+}
+"#,
+            ),
+            document_file_source: None,
+            persist_node_cache: false,
+        },
+    )
+    .unwrap();
+    let result = file.get_type_info();
+    assert!(result.is_ok());
+    assert_snapshot!(result.unwrap());
+}
diff --git a/crates/biome_service/src/workspace/client.rs b/crates/biome_service/src/workspace/client.rs
diff --git a/crates/biome_service/src/workspace/server.rs b/crates/biome_service/src/workspace/server.rs
