[dg] Remove dg list component-type

Author: smackesey

python_modules/libraries/dagster-dg/dagster_dg/cli/list.py

@@ -145,27 +145,6 @@ def _all_plugins_object_table(
     type=click.Choice(["component", "scaffold-target"]),
     help="Filter by object type.",
 )
-@dg_global_options
-@cli_telemetry_wrapper
-def list_plugins_command(
-    name_only: bool,
-    package: Optional[str],
-    feature: Optional[PluginObjectFeature],
-    **global_options: object,
-) -> None:
-    """List dg plugins and their corresponding objects in the current Python environment."""
-    cli_config = normalize_cli_config(global_options, click.get_current_context())
-    dg_context = DgContext.for_defined_registry_environment(Path.cwd(), cli_config)
-    registry = RemotePluginRegistry.from_dg_context(dg_context)
-
-    if package:
-        table = _plugin_object_table(registry.get_objects(package, feature))
-    else:
-        table = _all_plugins_object_table(registry, name_only, feature=feature)
-    Console().print(table)
-
-
-@list_group.command(name="component-type", cls=DgClickCommand)
 @click.option(
     "--json",
     "output_json",
@@ -175,21 +154,36 @@ def list_plugins_command(
 )
 @dg_global_options
 @cli_telemetry_wrapper
-def list_component_type_command(output_json: bool, **global_options: object) -> None:
-    """List registered Dagster components in the current project environment."""
+def list_plugins_command(
+    name_only: bool,
+    plugin: Optional[str],
+    feature: Optional[PluginObjectFeature],
+    output_json: bool,
+    **global_options: object,
+) -> None:
+    """List dg plugins and their corresponding objects in the current Python environment."""
     cli_config = normalize_cli_config(global_options, click.get_current_context())
     dg_context = DgContext.for_defined_registry_environment(Path.cwd(), cli_config)
     registry = RemotePluginRegistry.from_dg_context(dg_context)
 
     if output_json:
+        objects = registry.get_objects(feature=feature) if plugin else registry.get_objects()
         output: list[dict[str, object]] = []
-        for entry in sorted(
-            registry.get_objects(feature="component"), key=lambda x: x.key.to_typename()
-        ):
-            output.append({"key": entry.key.to_typename(), "summary": entry.summary})
+        for entry in sorted(objects, key=lambda x: x.key.to_typename()):
+            output.append(
+                {
+                    "key": entry.key.to_typename(),
+                    "summary": entry.summary,
+                    "features": entry.features,
+                }
+            )
         click.echo(json.dumps(output, indent=4))
-    else:
-        Console().print(_all_plugins_object_table(registry, False, "component"))
+    else:  # table output
+        if plugin:
+            table = _plugin_object_table(registry.get_objects(plugin, feature))
+        else:
+            table = _all_plugins_object_table(registry, name_only, feature=feature)
+        Console().print(table)
 
 
 # ########################

python_modules/libraries/dagster-dg/dagster_dg/utils/__init__.py

@@ -346,7 +346,7 @@ def format_multiline_str(message: str) -> str:
 
 def generate_missing_component_type_error_message(component_key_str: str) -> str:
     return f"""
-        No component type `{component_key_str}` is registered. Use 'dg list component-type'
+        No component type `{component_key_str}` is registered. Use `dg list plugins --feature component`
         to see the registered component types in your environment. You may need to install a package
         that provides `{component_key_str}` into your environment.
     """

python_modules/libraries/dagster-dg/dagster_dg_tests/cli_tests/test_environment_validation.py

@@ -55,7 +55,7 @@ def to_cli_args(self) -> tuple[str, ...]:
 REGISTRY_CONTEXT_COMMANDS = [
     CommandSpec(tuple(), "--rebuild-component-registry"),
     CommandSpec(("docs", "serve")),
-    CommandSpec(("list", "component-type")),
+    CommandSpec(("list", "plugins")),
     CommandSpec(("utils", "inspect-component-type"), DEFAULT_COMPONENT_TYPE),
 ]
 

python_modules/libraries/dagster-dg/dagster_dg_tests/cli_tests/test_list_commands.py

@@ -102,44 +102,60 @@ def test_list_components_success():
     [
         {
             "key": "dagster_test.components.AllMetadataEmptyComponent",
-            "summary": null
+            "summary": null,
+            "features": [
+                "component",
+                "scaffold-target"
+            ]
         },
         {
             "key": "dagster_test.components.ComplexAssetComponent",
-            "summary": "An asset that has a complex schema."
+            "summary": "An asset that has a complex schema.",
+            "features": [
+                "component",
+                "scaffold-target"
+            ]
         },
         {
             "key": "dagster_test.components.SimpleAssetComponent",
-            "summary": "A simple asset that returns a constant string value."
+            "summary": "A simple asset that returns a constant string value.",
+            "features": [
+                "component",
+                "scaffold-target"
+            ]
         },
         {
             "key": "dagster_test.components.SimplePipesScriptComponent",
-            "summary": "A simple asset that runs a Python script with the Pipes subprocess client."
+            "summary": "A simple asset that runs a Python script with the Pipes subprocess client.",
+            "features": [
+                "component",
+                "scaffold-target"
+            ]
         }
     ]
 
 """).strip()
 
 
-def test_list_component_types_success():
+def test_list_plugins_success():
     with (
         ProxyRunner.test(use_fixed_test_components=True) as runner,
         isolated_components_venv(runner),
     ):
         with fixed_panel_width(width=120):
-            result = runner.invoke("list", "component-type")
+            result = runner.invoke("list", "plugins")
             assert_runner_result(result)
             # strip the first line of logging output
             output = "\n".join(result.output.split("\n")[1:])
             match_terminal_box_output(output.strip(), _EXPECTED_COMPONENT_TYPES)
 
 
-def test_list_component_type_json_success():
+def test_list_plugins_json_success():
     with (
         ProxyRunner.test(use_fixed_test_components=True) as runner,
         isolated_components_venv(runner),
     ):
-        result = runner.invoke("list", "component-type", "--json")
+        result = runner.invoke("list", "plugins", "--json")
         assert_runner_result(result)
         # strip the first line of logging output
         output = "\n".join(result.output.split("\n")[1:])
@@ -149,7 +165,7 @@ def test_list_component_type_json_success():
 # Need to use capfd here to capture stderr from the subprocess invoked by the `list component-type`
 # command. This subprocess inherits stderr from the parent process, for whatever reason `capsys` does
 # not work.
-def test_list_component_type_bad_entry_point_fails(capfd):
+def test_list_plugins_bad_entry_point_fails(capfd):
     with (
         ProxyRunner.test() as runner,
         isolated_example_component_library_foo_bar(runner),
@@ -158,7 +174,7 @@ def test_list_component_type_bad_entry_point_fails(capfd):
         shutil.rmtree("src/foo_bar/lib")
 
         # Disable cache to force re-discovery of deleted entry point
-        result = runner.invoke("list", "component-type", "--disable-cache", "--json")
+        result = runner.invoke("list", "plugins", "--disable-cache")
         assert_runner_result(result, exit_0=False)
 
         expected_error_message = format_error_message("""

python_modules/libraries/dagster-dg/dagster_dg_tests/cli_tests/test_scaffold_commands.py

@@ -123,13 +123,13 @@ def test_scaffold_project_inside_workspace_success(monkeypatch) -> None:
 
         # Populate cache
         with pushd("projects/foo-bar"):
-            result = runner.invoke("list", "component-type", "--verbose")
+            result = runner.invoke("list", "plugins", "--verbose")
             assert_runner_result(result)
             assert "CACHE [miss]" in result.output
 
         # Check cache was populated
         with pushd("projects/foo-bar"):
-            result = runner.invoke("list", "component-type", "--verbose")
+            result = runner.invoke("list", "plugins", "--verbose")
             assert_runner_result(result)
             assert "CACHE [hit]" in result.output
 
@@ -308,7 +308,7 @@ def test_scaffold_project_no_populate_cache_success(monkeypatch) -> None:
         assert Path("foo-bar/uv.lock").exists()
 
         with pushd("foo-bar"):
-            result = runner.invoke("list", "component-type", "--verbose")
+            result = runner.invoke("list", "plugins", "--verbose")
             assert_runner_result(result)
             assert "CACHE [miss]" in result.output
 

python_modules/libraries/dagster-dg/dagster_dg_tests/test_cache.py

@@ -20,62 +20,62 @@
 
 def test_load_from_cache():
     with ProxyRunner.test(**cache_runner_args) as runner, example_project(runner):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
         assert "CACHE [write]" in result.output
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [hit]" in result.output
 
 
 def test_cache_invalidation_uv_lock():
     with ProxyRunner.test(**cache_runner_args) as runner, example_project(runner):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
         assert "CACHE [write]" in result.output
 
         subprocess.run(["uv", "add", "dagster-dbt"], check=True)
 
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
 
 
 def test_cache_invalidation_modified_lib():
     with ProxyRunner.test(**cache_runner_args) as runner, example_project(runner):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
         assert "CACHE [write]" in result.output
 
-        result = runner.invoke("scaffold", "component-type", "my_component")
+        result = runner.invoke("scaffold", "plugins", "my_component")
         assert_runner_result(result)
 
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
 
 
 def test_cache_no_invalidation_modified_pkg():
     with ProxyRunner.test(**cache_runner_args) as runner, example_project(runner):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
         assert "CACHE [write]" in result.output
 
         Path("src/foo_bar/submodule.py").write_text("print('hello')")
 
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [hit]" in result.output
 
 
 @pytest.mark.parametrize("clear_outside_project", [True, False])
 def test_clear_cache(clear_outside_project: bool):
     with ProxyRunner.test(**cache_runner_args) as runner, example_project(runner):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
         assert "CACHE [write]" in result.output
@@ -85,7 +85,7 @@ def test_clear_cache(clear_outside_project: bool):
             assert_runner_result(result)
             assert "CACHE [clear-all]" in result.output
 
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [miss]" in result.output
 
@@ -100,7 +100,7 @@ def test_rebuild_component_registry_success():
         assert_runner_result(result)
         assert "CACHE [clear-key]" in result.output
 
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE [hit]" in result.output
 
@@ -110,7 +110,7 @@ def test_rebuild_component_registry_fails_with_subcommand():
         ProxyRunner.test(**cache_runner_args) as runner,
         isolated_example_project_foo_bar(runner),
     ):
-        result = runner.invoke("--rebuild-component-registry", "list", "component-type")
+        result = runner.invoke("--rebuild-component-registry", "list", "plugins")
         assert_runner_result(result, exit_0=False)
         assert "Cannot specify --rebuild-component-registry with a subcommand." in result.output
 
@@ -134,6 +134,6 @@ def test_cache_disabled():
         ProxyRunner.test(**cache_runner_args, disable_cache=True) as runner,
         example_project(runner),
     ):
-        result = runner.invoke("list", "component-type")
+        result = runner.invoke("list", "plugins")
         assert_runner_result(result)
         assert "CACHE" not in result.output