Implement usethis badge ty command

Copilot · nathanjmcdougall · Copilot · commit 80ea5dad3361 · 2026-03-22T18:58:44.000Z
Add a badge for the ty type checker from Astral. The badge uses the endpoint URL from the ty repository's assets. Changes: - Add get_ty_badge() function in src/usethis/_core/badge.py - Add ty to badge ordering in get_badge_order() - Add ty CLI command in src/usethis/_ui/interface/badge.py - Add tests for ty badge in tests/usethis/_ui/interface/test_interface_badge.py - Update docs/cli/reference.md with ty badge entry Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/9a568c69-1340-45e1-bc80-2c3cd91a906a
diff --git a/docs/cli/reference.md b/docs/cli/reference.md
@@ -317,6 +317,7 @@ Currently supported badges:
 - `usethis badge pypi` - [![PyPI Version](https://img.shields.io/pypi/v/usethis.svg)](https://pypi.python.org/pypi/usethis)
 - `usethis badge ruff` - [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 - `usethis badge socket` - [![Socket](https://badge.socket.dev/pypi/package/usethis)](https://socket.dev/pypi/package/usethis/overview)
+- `usethis badge ty` - [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 - `usethis badge usethis` - [![usethis](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/usethis-python/usethis-python/main/assets/badge/v1.json)](https://github.com/usethis-python/usethis-python)
 - `usethis badge uv` - [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 
diff --git a/src/usethis/_core/badge.py b/src/usethis/_core/badge.py
@@ -62,6 +62,12 @@ def get_socket_badge() -> Badge:
     )
 
 
+def get_ty_badge() -> Badge:
+    return Badge(
+        markdown="[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)"
+    )
+
+
 def get_uv_badge() -> Badge:
     return Badge(
         markdown="[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)"
@@ -83,6 +89,7 @@ def get_badge_order() -> list[Badge]:
         get_pypi_badge(),
         get_uv_badge(),
         get_ruff_badge(),
+        get_ty_badge(),
         get_pre_commit_badge(),
         get_usethis_badge(),
         get_socket_badge(),
diff --git a/src/usethis/_ui/interface/badge.py b/src/usethis/_ui/interface/badge.py
@@ -49,6 +49,20 @@ def ruff(
         _badge_effect(get_ruff_badge(), remove=remove, show=show)
 
 
+@app.command(help="Add a badge for the ty type checker.")
+def ty(
+    remove: bool = remove_opt,
+    offline: bool = offline_opt,
+    quiet: bool = quiet_opt,
+    show: bool = show_opt,
+) -> None:
+    from usethis._config_file import files_manager
+    from usethis._core.badge import get_ty_badge
+
+    with usethis_config.set(offline=offline, quiet=quiet), files_manager():
+        _badge_effect(get_ty_badge(), remove=remove, show=show)
+
+
 @app.command(help="Add a badge for the pre-commit framework.")
 def pre_commit(
     remove: bool = remove_opt,
diff --git a/tests/usethis/_ui/interface/test_interface_badge.py b/tests/usethis/_ui/interface/test_interface_badge.py
@@ -86,6 +86,45 @@ def test_show(self, tmp_path: Path):
         assert result.exit_code == 0, result.output
 
 
+class TestTy:
+    def test_add(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(app, ["ty"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_remove(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "README.md").write_text("")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(app, ["ty", "--remove"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_show(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "README.md").write_text("")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(app, ["ty", "--show"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert (
+            result.output
+            == "[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)\n"
+        )
+
+
 class TestSocket:
     def test_add(self, tmp_path: Path):
         # Act
