feat: Adding new --format option in routes CLI command for JSON format (#4417)

litestar/cli/commands/core.py

@@ -309,7 +309,8 @@ def run_command(
 @click.command(name="routes")
 @click.option("--schema", help="Include schema routes", is_flag=True, default=False)
 @click.option("--exclude", help="routes to exclude via regex", type=str, is_flag=False, multiple=True)
-def routes_command(app: Litestar, exclude: tuple[str, ...], schema: bool) -> None:  # pragma: no cover
+@click.option("--json", "as_json", is_flag=True, help="Output routes as JSON instead of tree")
+def routes_command(app: Litestar, exclude: tuple[str, ...], schema: bool, as_json: bool) -> None:
     """Display information about the application's routes."""
 
     sorted_routes = sorted(app.routes, key=lambda r: r.path)
@@ -319,7 +320,35 @@ def routes_command(app: Litestar, exclude: tuple[str, ...], schema: bool) -> Non
     if exclude is not None:
         sorted_routes = remove_routes_with_patterns(sorted_routes, exclude)
 
-    console.print(_RouteTree(sorted_routes))
+    if as_json:
+        import inspect
+        import json
+
+        routes_list = []
+        for route in sorted_routes:
+            route_info: dict[str, Any] = {
+                "path": route.path,
+                "type": route.__class__.__name__,
+                "methods": sorted(getattr(route, "http_methods", [])),
+            }
+
+            if isinstance(route, HTTPRoute):
+                route_info["handlers"] = [
+                    {
+                        "name": h.name,
+                        "path": h.paths,
+                        "handler": h.handler_name,
+                        "methods": sorted(h.http_methods),
+                        "async": inspect.iscoroutinefunction(unwrap_partial(h.fn)),
+                    }
+                    for h in route.route_handlers
+                ]
+
+            routes_list.append(route_info)
+
+        click.echo(json.dumps(routes_list, indent=4, default=lambda o: list(o) if isinstance(o, set) else o))
+    else:
+        console.print(_RouteTree(sorted_routes))
 
 
 class _RouteTree(Tree):

litestar/repository/abc/_sync.py

@@ -1,5 +1,5 @@
 # Do not edit this file directly. It has been autogenerated from
-# litestar/repository/abc/_async.py
+# litestar\repository\abc\_async.py
 from __future__ import annotations
 
 from abc import ABCMeta, abstractmethod

tests/unit/test_cli/test_core_commands.py

@@ -1,4 +1,5 @@
 import io
+import json
 import os
 import re
 import sys
@@ -668,3 +669,23 @@ def test_remove_routes_with_patterns() -> None:
     assert len(paths) == 2
     for route in ["/", "/foo"]:
         assert route in paths
+
+
+@pytest.mark.usefixtures("unset_env")
+def test_routes_command_json_output(runner: CliRunner, create_app_file: CreateAppFileFixture) -> None:
+    """Test that the routes command supports --json output."""
+    create_app_file("app.py", content=APP_FILE_CONTENT_ROUTES_EXAMPLE)
+
+    result = runner.invoke(cli_command, ["routes", "--json"])
+
+    assert result.exit_code == 0
+    assert result.exception is None
+
+    try:
+        data = json.loads(result.output)
+    except json.JSONDecodeError:
+        pytest.fail("Output is not valid JSON")
+
+    assert isinstance(data, list)
+    assert all("path" in route and "methods" in route for route in data)
+    assert len(data) > 0