Add test validating markdown after all badge commands run in sequence

Copilot · nathanjmcdougall · Copilot · commit 438dfa285dec · 2026-03-27T05:06:11.000Z
Creates a canonical expected_all_badges.md file that prek (markdownlint + prettier) validates, and a test that runs all 7 badge commands on a blank-slate project and compares the resulting README against this canonical file. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d900c1cf-759f-4cd3-85a2-4ccac33d5116 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
diff --git a/tests/usethis/_core/assets/expected_all_badges.md b/tests/usethis/_core/assets/expected_all_badges.md
@@ -0,0 +1,9 @@
+# my-project
+
+[![PyPI Version](https://img.shields.io/pypi/v/my-project.svg)](https://pypi.python.org/pypi/my-project)
+[![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)
+[![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)
+[![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)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![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)
+[![Socket Badge](https://badge.socket.dev/pypi/package/my-project)](https://socket.dev/pypi/package/my-project/overview)
diff --git a/tests/usethis/_core/test_core_badge.py b/tests/usethis/_core/test_core_badge.py
@@ -2,7 +2,19 @@
 
 import pytest
 
-from usethis._core.badge import Badge, add_badge, is_badge, remove_badge
+from usethis._core.badge import (
+    Badge,
+    add_badge,
+    get_pre_commit_badge,
+    get_pypi_badge,
+    get_ruff_badge,
+    get_socket_badge,
+    get_ty_badge,
+    get_usethis_badge,
+    get_uv_badge,
+    is_badge,
+    remove_badge,
+)
 from usethis._file.pyproject_toml.io_ import PyprojectTOMLManager
 from usethis._test import change_cwd
 
@@ -734,3 +746,31 @@ def test_already_exists_no_newline_added(self, bare_dir: Path):
 
         # Assert
         assert path.read_text() == content
+
+
+class TestAllBadgesMarkdownValid:
+    """Test that adding all badges in sequence produces valid markdown.
+
+    The expected output is stored as a canonical .md file and validated by prek
+    (markdownlint + prettier), ensuring the generated markdown is always valid.
+    """
+
+    def test_all_badges(self, bare_dir: Path):
+        # Arrange
+        (bare_dir / "pyproject.toml").write_text('[project]\nname = "my-project"\n')
+
+        # Act
+        with change_cwd(bare_dir), PyprojectTOMLManager():
+            add_badge(get_pypi_badge())
+            add_badge(get_uv_badge())
+            add_badge(get_ruff_badge())
+            add_badge(get_ty_badge())
+            add_badge(get_pre_commit_badge())
+            add_badge(get_usethis_badge())
+            add_badge(get_socket_badge())
+
+        # Assert
+        expected = (
+            Path(__file__).parent / "assets" / "expected_all_badges.md"
+        ).read_text()
+        assert (bare_dir / "README.md").read_text() == expected
