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

@@ -207,9 +207,7 @@ def _version_to_regex(version: str) -> str:
     return version.replace(".", r"\.").replace("+", r"\+")
 
 
-def normalize_tag(
-    version: Union[Version, str], tag_format: Optional[str] = None
-) -> str:
+def normalize_tag(version: Union[Version, str], tag_format: str) -> str:
     """The tag and the software version might be different.
 
     That's why this function exists.
@@ -224,9 +222,6 @@ def normalize_tag(
     if isinstance(version, str):
         version = Version(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

@@ -5,6 +5,7 @@
 
 from commitizen import bump, changelog, defaults, factory, git, out
 from commitizen.config import BaseConfig
+from commitizen.defaults import DEFAULT_SETTINGS
 from commitizen.exceptions import (
     DryRunExit,
     NoCommitsFoundError,
@@ -46,8 +47,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"]
         )
 
     def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:

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
 
@@ -110,14 +110,15 @@ def _ask_tag_format(self, latest_tag) -> str:
                 f'Is "{tag_format}" the correct tag format?', style=self.cz.style
             ).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,
             ).ask()
 
             if not tag_format:
-                tag_format = "$version"
+                tag_format = default_format
         return tag_format
 
     def _search_pre_commit(self) -> bool:

commitizen/defaults.py

@@ -33,7 +33,7 @@ class Settings(TypedDict, total=False):
     name: str
     version: Optional[str]
     version_files: List[str]
-    tag_format: Optional[str]
+    tag_format: str
     bump_message: Optional[str]
     allow_abort: bool
     changelog_file: str
@@ -63,7 +63,7 @@ class Settings(TypedDict, total=False):
     "name": "cz_conventional_commits",
     "version": None,
     "version_files": [],
-    "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

@@ -300,7 +300,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

@@ -7,7 +7,7 @@
 | `name`                     | `str`  | `"cz_conventional_commits"` | Name of the committing rules to use                                                                                                                                                                                                                  |
 | `version`                  | `str`  | `None`                      | Current version. Example: "0.1.2"                                                                                                                                                                                                                    |
 | `version_files`            | `list` | `[ ]`                       | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more][version_files]                                                                                                                 |
-| `tag_format`               | `str`  | `None`                      | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more][tag_format]                                                                                                                                       |
+| `tag_format`               | `str`  | `$version`                  | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more][tag_format]                                                                                                                                       |
 | `update_changelog_on_bump` | `bool` | `false`                     | Create changelog when running `cz bump`                                                                                                                                                                                                              |
 | `gpg_sign`                 | `bool` | `false`                     | Use gpg signed tags instead of lightweight tags.                                                                                                                                                                                                     |
 | `annotated_tag`            | `bool` | `false`                     | Use annotated tags instead of lightweight tags. [See difference][annotated-tags-vs-lightweight]                                                                                                                                                      |

tests/test_conf.py

@@ -44,7 +44,7 @@
 _settings = {
     "name": "cz_jira",
     "version": "1.0.0",
-    "tag_format": None,
+    "tag_format": "$version",
     "bump_message": None,
     "allow_abort": False,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
@@ -63,7 +63,7 @@
 _new_settings = {
     "name": "cz_jira",
     "version": "2.0.0",
-    "tag_format": None,
+    "tag_format": "$version",
     "bump_message": None,
     "allow_abort": False,
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],