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

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

@@ -5,6 +5,8 @@
 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 @@ def _get_message_by_prompt_commit_questions(self) -> str:
 
         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 @@ def _validate_subject_length(self, message: str) -> None:
                 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/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_commit_command.py

@@ -374,3 +374,70 @@ def test_commit_command_with_config_message_length_limit(
     success_mock.reset_mock()
     commands.Commit(config, {"message_length_limit": 0})()
     success_mock.assert_called_once()
+
+
+@pytest.mark.usefixtures("staging_is_clean")
+@pytest.mark.parametrize(
+    ("body", "body_length_limit"),
+    [
+        pytest.param(
+            "This is a very long line that exceeds 72 characters and should be automatically wrapped by the system to fit within the limit",
+            72,
+            id="wrapping",
+        ),
+        pytest.param(
+            "Line1 is shorter than the limit but has newline\nLine2 is shorter than the limit but has newline\nLine3 is shorter than the limit but has newline",
+            100,
+            id="preserves_line_breaks",
+        ),
+        pytest.param(
+            "This is a very long line that exceeds 72 characters and should NOT be wrapped when body_length_limit is set to 0",
+            0,
+            id="disabled",
+        ),
+        pytest.param(
+            "",
+            72,
+            id="no_body",
+        ),
+    ],
+)
+def test_commit_command_body_length_limit(
+    body,
+    body_length_limit,
+    config,
+    success_mock: MockType,
+    commit_mock,
+    mocker: MockFixture,
+    file_regression,
+):
+    """Parameterized test for body_length_limit feature with file regression."""
+    mocker.patch(
+        "questionary.prompt",
+        return_value={
+            "prefix": "feat",
+            "subject": "add feature",
+            "scope": "",
+            "is_breaking_change": False,
+            "body": body,
+            "footer": "",
+        },
+    )
+
+    commands.Commit(config, {"body_length_limit": body_length_limit})()
+    success_mock.assert_called_once()
+    committed_message = commit_mock.call_args[0][0]
+    file_regression.check(committed_message, extension=".txt")
+
+    lines = committed_message.split("\n")
+    body_lines = lines[2:]  # Skip subject and blank line
+
+    if body_length_limit > 0:
+        for line in body_lines:
+            assert len(line) <= body_length_limit, (
+                f"Line exceeds {body_length_limit} chars: '{line}' ({len(line)} chars)"
+            )
+    elif body_length_limit == 0:
+        assert len(body_lines) == 1, (
+            "Body should not be wrapped when body_length_limit is set to 0"
+        )

tests/commands/test_commit_command/test_commit_command_body_length_limit_disabled_.txt

@@ -0,0 +1,3 @@
+feat: add feature
+
+This is a very long line that exceeds 72 characters and should NOT be wrapped when body_length_limit is set to 0

tests/commands/test_commit_command/test_commit_command_body_length_limit_no_body_.txt

@@ -0,0 +1 @@
+feat: add feature

tests/commands/test_commit_command/test_commit_command_body_length_limit_preserves_line_breaks_.txt

@@ -0,0 +1,5 @@
+feat: add feature
+
+Line1 is shorter than the limit but has newline
+Line2 is shorter than the limit but has newline
+Line3 is shorter than the limit but has newline

tests/commands/test_commit_command/test_commit_command_body_length_limit_wrapping_.txt

@@ -0,0 +1,4 @@
+feat: add feature
+
+This is a very long line that exceeds 72 characters and should be
+automatically wrapped by the system to fit within the limit

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).