commitizen 4.17.0__tar.gz → 4.18.0__tar.gz

{commitizen-4.17.0 → commitizen-4.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitizen
-Version: 4.17.0
+Version: 4.18.0
 Summary: Python commitizen client tool
 Keywords: commitizen,conventional,commits,git
 Author: Santiago Fraire
@@ -349,11 +349,6 @@ After installation, you can verify the completion is working by:
 
 For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).
 
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen)
-
-
 ## Sponsors
 
 These are our cool sponsors!

commitizen-4.18.0/commitizen/__version__.py

@@ -0,0 +1 @@
+__version__ = "4.18.0"

{commitizen-4.17.0 → commitizen-4.18.0}/commitizen/cli.py

@@ -165,6 +165,11 @@ data = {
                         "type": int,
                         "help": "Set the length limit of the commit message; 0 for no limit.",
                     },
+                    {
+                        "name": ["--body-length-limit"],
+                        "type": int,
+                        "help": "Set the length limit of the commit body. Commit message in body will be rewrapped to this length; 0 for no limit.",
+                    },
                     {
                         "name": ["--"],
                         "action": "store_true",

{commitizen-4.17.0 → commitizen-4.18.0}/commitizen/commands/commit.py

@@ -5,6 +5,8 @@ import os
 import shutil
 import subprocess
 import tempfile
+import textwrap
+from itertools import chain
 from pathlib import Path
 from typing import TYPE_CHECKING, TypedDict
 
@@ -36,6 +38,7 @@ class CommitArgs(TypedDict, total=False):
     edit: bool
     extra_cli_args: list[str]
     message_length_limit: int
+    body_length_limit: int
     no_retry: bool
     signoff: bool
     write_message_to_file: Path | None
@@ -82,6 +85,7 @@ class Commit:
 
         message = self.cz.message(answers)
         self._validate_subject_length(message)
+        message = self._wrap_body(message)
         return message
 
     def _validate_subject_length(self, message: str) -> None:
@@ -100,6 +104,28 @@ class Commit:
                 f"Length of commit message exceeds limit ({len(subject)}/{message_length_limit}), subject: '{subject}'"
             )
 
+    def _wrap_body(self, message: str) -> str:
+        """
+        Wrap the body of the commit message to the --body-length-limit length.
+        """
+
+        body_length_limit = self.arguments.get(
+            "body_length_limit", self.config.settings["body_length_limit"]
+        )
+        # By the contract, body_length_limit is set to 0 for no limit
+        if not body_length_limit or body_length_limit <= 0:
+            return message
+
+        lines = message.split("\n")
+        if len(lines) < 3:
+            return message
+
+        # First line is subject, second is blank line, rest are body lines
+        wrapped_body_lines = chain.from_iterable(
+            textwrap.wrap(line, width=body_length_limit) for line in lines[2:]
+        )
+        return "\n".join(chain(lines[:2], wrapped_body_lines))
+
     def manual_edit(self, message: str) -> str:
         editor = git.get_core_editor()
         if editor is None:

{commitizen-4.17.0 → commitizen-4.18.0}/commitizen/commands/init.py

@@ -109,13 +109,7 @@ class Init:
             tag_format = self._ask_tag_format(tag)  # confirm & text
             update_changelog_on_bump = self._ask_update_changelog_on_bump()  # confirm
             major_version_zero = self._ask_major_version_zero(version)  # confirm
-            hook_types: list[str] | None = 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=False),
-                    questionary.Choice("pre-push", checked=False),
-                ],
-            ).unsafe_ask()
+            hook_types = self._ask_hook_types()
         except KeyboardInterrupt:
             raise InitFailedError("Stopped by user")
 
@@ -128,13 +122,9 @@ class Init:
             ) as config_file:
                 yaml.safe_dump(config_data, stream=config_file)
 
-            if not project_info.is_pre_commit_installed():
-                raise InitFailedError(
-                    "Failed to install pre-commit hook.\n"
-                    "pre-commit is not installed in current environment."
-                )
+            installer = self._ask_hook_installer()
 
-            cmd_args = ["pre-commit", "install"]
+            cmd_args = [installer, "install"]
             for ty in hook_types:
                 cmd_args.extend(["--hook-type", ty])
             c = cmd.run(cmd_args)
