Add rich help panels to CLI (#572)

nathanjmcdougall · web-flow · commit 9db544399aa3 · 2025-04-25T09:59:11.000+12:00
* Add rich help panels to CLI

* uv add typer&gt;=0.6.0
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,7 +43,7 @@ dependencies = [
   "rich>=9.6.1",
   "ruamel-yaml>=0.16.13",
   "tomlkit>=0.12.0",
-  "typer>=0.4.1",
+  "typer>=0.6.0",
   "typing-extensions>=3.10.0.0",
 ]
 scripts.usethis = "usethis.__main__:app"
diff --git a/src/usethis/_app.py b/src/usethis/_app.py
@@ -20,23 +20,40 @@
     ),
     add_completion=False,
 )
-app.command(help="Add an author to the project.")(
+
+rich_help_panel = "Manage Tooling"
+app.add_typer(usethis._interface.ci.app, name="ci", rich_help_panel=rich_help_panel)
+app.add_typer(usethis._interface.tool.app, name="tool", rich_help_panel=rich_help_panel)
+
+rich_help_panel = "Manage Config"
+app.command(help="Add an author to the project.", rich_help_panel=rich_help_panel)(
     usethis._interface.author.author,
 )
-app.add_typer(usethis._interface.badge.app, name="badge")
-app.add_typer(usethis._interface.browse.app, name="browse")
-app.add_typer(usethis._interface.ci.app, name="ci")
-app.command(help="Add a README.md file to the project.")(
+app.command(help="Enforce a docstring style.", rich_help_panel=rich_help_panel)(
+    usethis._interface.docstyle.docstyle,
+)
+
+rich_help_panel = "Manage README"
+app.add_typer(
+    usethis._interface.badge.app, name="badge", rich_help_panel=rich_help_panel
+)
+app.command(
+    help="Add a README.md file to the project.", rich_help_panel=rich_help_panel
+)(
     usethis._interface.readme.readme,
 )
-app.command(help="Enforce a docstring style.")(
-    usethis._interface.docstyle.docstyle,
+
+rich_help_panel = "Informative"
+app.add_typer(
+    usethis._interface.browse.app, name="browse", rich_help_panel=rich_help_panel
 )
-app.command(help="List usage of tooling and config managed by usethis.")(
+app.command(
+    help="List usage of tooling and config managed by usethis.",
+    rich_help_panel=rich_help_panel,
+)(
     usethis._interface.list.list,
 )
-app.add_typer(usethis._interface.show.app, name="show")
-app.add_typer(usethis._interface.tool.app, name="tool")
-app.command(help="Display the version of usethis.")(
+app.add_typer(usethis._interface.show.app, name="show", rich_help_panel=rich_help_panel)
+app.command(help="Display the version of usethis.", rich_help_panel=rich_help_panel)(
     usethis._interface.version.version,
 )
diff --git a/src/usethis/_interface/tool.py b/src/usethis/_interface/tool.py
@@ -33,6 +33,7 @@
 @app.command(
     name="codespell",
     help="Use the codespell spellchecker: detect common spelling mistakes.",
+    rich_help_panel="Code Quality Tools",
 )
 def codespell(
     remove: bool = remove_opt,
@@ -47,7 +48,11 @@ def codespell(
         _run_tool(use_codespell, remove=remove)
 
 
-@app.command(name="coverage", help="Use coverage: a code coverage measurement tool.")
+@app.command(
+    name="coverage",
+    help="Use coverage: a code coverage measurement tool.",
+    rich_help_panel="Testing",
+)
 def coverage(
     remove: bool = remove_opt,
     offline: bool = offline_opt,
@@ -64,6 +69,7 @@ def coverage(
 @app.command(
     name="deptry",
     help="Use the deptry linter: avoid missing or superfluous dependency declarations.",
+    rich_help_panel="Code Quality Tools",
 )
 def deptry(
     remove: bool = remove_opt,
@@ -81,6 +87,7 @@ def deptry(
 @app.command(
     name="import-linter",
     help="Use Import Linter: enforce a self-imposed architecture on imports.",
+    rich_help_panel="Code Quality Tools",
 )
 def import_linter(
     remove: bool = remove_opt,
@@ -98,6 +105,7 @@ def import_linter(
 @app.command(
     name="pre-commit",
     help="Use the pre-commit framework to manage and maintain pre-commit hooks.",
+    rich_help_panel="Code Quality Tools",
 )
 def pre_commit(
     remove: bool = remove_opt,
@@ -115,6 +123,7 @@ def pre_commit(
 @app.command(
     name="pyproject-fmt",
     help="Use the pyproject-fmt linter: opinionated formatting of 'pyproject.toml' files.",
+    rich_help_panel="Code Quality Tools",
 )
 def pyproject_fmt(
     remove: bool = remove_opt,
@@ -130,7 +139,9 @@ def pyproject_fmt(
 
 
 @app.command(
-    name="pyproject.toml", help="Use a pyproject.toml file to configure the project."
+    name="pyproject.toml",
+    help="Use a pyproject.toml file to configure the project.",
+    rich_help_panel="Configuration Files",
 )
 def pyproject_toml(
     remove: bool = remove_opt,
@@ -145,7 +156,9 @@ def pyproject_toml(
         _run_tool(use_pyproject_toml, remove=remove)
 
 
-@app.command(name="pytest", help="Use the pytest testing framework.")
+@app.command(
+    name="pytest", help="Use the pytest testing framework.", rich_help_panel="Testing"
+)
 def pytest(
     remove: bool = remove_opt,
     offline: bool = offline_opt,
@@ -162,6 +175,7 @@ def pytest(
 @app.command(
     name="requirements.txt",
     help="Use a requirements.txt file exported from the uv lockfile.",
+    rich_help_panel="Configuration Files",
 )
 def requirements_txt(
     remove: bool = remove_opt,
@@ -177,7 +191,9 @@ def requirements_txt(
 
 
 @app.command(
-    name="ruff", help="Use Ruff: an extremely fast Python linter and code formatter."
+    name="ruff",
+    help="Use Ruff: an extremely fast Python linter and code formatter.",
+    rich_help_panel="Code Quality Tools",
 )
 def ruff(
     remove: bool = remove_opt,
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ dependencies = [`
`43`	`43`	`"rich>=9.6.1",`
`44`	`44`	`"ruamel-yaml>=0.16.13",`
`45`	`45`	`"tomlkit>=0.12.0",`
`46`		`- "typer>=0.4.1",`
	`46`	`+ "typer>=0.6.0",`
`47`	`47`	`"typing-extensions>=3.10.0.0",`
`48`	`48`	`]`
`49`	`49`	`scripts.usethis = "usethis.__main__:app"`