fix(changelog): rename message_hook -> changelog_message_builder_hook

Author: woile

commitizen/changelog.py

@@ -73,7 +73,7 @@ def generate_tree_from_commits(
     changelog_pattern: str = defaults.bump_pattern,
     unreleased_version: Optional[str] = None,
     change_type_map: Optional[Dict[str, str]] = None,
-    message_hook: Optional[Callable] = None,
+    changelog_message_builder_hook: Optional[Callable] = None,
 ) -> Iterable[Dict]:
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser)
@@ -120,8 +120,8 @@ def generate_tree_from_commits(
 
             if change_type_map:
                 change_type = change_type_map.get(change_type, change_type)
-            if message_hook:
-                parsed_message = message_hook(parsed_message, commit)
+            if changelog_message_builder_hook:
+                parsed_message = changelog_message_builder_hook(parsed_message, commit)
             changes[change_type].append(parsed_message)
         if message_body:
             parsed_message_body: Dict = message_body.groupdict()

commitizen/commands/changelog.py

@@ -64,7 +64,9 @@ def __call__(self):
         unreleased_version = self.unreleased_version
         changelog_meta: Dict = {}
         change_type_map: Optional[Dict] = self.change_type_map
-        message_hook: Optional[Callable] = self.cz.message_hook
+        changelog_message_builder_hook: Optional[
+            Callable
+        ] = self.cz.changelog_message_builder_hook
         changelog_hook: Optional[Callable] = self.cz.changelog_hook
 
         if not changelog_pattern or not commit_parser:
@@ -95,7 +97,7 @@ def __call__(self):
             changelog_pattern,
             unreleased_version,
             change_type_map=change_type_map,
-            message_hook=message_hook,
+            changelog_message_builder_hook=changelog_message_builder_hook,
         )
         changelog_out = changelog.render_changelog(tree)
 

commitizen/cz/base.py

@@ -31,7 +31,9 @@ class BaseCommitizen(metaclass=ABCMeta):
     change_type_map: Optional[Dict[str, str]] = None
 
     # Executed per message parsed by the commitizen
-    message_hook: Optional[Callable[[Dict, git.GitCommit], Dict]] = None
+    changelog_message_builder_hook: Optional[
+        Callable[[Dict, git.GitCommit], Dict]
+    ] = None
 
     # Executed only at the end of the changelog generation
     changelog_hook: Optional[Callable[[str, Optional[str]], str]] = None

docs/customization.md

@@ -142,7 +142,7 @@ You can customize it of course, and this are the variables you need to add to yo
 | `commit_parser`     | `str`                                                                    | NO       | Regex which should provide the variables explained in the [changelog description][changelog-des]                                                                |
 | `changelog_pattern` | `str`                                                                    | NO       | Regex to validate the commits, this is useful to skip commits that don't meet your rulling standards like a Merge. Usually the same as bump_pattern             |
 | `change_type_map`   | `dict`                                                                   | NO       | Convert the title of the change type that will appear in the changelog, if a value is not found, the original will be provided                                  |
-| `message_hook`      | `method: (dict, git.GitCommit) -> dict`                                  | NO       | Customize with extra information your message output, like adding links, this function is executed per parsed commit.                                           |
+| `changelog_message_builder_hook`      | `method: (dict, git.GitCommit) -> dict`                                  | NO       | Customize with extra information your message output, like adding links, this function is executed per parsed commit.                                           |
 | `changelog_hook`    | `method: (full_changelog: str, partial_changelog: Optional[str]) -> str` | NO       | Receives the whole and partial (if used incremental) changelog. Useful to send slack messages or notify a compliance department. Must return the full_changelog |
 
 ```python
@@ -160,7 +160,7 @@ class StrangeCommitizen(BaseCommitizen):
         "perf": "Performance improvements"
     }
 
-    def message_hook(self, parsed_message: dict, commit: git.GitCommit) -> dict:
+    def changelog_message_builder_hook(self, parsed_message: dict, commit: git.GitCommit) -> dict:
         rev = commit.rev
         m = parsed_message["message"]
         parsed_message["message"] = f"{m} {rev}"

tests/test_changelog.py

@@ -715,15 +715,19 @@ def test_render_changelog_with_change_type(gitcommits, tags):
     assert new_title in result
 
 
-def test_render_changelog_with_message_hook(gitcommits, tags):
-    def message_hook(message: dict, _) -> dict:
+def test_render_changelog_with_changelog_message_builder_hook(gitcommits, tags):
+    def changelog_message_builder_hook(message: dict, _) -> dict:
         message["message"] = f"{message['message']} [link](github.com/232323232)"
         return message
 
     parser = defaults.commit_parser
     changelog_pattern = defaults.bump_pattern
     tree = changelog.generate_tree_from_commits(
-        gitcommits, tags, parser, changelog_pattern, message_hook=message_hook
+        gitcommits,
+        tags,
+        parser,
+        changelog_pattern,
+        changelog_message_builder_hook=changelog_message_builder_hook,
     )
     result = changelog.render_changelog(tree)
     assert "[link](github.com/232323232)" in result