fix(changelog): Factorized TAG_FORMAT_REGEXES

Author: grahamhar

commitizen/changelog.py

@@ -44,6 +44,7 @@
 from commitizen import out
 from commitizen.bump import normalize_tag
 from commitizen.cz.base import ChangelogReleaseHook
+from commitizen.defaults import get_tag_regexes
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 from commitizen.version_schemes import (
@@ -97,20 +98,7 @@ def get_version_tags(
     scheme: type[BaseVersion], tags: list[GitTag], tag_format: str
 ) -> list[GitTag]:
     valid_tags: list[GitTag] = []
-    TAG_FORMAT_REGEXS = {
-        "$version": scheme.parser.pattern,
-        "$major": r"(?P<major>\d+)",
-        "$minor": r"(?P<minor>\d+)",
-        "$patch": r"(?P<patch>\d+)",
-        "$prerelease": r"(?P<prerelease>\w+\d+)?",
-        "$devrelease": r"(?P<devrelease>\.dev\d+)?",
-        "${version}": scheme.parser.pattern,
-        "${major}": r"(?P<major>\d+)",
-        "${minor}": r"(?P<minor>\d+)",
-        "${patch}": r"(?P<patch>\d+)",
-        "${prerelease}": r"(?P<prerelease>\w+\d+)?",
-        "${devrelease}": r"(?P<devrelease>\.dev\d+)?",
-    }
+    TAG_FORMAT_REGEXS = get_tag_regexes(scheme.parser.pattern)
     tag_format_regex = tag_format
     for pattern, regex in TAG_FORMAT_REGEXS.items():
         tag_format_regex = tag_format_regex.replace(pattern, regex)

commitizen/changelog_formats/base.py

@@ -9,6 +9,7 @@
 from commitizen.changelog import Metadata
 from commitizen.config.base_config import BaseConfig
 from commitizen.version_schemes import get_version_scheme
+from commitizen.defaults import get_tag_regexes
 
 from . import ChangelogFormat
 
@@ -31,20 +32,7 @@ def __init__(self, config: BaseConfig):
     def version_parser(self) -> Pattern:
         tag_regex: str = self.tag_format
         version_regex = get_version_scheme(self.config).parser.pattern
-        TAG_FORMAT_REGEXS = {
-            "$version": version_regex,
-            "$major": r"(?P<major>\d+)",
-            "$minor": r"(?P<minor>\d+)",
-            "$patch": r"(?P<patch>\d+)",
-            "$prerelease": r"(?P<prerelease>\w+\d+)?",
-            "$devrelease": r"(?P<devrelease>\.dev\d+)?",
-            "${version}": version_regex,
-            "${major}": r"(?P<major>\d+)",
-            "${minor}": r"(?P<minor>\d+)",
-            "${patch}": r"(?P<patch>\d+)",
-            "${prerelease}": r"(?P<prerelease>\w+\d+)?",
-            "${devrelease}": r"(?P<devrelease>\.dev\d+)?",
-        }
+        TAG_FORMAT_REGEXS = get_tag_regexes(version_regex)
         for pattern, regex in TAG_FORMAT_REGEXS.items():
             tag_regex = tag_regex.replace(pattern, regex)
         return re.compile(tag_regex)

commitizen/defaults.py

@@ -133,3 +133,20 @@ class Settings(TypedDict, total=False):
 )
 change_type_order = ["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"]
 bump_message = "bump: version $current_version → $new_version"
+
+
+def get_tag_regexes(version_regex: str) -> dict[str | Any, str | Any]:
+    return {
+        "$version": version_regex,
+        "$major": r"(?P<major>\d+)",
+        "$minor": r"(?P<minor>\d+)",
+        "$patch": r"(?P<patch>\d+)",
+        "$prerelease": r"(?P<prerelease>\w+\d+)?",
+        "$devrelease": r"(?P<devrelease>\.dev\d+)?",
+        "${version}": version_regex,
+        "${major}": r"(?P<major>\d+)",
+        "${minor}": r"(?P<minor>\d+)",
+        "${patch}": r"(?P<patch>\d+)",
+        "${prerelease}": r"(?P<prerelease>\w+\d+)?",
+        "${devrelease}": r"(?P<devrelease>\.dev\d+)?",
+    }

commitizen/providers/scm_provider.py

@@ -4,6 +4,7 @@
 from typing import Callable
 
 
+from commitizen.defaults import get_tag_regexes
 from commitizen.git import get_tags
 from commitizen.version_schemes import (
     get_version_scheme,
@@ -24,20 +25,7 @@ class ScmProvider(VersionProvider):
     It is meant for `setuptools-scm` or any package manager `*-scm` provider.
     """
 
-    TAG_FORMAT_REGEXS = {
-        "$version": r"(?P<version>.+)",
-        "$major": r"(?P<major>\d+)",
-        "$minor": r"(?P<minor>\d+)",
-        "$patch": r"(?P<patch>\d+)",
-        "$prerelease": r"(?P<prerelease>\w+\d+)?",
-        "$devrelease": r"(?P<devrelease>\.dev\d+)?",
-        "${version}": r"(?P<version>.+)",
-        "${major}": r"(?P<major>\d+)",
-        "${minor}": r"(?P<minor>\d+)",
-        "${patch}": r"(?P<patch>\d+)",
-        "${prerelease}": r"(?P<prerelease>\w+\d+)?",
-        "${devrelease}": r"(?P<devrelease>\.dev\d+)?",
-    }
+    TAG_FORMAT_REGEXS = get_tag_regexes(r"(?P<version>.+)")
 
     def _tag_format_matcher(self) -> Callable[[str], VersionProtocol | None]:
         version_scheme = get_version_scheme(self.config)