Skip to content

Implement a get_minimum_pre_commit_version function #1165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 1 commit into from
Nov 22, 2025
Merged

Implement a get_minimum_pre_commit_version function #1165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/usethis/_integrations/pre_commit/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
49 changes: 49 additions & 0 deletions tests/usethis/_integrations/pre_commit/test_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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