feat(vscode): add info to hover

Author: benfdking

sqlmesh/lsp/description.py

@@ -0,0 +1,30 @@
+from sqlmesh.core.model.definition import (
+    ExternalModel,
+    PythonModel,
+    SeedModel,
+    SqlModel,
+)
+import typing as t
+
+
+def generate_markdown_description(
+    model: t.Union[SqlModel, ExternalModel, PythonModel, SeedModel],
+) -> t.Optional[str]:
+    columns = model.columns_to_types
+    column_descriptions = model.column_descriptions
+
+    columns_table = (
+        "\n".join(
+            [
+                f"| {column} | {column_type} | {column_descriptions.get(column, '')} |"
+                for column, column_type in columns.items()
+            ]
+        )
+        if columns
+        else ""
+    )
+
+    table_header = "\n\n| Column | Type | Description |\n|--------|------|-------------|\n"
+    return (
+        f"{model.description}{table_header}{columns_table}" if columns_table else model.description
+    )

sqlmesh/lsp/main.py

@@ -239,11 +239,12 @@ def hover(ls: LanguageServer, params: types.HoverParams) -> t.Optional[types.Hov
                 if not references:
                     return None
                 reference = references[0]
-                if not reference.description:
+                if not reference.markdown_description:
                     return None
                 return types.Hover(
                     contents=types.MarkupContent(
-                        kind=types.MarkupKind.Markdown, value=reference.description
+                        kind=types.MarkupKind.Markdown,
+                        value=reference.markdown_description,
                     ),
                     range=reference.range,
                 )

sqlmesh/lsp/reference.py

@@ -5,6 +5,7 @@
 from sqlmesh.core.model.definition import SqlModel
 from sqlmesh.lsp.context import LSPContext, ModelTarget, AuditTarget
 from sqlglot import exp
+from sqlmesh.lsp.description import generate_markdown_description
 from sqlmesh.lsp.uri import URI
 from sqlmesh.utils.pydantic import PydanticModel
 
@@ -16,12 +17,12 @@ class Reference(PydanticModel):
     Attributes:
         range: The range of the reference in the source file
         uri: The uri of the referenced model
-        description: The description of the referenced model
+        markdown_description: The markdown description of the referenced model
     """
 
     range: Range
     uri: str
-    description: t.Optional[str] = None
+    markdown_description: t.Optional[str] = None
 
 
 def by_position(position: Position) -> t.Callable[[Reference], bool]:
@@ -176,11 +177,13 @@ def get_model_definitions_for_a_path(
             catalog_or_db_range = _range_from_token_position_details(catalog_or_db_meta, read_file)
             start_pos = catalog_or_db_range.start
 
+        description = generate_markdown_description(referenced_model)
+
         references.append(
             Reference(
                 uri=referenced_model_uri.value,
                 range=Range(start=start_pos, end=end_pos),
-                description=referenced_model.description,
+                markdown_description=description,
             )
         )
 

tests/lsp/test_reference.py

@@ -60,7 +60,19 @@ def test_reference_with_alias() -> None:
 
     assert references[0].uri.endswith("orders.py")
     assert get_string_from_range(read_file, references[0].range) == "sushi.orders"
-    assert references[0].description == "Table of sushi orders."
+    assert (
+        references[0].markdown_description
+        == """Table of sushi orders.
+
+| Column | Type | Description |
+|--------|------|-------------|
+| id | INT |  |
+| customer_id | INT |  |
+| waiter_id | INT |  |
+| start_ts | INT |  |
+| end_ts | INT |  |
+| event_date | DATE |  |"""
+    )
     assert references[1].uri.endswith("order_items.py")
     assert get_string_from_range(read_file, references[1].range) == "sushi.order_items"
     assert references[2].uri.endswith("items.py")