Integrated rich-argparse.

Author: kmvanbrunt

cmd2/argparse_custom.py

@@ -237,6 +237,7 @@ def my_completer(self, text, line, begidx, endidx, arg_tokens)
     IO,
     TYPE_CHECKING,
     Any,
+    ClassVar,
     NoReturn,
     Optional,
     Protocol,
@@ -245,6 +246,10 @@ def my_completer(self, text, line, begidx, endidx, arg_tokens)
     runtime_checkable,
 )
 
+from rich_argparse import (
+    RawTextRichHelpFormatter,
+)
+
 from . import (
     ansi,
     constants,
@@ -991,9 +996,25 @@ def _SubParsersAction_remove_parser(self: argparse._SubParsersAction, name: str)
 ############################################################################################################
 
 
-class Cmd2HelpFormatter(argparse.RawTextHelpFormatter):
+class Cmd2HelpFormatter(RawTextRichHelpFormatter):
     """Custom help formatter to configure ordering of help text."""
 
+    # rich-argparse formats all group names with str.title().
+    # Override their formatter to do nothing.
+    group_name_formatter: ClassVar[Callable[[str], str]] = str
+
+    # Disable automatic highlighting in the help text.
+    highlights: ClassVar[list[str]] = []
+
+    # Disable markup rendering in usage, help, description, and epilog text.
+    # cmd2's built-in commands do not escape opening brackets in their help text
+    # and therefore rely on these settings being False. If you desire to use
+    # markup in your help text, inherit from a Cmd2 help formatter and override
+    # these settings in that child class.
+    usage_markup: ClassVar[bool] = False
+    help_markup: ClassVar[bool] = False
+    text_markup: ClassVar[bool] = False
+
     def _format_usage(
         self,
         usage: Optional[str],

pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
     "gnureadline>=8; platform_system == 'Darwin'",
     "pyperclip>=1.8",
     "pyreadline3>=3.4; platform_system == 'Windows'",
+    "rich-argparse>=1.7.1",
     "wcwidth>=0.2.10",
 ]