feat: custom cz plugins now support bumping version

Author: woile

commitizen/bump.py

@@ -4,18 +4,13 @@
 from string import Template
 from packaging.version import Version
 from typing import List, Optional, Union
-
-MAJOR = "MAJOR"
-MINOR = "MINOR"
-PATCH = "PATCH"
-conventional_commits_pattern = r"^(BREAKING CHANGE|feat)"
-conventional_commits_map = {"BREAKING CHANGE": MAJOR, "feat": MINOR}
+from commitizen.defaults import MAJOR, MINOR, PATCH, bump_pattern, bump_map
 
 
 def find_increment(
     messages: List[str],
-    regex: str = conventional_commits_pattern,
-    increments_map: dict = conventional_commits_map,
+    regex: str = bump_pattern,
+    increments_map: dict = bump_map,
 ) -> str:
 
     # Most important cases are major and minor.

commitizen/commands/bump.py

@@ -2,10 +2,11 @@
 from typing import Optional
 
 import questionary
-from commitizen import bump, git, config, out
+from commitizen import bump, git, config, out, factory
 
 NO_COMMITS_FOUND = 3
 NO_VERSION_SPECIFIED = 4
+NO_PATTERN_MAP = 7
 
 
 class Bump:
@@ -22,6 +23,7 @@ def __init__(self, config: dict, arguments: dict):
                 if arguments[key] is not None
             },
         }
+        self.cz = factory.commiter_factory(self.config)
 
     def __call__(self):
         """Steps executed to bump."""
@@ -32,6 +34,7 @@ def __call__(self):
             out.error("Check if current version is specified in config file, like:")
             out.error("version = 0.4.3")
             raise SystemExit(NO_VERSION_SPECIFIED)
+
         current_version: str = self.config["version"]
         tag_format: str = self.parameters["tag_format"]
         current_tag_version: str = bump.create_tag(
@@ -66,7 +69,14 @@ def __call__(self):
             raise SystemExit(NO_COMMITS_FOUND)
 
         if increment is None:
-            increment = bump.find_increment(commits)
+            bump_pattern = self.cz.bump_pattern
+            bump_map = self.cz.bump_map
+            if not bump_map or not bump_pattern:
+                out.error(f"'{self.config['name']}' rule does not support bump")
+                raise SystemExit(NO_PATTERN_MAP)
+            increment = bump.find_increment(
+                commits, regex=bump_pattern, increments_map=bump_map
+            )
 
         # Increment is removed when current and next version
         # are expected to be prereleases.

commitizen/cz/base.py

@@ -1,7 +1,11 @@
+from typing import Optional
 from abc import ABCMeta, abstractmethod
 
 
 class BaseCommitizen(metaclass=ABCMeta):
+    bump_pattern: Optional[str] = None
+    bump_map: Optional[dict] = None
+
     def __init__(self, config: dict):
         self.config = config
 

commitizen/cz/conventional_commits/conventional_commits.py

@@ -1,6 +1,6 @@
 import os
 from commitizen.cz.base import BaseCommitizen
-
+from commitizen import defaults
 __all__ = ["ConventionalCommitsCz"]
 
 
@@ -30,6 +30,9 @@ def parse_subject(text):
 
 
 class ConventionalCommitsCz(BaseCommitizen):
+    bump_pattern = defaults.bump_pattern
+    bump_map = defaults.bump_map
+
     def questions(self) -> list:
         questions = [
             {

commitizen/defaults.py

@@ -8,3 +8,10 @@
     "files": [],
     "tag_format": None,  # example v$version
 }
+
+MAJOR = "MAJOR"
+MINOR = "MINOR"
+PATCH = "PATCH"
+
+bump_pattern = r"^(BREAKING CHANGE|feat)"
+bump_map = {"BREAKING CHANGE": MAJOR, "feat": MINOR}