@@ -164,6 +154,48 @@ class Init:
         out.info("\tcz bump\n")
         out.success("Configuration complete 🚀")
 
+    def _ask_hook_types(self) -> list[str] | None:
+        """Ask which pre-commit hook types to install.
+
+        Skip the question when neither ``pre-commit`` nor ``prek`` is
+        installed, so users who do not use those tools are not prompted.
+        """
+        if not project_info.available_hook_installers():
+            out.info("No pre-commit hook detected, skipping question")
+            return None
+
+        hook_types: list[str] | None = 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=False),
+                questionary.Choice("pre-push", checked=False),
+            ],
+        ).unsafe_ask()
+        return hook_types
+
+    def _ask_hook_installer(self) -> str:
+        """Choose ``pre-commit`` or ``prek`` when installing Git hooks.
+
+        Detection already accepts either tool, but install used to
+        hard-code ``pre-commit``. Use the only available installer, or
+        ask when both are on PATH.
+        """
+        installers = project_info.available_hook_installers()
+        if not installers:
+            raise InitFailedError(
+                "Failed to install pre-commit hook.\n"
+                "Neither pre-commit nor prek is installed in the current environment."
+            )
+        if len(installers) == 1:
+            return installers[0]
+
+        installer: str = questionary.select(
+            "Which hook installer do you want to use?",
+            choices=installers,
+            style=self.cz.style,
+        ).unsafe_ask()
+        return installer
+
     def _ask_config_path(self) -> Path:
         filename: str = questionary.select(
             "Please choose a supported config file: ",

{commitizen-4.17.0 → commitizen-4.18.0}/commitizen/defaults.py

@@ -49,6 +49,7 @@ class Settings(TypedDict, total=False):
     legacy_tag_formats: Sequence[str]
     major_version_zero: bool
     message_length_limit: int
+    body_length_limit: int
     name: str
     post_bump_hooks: list[str] | None
     pre_bump_hooks: list[str] | None
@@ -115,6 +116,7 @@ DEFAULT_SETTINGS: Settings = {
     "extras": {},
     "breaking_change_exclamation_in_title": False,
     "message_length_limit": 0,  # 0 for no limit
+    "body_length_limit": 0,  # 0 for no limit
 }
 
 MAJOR = "MAJOR"

{commitizen-4.17.0 → commitizen-4.18.0}/commitizen/project_info.py

@@ -4,9 +4,22 @@ import shutil
 from pathlib import Path
 from typing import Literal
 
+_HOOK_INSTALLERS = ("pre-commit", "prek")
+
+
+def available_hook_installers() -> list[str]:
+    """Return hook installer CLIs found on PATH.
+
+    ``pre-commit`` and ``prek`` are interchangeable. ``pre-commit`` is
+    listed first when both are present so existing setups keep a stable
+    default unless the user is asked to choose.
+    """
+    return [tool for tool in _HOOK_INSTALLERS if shutil.which(tool)]
+
 
 def is_pre_commit_installed() -> bool:
-    return any(shutil.which(tool) for tool in ("pre-commit", "prek"))
+    """Return whether any supported hook installer is on PATH."""
+    return bool(available_hook_installers())
 
 
 def get_default_version_provider() -> Literal[

{commitizen-4.17.0 → commitizen-4.18.0}/docs/README.md

@@ -303,11 +303,6 @@ After installation, you can verify the completion is working by:
 
 For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).
 
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen)
-
-
 ## Sponsors
 
 These are our cool sponsors!

{commitizen-4.17.0 → commitizen-4.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "commitizen"
-version = "4.17.0"
+version = "4.18.0"
 description = "Python commitizen client tool"
 license = "MIT"
 license-files = ["LICENSE"]

{commitizen-4.17.0 → commitizen-4.18.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "commitizen"
-version = "4.17.0"
+version = "4.18.0"
 description = "Python commitizen client tool"
 authors = [{ name = "Santiago Fraire", email = "santiwilly@gmail.com" }]
 maintainers = [

commitizen-4.17.0/commitizen/__version__.py

@@ -1 +0,0 @@
-__version__ = "4.17.0"