✨ Remove Rich tags when showing completion text (#877)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>

tests/test_completion/test_completion_complete.py

@@ -79,7 +79,7 @@ def test_completion_complete_subcommand_fish():
         },
     )
     assert (
-        "delete\tDelete a user with USERNAME.\ndelete-all\tDelete ALL users in the database."
+        "delete  Delete a user with USERNAME.\ndelete-all      Delete ALL users in the database."
         in result.stdout
     )
 

typer/completion.py

@@ -15,6 +15,12 @@
 except ImportError:  # pragma: no cover
     shellingham = None
 
+try:
+    import rich
+
+except ImportError:  # pragma: no cover
+    rich = None  # type: ignore
+
 
 _click_patched = False
 
@@ -139,9 +145,17 @@ def shell_complete(
         click.echo(comp.source())
         return 0
 
+    # Typer override to print the completion help msg with Rich
     if instruction == "complete":
-        click.echo(comp.complete())
+        if not rich:  # pragma: no cover
+            click.echo(comp.complete())
+        else:
+            from . import rich_utils
+
+            rich_utils.print_with_rich(comp.complete())
+
         return 0
+    # Typer override end
 
     click.echo(f'Completion instruction "{instruction}" not supported.', err=True)
     return 1

typer/rich_utils.py

@@ -712,6 +712,12 @@ def rich_abort_error() -> None:
     console.print(ABORTED_TEXT, style=STYLE_ABORTED)
 
 
+def print_with_rich(text: str) -> None:
+    """Print richly formatted message."""
+    console = _get_rich_console()
+    console.print(text)
+
+
 def rich_to_html(input_text: str) -> str:
     """Print the HTML version of a rich-formatted input string.