Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

refactor(Init): extract _get_config_data for readability #1538

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.

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

Open
wants to merge 1 commit into
base: v4-9-0-test
Choose a base branch
from
Open
Changes from all commits
Commits
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
45 changes: 22 additions & 23 deletions commitizen/commands/init.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ def is_pre_commit_installed(self) -> bool:


class Init:
_PRE_COMMIT_CONFIG_PATH = ".pre-commit-config.yaml"

def __init__(self, config: BaseConfig, *args: object) -> None:
self.config: BaseConfig = config
self.encoding = config.settings["encoding"]
Expand Down Expand Up @@ -323,9 +325,8 @@ def _gen_pre_commit_cmd(self, hook_types: list[str]) -> str:
)
return cmd_str

def _install_pre_commit_hook(self, hook_types: list[str] | None = None) -> None:
pre_commit_config_filename = ".pre-commit-config.yaml"
cz_hook_config = {
def _get_config_data(self) -> dict[str, Any]:
CZ_HOOK_CONFIG = {
"repo": "https://github.com/commitizen-tools/commitizen",
"rev": f"v{__version__}",
"hooks": [
Expand All @@ -334,31 +335,29 @@ def _install_pre_commit_hook(self, hook_types: list[str] | None = None) -> None:
],
}

config_data = {}
if not self.project_info.has_pre_commit_config:
# .pre-commit-config.yaml does not exist
config_data["repos"] = [cz_hook_config]
return {"repos": [CZ_HOOK_CONFIG]}

with open(self._PRE_COMMIT_CONFIG_PATH, encoding=self.encoding) as config_file:
config_data: dict[str, Any] = yaml.safe_load(config_file) or {}

if not isinstance(repos := config_data.get("repos"), list):
# .pre-commit-config.yaml exists but there's no "repos" key
config_data["repos"] = [CZ_HOOK_CONFIG]
return config_data

# Check if commitizen pre-commit hook is already in the config
if any("commitizen" in hook_config["repo"] for hook_config in repos):
out.write("commitizen already in pre-commit config")
else:
with open(
pre_commit_config_filename, encoding=self.encoding
) as config_file:
yaml_data = yaml.safe_load(config_file)
if yaml_data:
config_data = yaml_data

if "repos" in config_data:
for pre_commit_hook in config_data["repos"]:
if "commitizen" in pre_commit_hook["repo"]:
out.write("commitizen already in pre-commit config")
break
else:
config_data["repos"].append(cz_hook_config)
else:
# .pre-commit-config.yaml exists but there's no "repos" key
config_data["repos"] = [cz_hook_config]
repos.append(CZ_HOOK_CONFIG)
return config_data

def _install_pre_commit_hook(self, hook_types: list[str] | None = None) -> None:
config_data = self._get_config_data()
with smart_open(
pre_commit_config_filename, "w", encoding=self.encoding
self._PRE_COMMIT_CONFIG_PATH, "w", encoding=self.encoding
) as config_file:
yaml.safe_dump(config_data, stream=config_file)

Expand Down