feat(commit): add a tag(--body-length-limit) and a function for command commit

Author: yjaw

commitizen/cli.py

@@ -165,6 +165,11 @@ def __call__(
                         "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/commands/commit.py

@@ -6,6 +6,7 @@
 import subprocess
 import tempfile
 from pathlib import Path
+import textwrap
 from typing import TYPE_CHECKING, TypedDict
 
 import questionary
@@ -36,6 +37,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 +84,7 @@ def _get_message_by_prompt_commit_questions(self) -> str:
 
         message = self.cz.message(answers)
         self._validate_subject_length(message)
+        message = self._rewrap_body(message)
         return message
 
     def _validate_subject_length(self, message: str) -> None:
@@ -100,6 +103,29 @@ def _validate_subject_length(self, message: str) -> None:
                 f"Length of commit message exceeds limit ({len(subject)}/{message_length_limit}), subject: '{subject}'"
             )
 
+    def _rewrap_body(self, message: str) -> str:
+        body_length_limit = self.arguments.get(
+            "body_length_limit", self.config.settings.get("body_length_limit", 0)
+        )
+        # By the contract, body_length_limit is set to 0 for no limit
+        if (
+            body_length_limit is None or body_length_limit <= 0
+        ):  # do nothing for no limit
+            return message
+
+        message_parts = message.split("\n", 2)
+        if len(message_parts) < 3:
+            return message
+
+        # First line is subject, second is blank line, rest is body
+        subject = message_parts[0]
+        blank_line = message_parts[1]
+        body = message_parts[2].strip()
+        wrapped_body = textwrap.fill(
+            body, width=body_length_limit, replace_whitespace=False
+        )
+        return f"{subject}\n{blank_line}\n{wrapped_body}"
+
     def manual_edit(self, message: str) -> str:
         editor = git.get_core_editor()
         if editor is None:

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 @@ class Settings(TypedDict, total=False):
     "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"

tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_commit_.txt

@@ -1,6 +1,7 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+                 [-l MESSAGE_LENGTH_LIMIT]
+                 [--body-length-limit BODY_LENGTH_LIMIT] [--]
 
 Create new commit
 
@@ -22,4 +23,8 @@ options:
   -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT
                         Set the length limit of the commit message; 0 for no
                         limit.
+  --body-length-limit BODY_LENGTH_LIMIT
+                        Set the length limit of the commit body. Commit
+                        message in body will be rewrapped to this length; 0
+                        for no limit.
   --                    Positional arguments separator (recommended).

tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_commit_.txt

@@ -1,6 +1,7 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+                 [-l MESSAGE_LENGTH_LIMIT]
+                 [--body-length-limit BODY_LENGTH_LIMIT] [--]
 
 Create new commit
 
@@ -22,4 +23,8 @@ options:
   -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT
                         Set the length limit of the commit message; 0 for no
                         limit.
+  --body-length-limit BODY_LENGTH_LIMIT
+                        Set the length limit of the commit body. Commit
+                        message in body will be rewrapped to this length; 0
+                        for no limit.
   --                    Positional arguments separator (recommended).

tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_commit_.txt

@@ -1,6 +1,7 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+                 [-l MESSAGE_LENGTH_LIMIT]
+                 [--body-length-limit BODY_LENGTH_LIMIT] [--]
 
 Create new commit
 
@@ -22,4 +23,8 @@ options:
   -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT
                         Set the length limit of the commit message; 0 for no
                         limit.
+  --body-length-limit BODY_LENGTH_LIMIT
+                        Set the length limit of the commit body. Commit
+                        message in body will be rewrapped to this length; 0
+                        for no limit.
   --                    Positional arguments separator (recommended).

tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_commit_.txt

@@ -1,6 +1,7 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+                 [-l MESSAGE_LENGTH_LIMIT]
+                 [--body-length-limit BODY_LENGTH_LIMIT] [--]
 
 Create new commit
 
@@ -22,4 +23,8 @@ options:
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         Set the length limit of the commit message; 0 for no
                         limit.
+  --body-length-limit BODY_LENGTH_LIMIT
+                        Set the length limit of the commit body. Commit
+                        message in body will be rewrapped to this length; 0
+                        for no limit.
   --                    Positional arguments separator (recommended).

tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_commit_.txt

@@ -1,6 +1,7 @@
 usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
                  [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+                 [-l MESSAGE_LENGTH_LIMIT]
+                 [--body-length-limit BODY_LENGTH_LIMIT] [--]
 
 Create new commit
 
@@ -22,4 +23,8 @@ options:
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         Set the length limit of the commit message; 0 for no
                         limit.
+  --body-length-limit BODY_LENGTH_LIMIT
+                        Set the length limit of the commit body. Commit
+                        message in body will be rewrapped to this length; 0
+                        for no limit.
   --                    Positional arguments separator (recommended).

tests/test_conf.py

@@ -113,6 +113,7 @@
     "extras": {},
     "breaking_change_exclamation_in_title": False,
     "message_length_limit": 0,
+    "body_length_limit": 0,
 }
 
 _new_settings: dict[str, Any] = {
@@ -153,6 +154,7 @@
     "extras": {},
     "breaking_change_exclamation_in_title": False,
     "message_length_limit": 0,
+    "body_length_limit": 0,
 }