Skip to content

Support empty .pre-commit-config.yaml files #906

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 2 commits into from
Jul 25, 2025
Merged

Support empty .pre-commit-config.yaml files #906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3487cc1
Support empty `.pre-commit-config.yaml files`
nathanjmcdougall Jul 25, 2025
5dfd1cb
Don't modify empty files if unchanged
nathanjmcdougall Jul 25, 2025
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
5 changes: 5 additions & 0 deletions src/usethis/_integrations/file/yaml/io_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,12 @@ def edit_yaml(
except YAMLError as err:
msg = f"Error reading '{yaml_path}':\n{err}"
raise YAMLDecodeError(msg) from None

start_empty = not yaml_document.content
yield yaml_document
if start_empty and not yaml_document.content:
# No change
return
yaml_document.roundtripper.dump(yaml_document.content, stream=yaml_path)


Expand Down
6 changes: 4 additions & 2 deletions src/usethis/_integrations/pre_commit/io_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from typing import TYPE_CHECKING

from pydantic import ValidationError
from ruamel.yaml.comments import CommentedMap

from usethis._config import usethis_config
from usethis._console import tick_print
Expand All @@ -15,8 +16,6 @@
if TYPE_CHECKING:
from collections.abc import Generator

from ruamel.yaml.comments import CommentedMap

from usethis._integrations.file.yaml.io_ import YAMLLiteral


Expand Down Expand Up @@ -62,6 +61,9 @@ def edit_pre_commit_config_yaml() -> Generator[PreCommitConfigYAMLDocument, None


def _validate_config(ruamel_content: YAMLLiteral) -> JsonSchemaForPreCommitConfigYaml:
if isinstance(ruamel_content, CommentedMap) and not ruamel_content:
ruamel_content = CommentedMap({"repos": []})

try:
return JsonSchemaForPreCommitConfigYaml.model_validate(ruamel_content)
except ValidationError as err:
Expand Down
28 changes: 18 additions & 10 deletions tests/usethis/_integrations/pre_commit/test_pre_commit_io_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
from pathlib import Path

import pytest

from usethis._integrations.pre_commit.io_ import (
PreCommitConfigYAMLConfigError,
edit_pre_commit_config_yaml,
)
from usethis._integrations.pre_commit.io_ import edit_pre_commit_config_yaml
from usethis._test import change_cwd


Expand Down Expand Up @@ -35,14 +30,27 @@ def test_unchanged(self, tmp_path: Path):
# Assert
assert (tmp_path / ".pre-commit-config.yaml").read_text() == content_str

def test_empty_is_invalid(self, tmp_path: Path):
def test_start_with_empty_file(self, tmp_path: Path):
# Arrange
(tmp_path / ".pre-commit-config.yaml").write_text("")

# Act, Assert
# Act
with (
change_cwd(tmp_path),
pytest.raises(PreCommitConfigYAMLConfigError),
edit_pre_commit_config_yaml(),
edit_pre_commit_config_yaml() as doc,
):
doc.content["repos"] = []

# Assert
assert (tmp_path / ".pre-commit-config.yaml").read_text() == "repos: []\n"

def test_empty_valid_but_unchanged(self, tmp_path: Path):
# Arrange
(tmp_path / ".pre-commit-config.yaml").write_text("")

# Act
with change_cwd(tmp_path), edit_pre_commit_config_yaml():
pass

# Assert
assert (tmp_path / ".pre-commit-config.yaml").read_text() == ""
Loading