Skip to content

fix(Init): fix a typo in _ask_version_provider options and remove unnecessary filter #1528

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

Merged
Merged
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
105 changes: 70 additions & 35 deletions commitizen/commands/init.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import os
import shutil
from typing import Any
from typing import Any, NamedTuple

import questionary
import yaml
Expand All @@ -17,6 +17,54 @@
from commitizen.version_schemes import KNOWN_SCHEMES, Version, get_version_scheme


class _VersionProviderOption(NamedTuple):
provider_name: str
description: str

@property
def title(self) -> str:
return f"{self.provider_name}: {self.description}"


_VERSION_PROVIDER_CHOICES = tuple(
questionary.Choice(title=option.title, value=option.provider_name)
for option in (
_VersionProviderOption(
provider_name="commitizen",
description="Fetch and set version in commitizen config (default)",
),
_VersionProviderOption(
provider_name="cargo",
description="Get and set version from Cargo.toml:project.version field",
),
_VersionProviderOption(
provider_name="composer",
description="Get and set version from composer.json:project.version field",
),
_VersionProviderOption(
provider_name="npm",
description="Get and set version from package.json:project.version field",
),
_VersionProviderOption(
provider_name="pep621",
description="Get and set version from pyproject.toml:project.version field",
),
_VersionProviderOption(
provider_name="poetry",
description="Get and set version from pyproject.toml:tool.poetry.version field",
),
_VersionProviderOption(
provider_name="uv",
description="Get and set version from pyproject.toml and uv.lock",
),
_VersionProviderOption(
provider_name="scm",
description="Fetch the version from git and does not need to set it back",
),
)
)


class ProjectInfo:
"""Discover information about the current folder."""

Expand Down Expand Up @@ -228,45 +276,32 @@ def _ask_tag_format(self, latest_tag: str) -> str:
def _ask_version_provider(self) -> str:
"""Ask for setting: version_provider"""

OPTS = {
"commitizen": "commitizen: Fetch and set version in commitizen config (default)",
"cargo": "cargo: Get and set version from Cargo.toml:project.version field",
"composer": "composer: Get and set version from composer.json:project.version field",
"npm": "npm: Get and set version from package.json:project.version field",
"pep621": "pep621: Get and set version from pyproject.toml:project.version field",
"poetry": "poetry: Get and set version from pyproject.toml:tool.poetry.version field",
"uv": "uv: Get and set version from pyproject.toml and uv.lock",
"scm": "scm: Fetch the version from git and does not need to set it back",
}

default_val = "commitizen"
if self.project_info.is_python:
if self.project_info.is_python_poetry:
default_val = "poetry"
elif self.project_info.is_python_uv:
default_val = "uv"
else:
default_val = "pep621"
elif self.project_info.is_rust_cargo:
default_val = "cargo"
elif self.project_info.is_npm_package:
default_val = "npm"
elif self.project_info.is_php_composer:
default_val = "composer"

choices = [
questionary.Choice(title=title, value=value)
for value, title in OPTS.items()
]
default = next(filter(lambda x: x.value == default_val, choices))
version_provider: str = questionary.select(
"Choose the source of the version:",
choices=choices,
choices=_VERSION_PROVIDER_CHOICES,
style=self.cz.style,
default=default,
default=self._default_version_provider,
).unsafe_ask()
return version_provider

@property
def _default_version_provider(self) -> str:
if self.project_info.is_python:
if self.project_info.is_python_poetry:
return "poetry"
if self.project_info.is_python_uv:
return "uv"
return "pep621"

if self.project_info.is_rust_cargo:
return "cargo"
if self.project_info.is_npm_package:
return "npm"
if self.project_info.is_php_composer:
return "composer"

return "commitizen"

def _ask_version_scheme(self) -> str:
"""Ask for setting: version_scheme"""
default_scheme = "pep440" if self.project_info.is_python else "semver"
Expand All @@ -291,7 +326,7 @@ def _ask_major_version_zero(self, version: Version) -> bool:
return major_version_zero

def _ask_update_changelog_on_bump(self) -> bool:
"Ask for setting: update_changelog_on_bump"
"""Ask for setting: update_changelog_on_bump"""
update_changelog_on_bump: bool = questionary.confirm(
"Create changelog automatically on bump",
default=True,
Expand Down
Loading