Fix codespell-pre-commit integration (#293)

nathanjmcdougall · web-flow · commit a2319bef4302 · 2025-02-11T11:51:53.000+13:00
* Fix codespell-pre-commit integration

* Add test for codespell integration on pre-commit removal
diff --git a/src/usethis/_core/tool.py b/src/usethis/_core/tool.py
@@ -134,18 +134,23 @@ def use_deptry(*, remove: bool = False) -> None:
 def use_pre_commit(*, remove: bool = False) -> None:
     tool = PreCommitTool()
     pyproject_fmt_tool = PyprojectFmtTool()
+    codespell_tool = CodespellTool()
 
     ensure_pyproject_toml()
 
     if not remove:
         add_deps_to_group(tool.dev_deps, "dev")
         _add_all_tools_pre_commit_configs()
 
+        # We will use pre-commit instead of project-installed dependencies:
         if pyproject_fmt_tool.is_used():
-            # We will use pre-commit instead of the dev-dep.
             remove_deps_from_group(pyproject_fmt_tool.dev_deps, "dev")
             pyproject_fmt_tool.add_pyproject_configs()
             _pyproject_fmt_instructions_pre_commit()
+        if codespell_tool.is_used():
+            remove_deps_from_group(codespell_tool.dev_deps, "dev")
+            codespell_tool.add_pyproject_configs()
+            _codespell_instructions_pre_commit()
 
         if RequirementsTxtTool().is_used():
             _requirements_txt_instructions_pre_commit()
@@ -178,6 +183,9 @@ def use_pre_commit(*, remove: bool = False) -> None:
         if pyproject_fmt_tool.is_used():
             add_deps_to_group(pyproject_fmt_tool.dev_deps, "dev")
             _pyproject_fmt_instructions_basic()
+        if codespell_tool.is_used():
+            add_deps_to_group(codespell_tool.dev_deps, "dev")
+            _codespell_instructions_basic()
 
         # Likewise, explain how to manually generate the requirements.txt file, since
         # they're not going to do it via pre-commit anymore.
diff --git a/src/usethis/_integrations/pre_commit/core.py b/src/usethis/_integrations/pre_commit/core.py
@@ -51,9 +51,7 @@ def uninstall_pre_commit_hooks() -> None:
     in a git repo.
     """
     if usethis_config.frozen:
-        box_print(
-            "Run 'uv run pre-commit uninstall' to deregister pre-commit with git."
-        )
+        box_print("Run 'uvx pre-commit uninstall' to deregister pre-commit with git.")
         return
 
     tick_print("Ensuring pre-commit hooks are uninstalled.")
diff --git a/tests/usethis/_core/test_ci.py b/tests/usethis/_core/test_ci.py
@@ -263,13 +263,10 @@ def test_content(
                 )
 
         class TestCodespellIntegration:
-            def test_content(
-                self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
-            ):
+            def test_content(self, uv_init_dir: Path):
                 with change_cwd(uv_init_dir):
                     # Arrange
                     use_codespell()
-                    capfd.readouterr()
 
                     # Act
                     use_ci_bitbucket()
diff --git a/tests/usethis/_core/test_tool.py b/tests/usethis/_core/test_tool.py
@@ -115,8 +115,14 @@ def test_pre_commit_integration(
                 use_codespell()
 
                 # Assert
+                # Check dependencies - shouldn't have installed codespell
+                dev_deps = get_deps_from_group("dev")
+                assert all(dep.name != "codespell" for dep in dev_deps)
+
+                # Check hook names
                 hook_names = get_hook_names()
-            assert "codespell" in hook_names
+                assert "codespell" in hook_names
+            # Check output
             out, err = capfd.readouterr()
             assert not err
             assert out == (
@@ -676,9 +682,28 @@ def test_pyproject_fmt_used(self, uv_init_repo_dir: Path):
 
                 # Assert
                 hook_names = get_hook_names()
+                assert "pyproject-fmt" in hook_names
+
                 dev_deps = get_deps_from_group("dev")
-            assert "pyproject-fmt" in hook_names
-            assert "pyproject-fmt" not in dev_deps
+                for dev_dep in dev_deps:
+                    assert dev_dep.name != "pyproject-fmt"
+
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_codespell_used(self, uv_init_repo_dir: Path):
+            with change_cwd(uv_init_repo_dir):
+                # Arrange
+                use_codespell()
+
+                # Act
+                use_pre_commit()
+
+                # Assert
+                hook_names = get_hook_names()
+                assert "codespell" in hook_names
+
+                dev_deps = get_deps_from_group("dev")
+                for dep in dev_deps:
+                    assert dep.name != "codespell"
 
     class TestRemove:
         @pytest.mark.usefixtures("_vary_network_conn")
@@ -776,6 +801,31 @@ def test_pyproject_fmt_used(
                     "☐ Run 'pyproject-fmt pyproject.toml' to run pyproject-fmt.\n"
                 )
 
+        @pytest.mark.usefixtures("_vary_network_conn")
+        def test_codepsell_used(
+            self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
+        ):
+            with change_cwd(uv_init_dir):
+                # Arrange
+                with usethis_config.set(quiet=True):
+                    use_pre_commit()
+                    use_codespell()
+                    capfd.readouterr()
+
+                # Act
+                use_pre_commit(remove=True)
+
+                # Assert
+                out, err = capfd.readouterr()
+                assert not err
+                assert out == (
+                    "☐ Run 'uvx pre-commit uninstall' to deregister pre-commit with git.\n"
+                    "✔ Removing '.pre-commit-config.yaml'.\n"
+                    "✔ Removing dependency 'pre-commit' from the 'dev' group in 'pyproject.toml'.\n"
+                    "✔ Adding dependency 'codespell' to the 'dev' group in 'pyproject.toml'.\n"
+                    "☐ Run 'codespell' to run the Codespell spellchecker.\n"
+                )
+
     class TestBitbucketCIIntegration:
         def test_prexisting(self, uv_init_repo_dir: Path):
             # Arrange
