Implement a get_minimum_pre_commit_version function

nathanjmcdougall · nathanjmcdougall · commit d7a54189041d · 2025-11-22T22:19:01.000+13:00
diff --git a/src/usethis/_integrations/pre_commit/version.py b/src/usethis/_integrations/pre_commit/version.py
@@ -0,0 +1,18 @@
+from usethis._config import usethis_config
+from usethis._integrations.pre_commit.io_ import read_pre_commit_config_yaml
+
+
+def get_minimum_pre_commit_version() -> str | None:
+    """Get the declared minimum supported pre-commit version from the configuration.
+
+    This is in a dot-separated digit format e.g. `3.6.2`.
+
+    Returns `None` if no minimum version is explicitly declared.
+    """
+    path = usethis_config.cpd() / ".pre-commit-config.yaml"
+
+    if not path.exists():
+        return None
+
+    with read_pre_commit_config_yaml() as doc:
+        return doc.model.minimum_pre_commit_version
diff --git a/tests/usethis/_integrations/pre_commit/test_version.py b/tests/usethis/_integrations/pre_commit/test_version.py
@@ -0,0 +1,49 @@
+from pathlib import Path
+
+from usethis._integrations.pre_commit.version import get_minimum_pre_commit_version
+from usethis._test import change_cwd
+
+
+class TestGetMinimumPreCommitVersion:
+    def test_happy_path(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / ".pre-commit-config.yaml").write_text("""\
+minimum_pre_commit_version: '4.4.0'
+repos:
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+""")
+
+        # Act
+        with change_cwd(tmp_path):
+            result = get_minimum_pre_commit_version()
+
+        # Assert
+        assert result == "4.4.0"
+
+    def test_config_doesnt_exist(self, tmp_path: Path):
+        # Act
+        with change_cwd(tmp_path):
+            result = get_minimum_pre_commit_version()
+
+        # Assert
+        assert result is None
+
+    def test_minimum_version_not_declared(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / ".pre-commit-config.yaml").write_text("""\
+repos:
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+""")
+
+        # Act
+        with change_cwd(tmp_path):
+            result = get_minimum_pre_commit_version()
+
+        # Assert
+        assert result is None
