polish plugin catalog table display

Author: johnnygreco

packages/data-designer/src/data_designer/cli/controllers/plugin_catalog_controller.py

@@ -39,6 +39,9 @@
 from data_designer.config.utils.constants import NordColor
 
 NARROW_CATALOG_LAYOUT_WIDTH = 100
+CATALOG_TABLE_ROW_LEADING = 1
+CHECKMARK = "✓"
+X_MARK = "x"
 
 
 class PluginCatalogController:
@@ -66,14 +69,15 @@ def run_list(
         entries = self._list_entries_or_exit(catalog.alias, refresh=refresh, include_incompatible=include_incompatible)
 
         print_header("Data Designer Plugin Packages")
-        print_info(f"Catalog: {catalog.alias} ({catalog.url})")
         console.print()
 
         if not entries:
             self._display_empty_list_state(catalog.alias, include_incompatible=include_incompatible)
+            _print_catalog_reference(catalog)
             return
 
         self._display_catalog_entries(entries)
+        _print_catalog_reference(catalog)
 
     def run_search(
         self,
@@ -93,7 +97,6 @@ def run_search(
         )
 
         print_header("Data Designer Plugin Package Search")
-        print_info(f"Catalog: {catalog.alias} ({catalog.url})")
         print_info(f"Query: {query}")
         console.print()
 
@@ -103,9 +106,11 @@ def run_search(
                 catalog.alias,
                 include_incompatible=include_incompatible,
             )
+            _print_catalog_reference(catalog)
             return
 
         self._display_catalog_entries(entries)
+        _print_catalog_reference(catalog)
 
     def run_info(
         self,
@@ -530,15 +535,21 @@ def _suggest_entries(
             return []
 
     def _display_catalog_entries(self, entries: list[PluginCatalogEntry]) -> None:
+        installed_plugins = self.catalog_service.list_installed_plugins()
         if _console_width() < NARROW_CATALOG_LAYOUT_WIDTH:
-            self._display_catalog_entries_vertical(entries)
+            self._display_catalog_entries_vertical(entries, installed_plugins)
             return
 
-        table = Table(title="Catalog Plugin Packages", border_style=NordColor.NORD8.value)
+        table = Table(
+            title="Catalog Plugin Packages",
+            border_style=NordColor.NORD8.value,
+            leading=CATALOG_TABLE_ROW_LEADING,
+        )
         table.add_column("Package", style=NordColor.NORD14.value, no_wrap=True)
         table.add_column("Description", style=NordColor.NORD4.value)
         table.add_column("Runtime Plugins", style=NordColor.NORD9.value)
-        table.add_column("Compatible", style=NordColor.NORD13.value, no_wrap=True)
+        table.add_column("Compatible", style=NordColor.NORD13.value, justify="center", no_wrap=True)
+        table.add_column("Installed", style=NordColor.NORD14.value, justify="center", no_wrap=True)
         table.add_column("Docs", style=NordColor.NORD7.value)
 
         for package_entries in self.catalog_service.group_entries_by_package(entries).values():
@@ -549,12 +560,17 @@ def _display_catalog_entries(self, entries: list[PluginCatalogEntry]) -> None:
                 entry.package.name,
                 entry.description,
                 _format_runtime_plugins(package_entries),
-                "yes" if compatibility.is_compatible else "no",
+                _format_compatibility_marker(compatibility),
+                _format_installed_marker(package_entries, installed_plugins),
                 _format_docs_link(docs_url),
             )
         console.print(table)
 
-    def _display_catalog_entries_vertical(self, entries: list[PluginCatalogEntry]) -> None:
+    def _display_catalog_entries_vertical(
+        self,
+        entries: list[PluginCatalogEntry],
+        installed_plugins: list[InstalledPluginInfo],
+    ) -> None:
         for index, package_entries in enumerate(self.catalog_service.group_entries_by_package(entries).values()):
             entry = package_entries[0]
             compatibility = self.catalog_service.evaluate_compatibility(entry)
@@ -564,7 +580,8 @@ def _display_catalog_entries_vertical(self, entries: list[PluginCatalogEntry]) -
             console.print(Text(entry.package.name, style=f"bold {NordColor.NORD14.value}"))
             console.print(f"  Description: {entry.description}")
             console.print(f"  Runtime plugins: {_format_runtime_plugins(package_entries)}")
-            console.print(f"  Compatible: {'yes' if compatibility.is_compatible else 'no'}")
+            console.print(f"  Compatible: {_format_compatibility_marker(compatibility)}")
+            console.print(f"  Installed: {_format_installed_marker(package_entries, installed_plugins)}")
             if docs_url:
                 console.print(f"  Docs: {docs_url}")
 
@@ -606,6 +623,16 @@ def _display_commands(commands: list[list[str]]) -> None:
         console.print(f"    [bold]{shlex.join(command)}[/bold]")
 
 
+def _print_catalog_reference(catalog: PluginCatalogConfig) -> None:
+    console.print()
+    catalog_link = Text.assemble(
+        "  🗂️  Catalog: ",
+        (catalog.alias, Style(color=NordColor.NORD14.value, bold=True, link=catalog.url)),
+    )
+    console.print(catalog_link)
+    console.print()
+
+
 def _target_description(mode: str, project_root: str | None) -> str:
     if mode == "uv-project" and project_root is not None:
         return f"current uv project ({project_root})"
@@ -616,6 +643,31 @@ def _format_runtime_plugins(entries: list[PluginCatalogEntry]) -> str:
     return ", ".join(f"{entry.name} ({entry.plugin_type.value})" for entry in entries)
 
 
+def _format_checkmark(value: bool) -> str:
+    return CHECKMARK if value else ""
+
+
+def _format_compatibility_marker(compatibility: CompatibilityResult) -> str:
+    return CHECKMARK if compatibility.is_compatible else X_MARK
+
+
+def _format_installed_marker(
+    package_entries: list[PluginCatalogEntry],
+    installed_plugins: list[InstalledPluginInfo],
+) -> str:
+    return _format_checkmark(_package_entries_are_installed(package_entries, installed_plugins))
+
+
+def _package_entries_are_installed(
+    package_entries: list[PluginCatalogEntry],
+    installed_plugins: list[InstalledPluginInfo],
+) -> bool:
+    installed_entry_points = {(plugin.name, plugin.entry_point_value) for plugin in installed_plugins}
+    return bool(package_entries) and all(
+        (entry.entry_point.name, entry.entry_point.value) in installed_entry_points for entry in package_entries
+    )
+
+
 def _package_alias(package_name: str) -> str | None:
     canonical_package_name = canonicalize_name(package_name)
     if not canonical_package_name.startswith(DATA_DESIGNER_PLUGIN_PACKAGE_PREFIX):

packages/data-designer/tests/cli/controllers/test_plugin_catalog_controller.py

@@ -31,6 +31,7 @@ def controller(tmp_path: Path) -> PluginCatalogController:
     plugin_controller.catalog_service = MagicMock()
     plugin_controller.catalog_service.get_runtime_plugin_entries.return_value = []
     plugin_controller.catalog_service.suggest_entries.return_value = []
+    plugin_controller.catalog_service.list_installed_plugins.return_value = []
     plugin_controller.install_service = MagicMock()
     return plugin_controller
 
@@ -129,6 +130,10 @@ def test_run_list_renders_package_first_catalog_table(
         "data-designer-text-transform": package_entries,
     }
     controller.catalog_service.evaluate_compatibility.return_value = CompatibilityResult(True, [])
+    controller.catalog_service.list_installed_plugins.return_value = [
+        InstalledPluginInfo(name="text-column", entry_point_value="data_designer_text_transform.plugin:plugin"),
+        InstalledPluginInfo(name="text-processor", entry_point_value="data_designer_text_transform.plugin:plugin"),
+    ]
 
     controller.run_list(catalog_alias="local", include_incompatible=True)
 
@@ -137,19 +142,33 @@ def test_run_list_renders_package_first_catalog_table(
     ]
     assert printed_tables
     assert printed_tables[0].title == "Catalog Plugin Packages"
+    assert printed_tables[0].leading == 1
     assert [column.header for column in printed_tables[0].columns] == [
         "Package",
         "Description",
         "Runtime Plugins",
         "Compatible",
+        "Installed",
         "Docs",
     ]
     assert list(printed_tables[0].columns[1].cells) == ["Transform text records"]
-    docs_cell = list(printed_tables[0].columns[4].cells)[0]
+    assert list(printed_tables[0].columns[3].cells) == ["✓"]
+    assert list(printed_tables[0].columns[4].cells) == ["✓"]
+    docs_cell = list(printed_tables[0].columns[5].cells)[0]
     assert isinstance(docs_cell, Text)
     assert docs_cell.plain == "docs"
     assert docs_cell.style is not None
     assert docs_cell.style.link == "https://docs.example.test/plugins/data-designer-text-transform/"
+    catalog_footer = mock_console.print.call_args_list[-2].args[0]
+    assert isinstance(catalog_footer, Text)
+    assert catalog_footer.plain == "  🗂️  Catalog: local"
+    catalog_footer_spans = catalog_footer.spans
+    assert catalog_footer_spans
+    assert catalog_footer_spans[0].style is not None
+    assert (
+        catalog_footer_spans[0].style.link
+        == "https://raw.githubusercontent.com/acme/dd-plugins/main/catalog/plugins.json"
+    )
 
     rendered_output = StringIO()
     narrow_console = Console(
@@ -164,6 +183,59 @@ def test_run_list_renders_package_first_catalog_table(
     controller.catalog_service.group_entries_by_package.assert_called_once_with(package_entries)
 
 
+@patch("data_designer.cli.controllers.plugin_catalog_controller.console")
+def test_run_list_leaves_installed_column_empty_when_runtime_entry_points_are_missing(
+    mock_console: MagicMock,
+    controller: PluginCatalogController,
+) -> None:
+    package_entries = [
+        _entry(name="text-column", plugin_type="column-generator"),
+        _entry(name="text-processor", plugin_type="processor"),
+    ]
+    catalog = _catalog()
+    controller.catalog_service.get_catalog.return_value = catalog
+    controller.catalog_service.list_entries.return_value = package_entries
+    controller.catalog_service.group_entries_by_package.return_value = {
+        "data-designer-text-transform": package_entries,
+    }
+    controller.catalog_service.evaluate_compatibility.return_value = CompatibilityResult(True, [])
+    controller.catalog_service.list_installed_plugins.return_value = [
+        InstalledPluginInfo(name="text-column", entry_point_value="data_designer_text_transform.plugin:plugin"),
+    ]
+
+    controller.run_list(catalog_alias="local", include_incompatible=True)
+
+    printed_tables = [
+        call.args[0] for call in mock_console.print.call_args_list if call.args and isinstance(call.args[0], Table)
+    ]
+    assert list(printed_tables[0].columns[4].cells) == [""]
+
+
+@patch("data_designer.cli.controllers.plugin_catalog_controller.console")
+def test_run_list_marks_incompatible_packages_with_x(
+    mock_console: MagicMock,
+    controller: PluginCatalogController,
+) -> None:
+    entry = _entry()
+    catalog = _catalog()
+    controller.catalog_service.get_catalog.return_value = catalog
+    controller.catalog_service.list_entries.return_value = [entry]
+    controller.catalog_service.group_entries_by_package.return_value = {
+        "data-designer-text-transform": [entry],
+    }
+    controller.catalog_service.evaluate_compatibility.return_value = CompatibilityResult(
+        False,
+        ["Data Designer 0.5.7 does not satisfy >=99.0"],
+    )
+
+    controller.run_list(catalog_alias="local", include_incompatible=True)
+
+    printed_tables = [
+        call.args[0] for call in mock_console.print.call_args_list if call.args and isinstance(call.args[0], Table)
+    ]
+    assert list(printed_tables[0].columns[3].cells) == ["x"]
+
+
 @patch("data_designer.cli.controllers.plugin_catalog_controller.console")
 def test_run_list_uses_vertical_layout_in_narrow_terminals(
     mock_console: MagicMock,
@@ -181,13 +253,19 @@ def test_run_list_uses_vertical_layout_in_narrow_terminals(
         "data-designer-retrieval-sdg": package_entries,
     }
     controller.catalog_service.evaluate_compatibility.return_value = CompatibilityResult(True, [])
+    controller.catalog_service.list_installed_plugins.return_value = [
+        InstalledPluginInfo(name="document-chunker", entry_point_value="data_designer_text_transform.plugin:plugin"),
+        InstalledPluginInfo(name="embedding-dedup", entry_point_value="data_designer_text_transform.plugin:plugin"),
+    ]
 
     controller.run_list(catalog_alias="local")
 
     printed_tables = [
         call.args[0] for call in mock_console.print.call_args_list if call.args and isinstance(call.args[0], Table)
     ]
     assert printed_tables == []
+    mock_console.print.assert_any_call("  Compatible: ✓")
+    mock_console.print.assert_any_call("  Installed: ✓")
     mock_console.print.assert_any_call(
         "  Runtime plugins: document-chunker (seed-reader), embedding-dedup (column-generator)"
     )