refactor: Make tag_format properly default to $version

We've been using this default already in `normalize_tag`,
but setting this value in the settings dict is cleaner.

Author: robertschweizer

commitizen/bump.py

@@ -219,7 +219,7 @@ def _version_to_regex(version: str) -> str:
 
 def normalize_tag(
     version: Union[VersionProtocol, str],
-    tag_format: Optional[str] = None,
+    tag_format: str,
     version_type_cls: Optional[Type[VersionProtocol]] = None,
 ) -> str:
     """The tag and the software version might be different.
@@ -238,9 +238,6 @@ def normalize_tag(
     if isinstance(version, str):
         version = version_type_cls(version)
 
-    if not tag_format:
-        return str(version)
-
     major, minor, patch = version.release
     prerelease = ""
     # version.pre is needed for mypy check

commitizen/commands/changelog.py

@@ -7,6 +7,7 @@
 
 from commitizen import bump, changelog, defaults, factory, git, out, version_types
 from commitizen.config import BaseConfig
+from commitizen.defaults import DEFAULT_SETTINGS
 from commitizen.exceptions import (
     DryRunExit,
     NoCommitsFoundError,
@@ -55,8 +56,8 @@ def __init__(self, config: BaseConfig, args):
             or defaults.change_type_order
         )
         self.rev_range = args.get("rev_range")
-        self.tag_format = args.get("tag_format") or self.config.settings.get(
-            "tag_format"
+        self.tag_format: str = args.get("tag_format") or self.config.settings.get(
+            "tag_format", DEFAULT_SETTINGS["tag_format"]
         )
         self.merge_prerelease = args.get(
             "merge_prerelease"

commitizen/commands/init.py

@@ -10,7 +10,7 @@
 from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig
 from commitizen.cz import registry
-from commitizen.defaults import config_files
+from commitizen.defaults import DEFAULT_SETTINGS, config_files
 from commitizen.exceptions import InitFailedError, NoAnswersError
 from commitizen.git import get_latest_tag_name, get_tag_names, smart_open
 from commitizen.version_types import VERSION_TYPES
@@ -203,14 +203,15 @@ def _ask_tag_format(self, latest_tag) -> str:
                 f'Is "{tag_format}" the correct tag format?', style=self.cz.style
             ).unsafe_ask()
 
+        default_format = DEFAULT_SETTINGS["tag_format"]
         if not is_correct_format:
             tag_format = questionary.text(
-                'Please enter the correct version format: (default: "$version")',
+                f'Please enter the correct version format: (default: "{default_format}")',
                 style=self.cz.style,
             ).unsafe_ask()
 
             if not tag_format:
-                tag_format = "$version"
+                tag_format = default_format
         return tag_format
 
     def _ask_version_provider(self) -> str:

commitizen/defaults.py

@@ -35,7 +35,7 @@ class Settings(TypedDict, total=False):
     version: Optional[str]
     version_files: List[str]
     version_provider: Optional[str]
-    tag_format: Optional[str]
+    tag_format: str
     bump_message: Optional[str]
     allow_abort: bool
     changelog_file: str
@@ -68,7 +68,7 @@ class Settings(TypedDict, total=False):
     "version": None,
     "version_files": [],
     "version_provider": "commitizen",
-    "tag_format": None,  # example v$version
+    "tag_format": "$version",  # example v$version
     "bump_message": None,  # bumped v$current_version to $new_version
     "allow_abort": False,
     "changelog_file": "CHANGELOG.md",

docs/bump.md

@@ -327,7 +327,7 @@ In your `pyproject.toml` or `.cz.toml`
 tag_format = "v$major.$minor.$patch$prerelease"
 ```
 
-The variables must be preceded by a `$` sign.
+The variables must be preceded by a `$` sign. Default is `$version`.
 
 Supported variables:
 

docs/config.md

@@ -38,7 +38,7 @@ Version provider used to read and write version [Read more](#version-providers)
 
 Type: `str`
 
-Default: `None`
+Default: `$version`
 
 Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [Read more][tag_format]
 

tests/test_conf.py

@@ -45,7 +45,7 @@
     "name": "cz_jira",
     "version": "1.0.0",
     "version_provider": "commitizen",
-    "tag_format": None,
+    "tag_format": "$version",
     "bump_message": None,
     "allow_abort": False,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
@@ -67,7 +67,7 @@
     "name": "cz_jira",
     "version": "2.0.0",
     "version_provider": "commitizen",
-    "tag_format": None,
+    "tag_format": "$version",
     "bump_message": None,
     "allow_abort": False,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],