Create a method to remove managed files for tools (#326)

nathanjmcdougall · web-flow · commit b5d051ddecf5 · 2025-02-21T19:45:55.000+13:00
diff --git a/src/usethis/_core/tool.py b/src/usethis/_core/tool.py
@@ -17,7 +17,6 @@
     uninstall_pre_commit_hooks,
 )
 from usethis._integrations.pre_commit.hooks import add_placeholder_hook, get_hook_names
-from usethis._integrations.pyproject.remove import remove_pyproject_toml
 from usethis._integrations.pyproject.valid import ensure_pyproject_validity
 from usethis._integrations.pytest.core import add_pytest_dir, remove_pytest_dir
 from usethis._integrations.ruff.rules import (
@@ -67,6 +66,7 @@ def use_codespell(*, remove: bool = False) -> None:
         tool.remove_pyproject_configs()
         tool.remove_pre_commit_repo_configs()
         remove_deps_from_group(tool.dev_deps, "dev")
+        tool.remove_managed_files()
 
 
 def use_coverage(*, remove: bool = False) -> None:
@@ -85,6 +85,7 @@ def use_coverage(*, remove: bool = False) -> None:
     else:
         tool.remove_pyproject_configs()
         remove_deps_from_group([*tool.dev_deps, Dependency(name="pytest-cov")], "test")
+        tool.remove_managed_files()
 
 
 def use_deptry(*, remove: bool = False) -> None:
@@ -105,6 +106,7 @@ def use_deptry(*, remove: bool = False) -> None:
         tool.remove_pyproject_configs()
         remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
         remove_deps_from_group(tool.dev_deps, "dev")
+        tool.remove_managed_files()
 
 
 def use_pre_commit(*, remove: bool = False) -> None:
@@ -164,6 +166,7 @@ def use_pre_commit(*, remove: bool = False) -> None:
         # they're not going to do it via pre-commit anymore.
         if RequirementsTxtTool().is_used():
             RequirementsTxtTool().print_how_to_use()
+        tool.remove_managed_files()
 
 
 def _add_all_tools_pre_commit_configs():
@@ -210,6 +213,7 @@ def use_pyproject_fmt(*, remove: bool = False) -> None:
         tool.remove_pyproject_configs()
         tool.remove_pre_commit_repo_configs()
         remove_deps_from_group(tool.dev_deps, "dev")
+        tool.remove_managed_files()
 
 
 def use_pyproject_toml(*, remove: bool = False) -> None:
@@ -222,7 +226,7 @@ def use_pyproject_toml(*, remove: bool = False) -> None:
         ensure_pyproject_validity()
         tool.print_how_to_use()
     else:
-        remove_pyproject_toml()
+        tool.remove_managed_files()
 
 
 def use_pytest(*, remove: bool = False) -> None:
@@ -264,6 +268,7 @@ def use_pytest(*, remove: bool = False) -> None:
 
         if CoverageTool().is_used():
             CoverageTool().print_how_to_use()
+        tool.remove_managed_files()
 
 
 def use_requirements_txt(*, remove: bool = False) -> None:
@@ -301,10 +306,7 @@ def use_requirements_txt(*, remove: bool = False) -> None:
 
     else:
         tool.remove_pre_commit_repo_configs()
-
-        if path.exists() and path.is_file():
-            tick_print("Removing 'requirements.txt'.")
-            path.unlink()
+        tool.remove_managed_files()
 
 
 def use_ruff(*, remove: bool = False) -> None:
@@ -352,3 +354,4 @@ def use_ruff(*, remove: bool = False) -> None:
         remove_bitbucket_steps_from_default(tool.get_bitbucket_steps())
         tool.remove_pyproject_configs()
         remove_deps_from_group(tool.dev_deps, "dev")
+        tool.remove_managed_files()
diff --git a/src/usethis/_tool.py b/src/usethis/_tool.py
@@ -30,6 +30,7 @@
     remove_config_value,
     set_config_value,
 )
+from usethis._integrations.pyproject.remove import remove_pyproject_toml
 from usethis._integrations.uv.deps import Dependency, is_dep_in_any_group
 
 
@@ -199,6 +200,17 @@ def remove_pyproject_configs(self) -> None:
                     tick_print(f"Removing {self.name} config from 'pyproject.toml'.")
                     first_removal = False
 
+    def remove_managed_files(self) -> None:
+        """Remove all files managed by this tool.
+
+        This includes any tool-specific files in the project.
+        If no files exist, this method has no effect.
+        """
+        for file in self.get_managed_files():
+            if (Path.cwd() / file).exists() and (Path.cwd() / file).is_file():
+                tick_print(f"Removing '{file}'.")
+                file.unlink()
+
 
 class CodespellTool(Tool):
     @property
@@ -459,6 +471,10 @@ def get_managed_files(self) -> list[Path]:
             Path("pyproject.toml"),
         ]
 
+    def remove_managed_files(self) -> None:
+        remove_pyproject_toml()
+        return super().remove_managed_files()
+
 
 class PytestTool(Tool):
     @property
diff --git a/tests/usethis/test_usethis_tool.py b/tests/usethis/test_usethis_tool.py
@@ -714,6 +714,46 @@ def get_pyproject_configs(self) -> list[PyProjectConfig]:
             assert not err
             assert out == "✔ Adding mytool config to 'pyproject.toml'.\n"
 
+    class TestRemoveManagedFiles:
+        def test_no_files(self, tmp_path: Path):
+            # Arrange
+            tool = DefaultTool()
+
+            # Act
+            with change_cwd(tmp_path):
+                tool.remove_managed_files()
+
+                # Assert
+                assert not (tmp_path / "mytool-config.yaml").exists()
+
+        def test_file(self, tmp_path: Path, capfd: pytest.CaptureFixture[str]):
+            # Arrange
+            tool = MyTool()
+            (tmp_path / "mytool-config.yaml").write_text("")
+
+            # Act
+            with change_cwd(tmp_path):
+                tool.remove_managed_files()
+
+                # Assert
+                assert not (tmp_path / "mytool-config.yaml").exists()
+
+            out, err = capfd.readouterr()
+            assert not err
+            assert out == "✔ Removing 'mytool-config.yaml'.\n"
+
+        def test_dir_not_removed(self, tmp_path: Path):
+            # Arrange
+            tool = MyTool()
+            (tmp_path / "mytool-config.yaml").mkdir()
+
+            # Act
+            with change_cwd(tmp_path):
+                tool.remove_managed_files()
+
+                # Assert
+                assert (tmp_path / "mytool-config.yaml").exists()
+
 
 class TestDeptryTool:
     """Tests for DeptryTool."""
