Merge branch 'master' of github.com:commitizen-tools/commitizen into add-hooks-for-bump-command

Author: skoef

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: no-commit-to-branch
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v2.38.0 # automatically updated by Commitizen
+    rev: v2.39.1 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,4 +1,25 @@
 
+## v2.39.1 (2022-12-31)
+
+### Fix
+
+- filter git diff from commit message
+
+## v2.39.0 (2022-12-31)
+
+### Feat
+
+- **init**: allow user to select which type of pre commit hooks to install
+
+### Fix
+
+- **init**: space between `--hook-type` options
+- **init**: report error when hook installation failed
+
+### Refactor
+
+- **init**: `_install_pre_commit_hook` raise error when failed
+
 ## v2.38.0 (2022-12-12)
 
 ### Feat

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "2.38.0"
+__version__ = "2.39.1"

commitizen/commands/check.py

@@ -1,7 +1,7 @@
 import os
 import re
 import sys
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
@@ -15,7 +15,7 @@
 class Check:
     """Check if the current commit msg matches the commitizen format."""
 
-    def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd()):
+    def __init__(self, config: BaseConfig, arguments: Dict[str, Any], cwd=os.getcwd()):
         """Initial check command.
 
         Args:
@@ -98,8 +98,35 @@ def _get_commits(self):
         # Get commit messages from git log (--rev-range)
         return git.get_commits(end=self.rev_range)
 
-    def _filter_comments(self, msg: str) -> str:
-        lines = [line for line in msg.split("\n") if not line.startswith("#")]
+    @staticmethod
+    def _filter_comments(msg: str) -> str:
+        """Filter the commit message by removing comments.
+
+        When using `git commit --verbose`, we exclude the diff that is going to
+        generated, like the following example:
+
+        ```bash
+        ...
+        # ------------------------ >8 ------------------------
+        # Do not modify or remove the line above.
+        # Everything below it will be ignored.
+        diff --git a/... b/...
+        ...
+        ```
+
+        Args:
+            msg: The commit message to filter.
+
+        Returns:
+            The filtered commit message without comments.
+        """
+
+        lines = []
+        for line in msg.split("\n"):
+            if "# ------------------------ >8 ------------------------" in line:
+                break
+            if not line.startswith("#"):
+                lines.append(line)
         return "\n".join(lines)
 
     def validate_commit_message(self, commit_msg: str, pattern: str) -> bool:

commitizen/commands/init.py

@@ -1,4 +1,6 @@
 import os
+import shutil
+from typing import Any, Dict, List, Optional
 
 import questionary
 import yaml
@@ -9,7 +11,7 @@
 from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig
 from commitizen.cz import registry
 from commitizen.defaults import config_files
-from commitizen.exceptions import NoAnswersError
+from commitizen.exceptions import InitFailedError, NoAnswersError
 from commitizen.git import get_latest_tag_name, get_tag_names, smart_open
 
 
@@ -19,34 +21,43 @@ def __init__(self, config: BaseConfig, *args):
         self.cz = factory.commiter_factory(self.config)
 
     def __call__(self):
-        values_to_add = {}
+        if self.config.path:
+            out.line(f"Config file {self.config.path} already exists")
+            return
 
         # No config for commitizen exist
-        if not self.config.path:
-            config_path = self._ask_config_path()
-            if "toml" in config_path:
-                self.config = TomlConfig(data="", path=config_path)
-            elif "json" in config_path:
-                self.config = JsonConfig(data="{}", path=config_path)
-            elif "yaml" in config_path:
-                self.config = YAMLConfig(data="", path=config_path)
-
-            self.config.init_empty_config_content()
-
-            values_to_add["name"] = self._ask_name()
-            tag = self._ask_tag()
-            values_to_add["version"] = Version(tag).public
-            values_to_add["tag_format"] = self._ask_tag_format(tag)
-            self._update_config_file(values_to_add)
-
-            if questionary.confirm("Do you want to install pre-commit hook?").ask():
-                self._install_pre_commit_hook()
-
-            out.write("You can bump the version and create changelog running:\n")
-            out.info("cz bump --changelog")
-            out.success("The configuration are all set.")
-        else:
-            out.line(f"Config file {self.config.path} already exists")
+        config_path = self._ask_config_path()
+        if "toml" in config_path:
+            self.config = TomlConfig(data="", path=config_path)
+        elif "json" in config_path:
+            self.config = JsonConfig(data="{}", path=config_path)
+        elif "yaml" in config_path:
+            self.config = YAMLConfig(data="", path=config_path)
+        self.config.init_empty_config_content()
+
+        values_to_add = {}
+        values_to_add["name"] = self._ask_name()
+        tag = self._ask_tag()
+        values_to_add["version"] = Version(tag).public
+        values_to_add["tag_format"] = self._ask_tag_format(tag)
+        self._update_config_file(values_to_add)
+
+        hook_types = questionary.checkbox(
+            "What types of pre-commit hook you want to install? (Leave blank if you don't want to install)",
+            choices=[
+                questionary.Choice("commit-msg", checked=True),
+                questionary.Choice("pre-push", checked=True),
+            ],
+        ).ask()
+        if hook_types:
+            try:
+                self._install_pre_commit_hook(hook_types)
+            except InitFailedError as e:
+                raise InitFailedError(f"Failed to install pre-commit hook.\n{e}")
+
+        out.write("You can bump the version and create changelog running:\n")
+        out.info("cz bump --changelog")
+        out.success("The configuration are all set.")
 
     def _ask_config_path(self) -> str:
         name: str = questionary.select(
@@ -109,17 +120,45 @@ def _ask_tag_format(self, latest_tag) -> str:
                 tag_format = "$version"
         return tag_format
 
-    def _install_pre_commit_hook(self):
+    def _search_pre_commit(self) -> bool:
+        """Check whether pre-commit is installed"""
+        return shutil.which("pre-commit") is not None
+
+    def _exec_install_pre_commit_hook(self, hook_types: List[str]):
+        cmd_str = self._gen_pre_commit_cmd(hook_types)
+        c = cmd.run(cmd_str)
+        if c.return_code != 0:
+            err_msg = (
+                f"Error running {cmd_str}."
+                "Outputs are attached below:\n"
+                f"stdout: {c.out}\n"
+                f"stderr: {c.err}"
+            )
+            raise InitFailedError(err_msg)
+
+    def _gen_pre_commit_cmd(self, hook_types: List[str]) -> str:
+        """Generate pre-commit command according to given hook types"""
+        if not hook_types:
+            raise ValueError("At least 1 hook type should be provided.")
+        cmd_str = "pre-commit install " + " ".join(
+            f"--hook-type {ty}" for ty in hook_types
+        )
+        return cmd_str
+
+    def _install_pre_commit_hook(self, hook_types: Optional[List[str]] = None):
         pre_commit_config_filename = ".pre-commit-config.yaml"
         cz_hook_config = {
             "repo": "https://github.com/commitizen-tools/commitizen",
             "rev": f"v{__version__}",
-            "hooks": [{"id": "commitizen"}],
+            "hooks": [
+                {"id": "commitizen"},
+                {"id": "commitizen-branch", "stages": ["push"]},
+            ],
         }
 
         config_data = {}
         if not os.path.isfile(pre_commit_config_filename):
-            # .pre-commit-config does not exist
+            # .pre-commit-config.yaml does not exist
             config_data["repos"] = [cz_hook_config]
         else:
             with open(pre_commit_config_filename) as config_file:
@@ -135,23 +174,21 @@ def _install_pre_commit_hook(self):
                 else:
                     config_data["repos"].append(cz_hook_config)
             else:
-                # .pre-commit-config exists but there's no "repos" key
+                # .pre-commit-config.yaml exists but there's no "repos" key
                 config_data["repos"] = [cz_hook_config]
 
         with smart_open(pre_commit_config_filename, "w") as config_file:
             yaml.safe_dump(config_data, stream=config_file)
 
-        c = cmd.run("pre-commit install --hook-type commit-msg")
-        if c.return_code == 127:
-            out.error(
-                "pre-commit is not installed in current environement.\n"
-                "Run 'pre-commit install --hook-type commit-msg' again after it's installed"
+        if not self._search_pre_commit():
+            raise InitFailedError(
+                "pre-commit is not installed in current environement."
             )
-        elif c.return_code != 0:
-            out.error(c.err)
-        else:
-            out.write("commitizen pre-commit hook is now installed in your '.git'\n")
+        if hook_types is None:
+            hook_types = ["commit-msg", "pre-push"]
+        self._exec_install_pre_commit_hook(hook_types)
+        out.write("commitizen pre-commit hook is now installed in your '.git'\n")
 
-    def _update_config_file(self, values):
+    def _update_config_file(self, values: Dict[str, Any]):
         for key, value in values.items():
             self.config.set_key(key, value)

commitizen/exceptions.py

@@ -29,7 +29,8 @@ class ExitCode(enum.IntEnum):
     UNRECOGNIZED_CHARACTERSET_ENCODING = 22
     GIT_COMMAND_ERROR = 23
     INVALID_MANUAL_VERSION = 24
-    RUN_HOOK_FAILED = 25
+    INIT_FAILED = 25
+    RUN_HOOK_FAILED = 26
 
 
 class CommitizenException(Exception):
@@ -166,5 +167,9 @@ class InvalidManualVersion(CommitizenException):
     exit_code = ExitCode.INVALID_MANUAL_VERSION
 
 
+class InitFailedError(CommitizenException):
+    exit_code = ExitCode.INIT_FAILED
+
+
 class RunHookError(CommitizenException):
     exit_code = ExitCode.RUN_HOOK_FAILED

commitizen/hooks.py

@@ -1,3 +1,5 @@
+import os
+
 from commitizen import cmd, out
 from commitizen.exceptions import RunHookError
 
@@ -20,10 +22,11 @@ def run(hooks, _env_prefix="CZ_", **env):
             raise RunHookError(f"Running hook '{hook}' failed")
 
 
-def _format_env(prefix: str, env: dict[str, str]) -> dict[str, str]:
+def _format_env(prefix, env):
     """_format_env() prefixes all given environment variables with the given
-    prefix so it can be passed directly to cmd.run()."""
-    penv = dict()
+    prefix and adds them to the current OS environment variables, so it can be
+    passed directly to cmd.run()."""
+    penv = os.environ.copy()
     for name, value in env.items():
         name = prefix + name.upper()
         value = str(value) if value is not None else ""

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "2.38.0"
+version = "2.39.1"
 tag_format = "v$version"
 version_files = [
   "pyproject.toml:version",
@@ -30,7 +30,7 @@ exclude = '''
 
 [tool.poetry]
 name = "commitizen"
-version = "2.38.0"
+version = "2.39.1"
 description = "Python commitizen client tool"
 authors = ["Santiago Fraire <santiwilly@gmail.com>"]
 license = "MIT"