feat: check if commit message is no more than 72 characters

Author: kevin1kevin1k

commitizen/cli.py

@@ -66,6 +66,11 @@
                         "action": "store_true",
                         "help": "Sign off the commit",
                     },
+                    {
+                        "name": ["-cl", "--check-length"],
+                        "action": "store_true",
+                        "help": "check if length of commit message is within limit",
+                    },
                 ],
             },
             {

commitizen/commands/commit.py

@@ -29,6 +29,8 @@ def __init__(self, config: BaseConfig, arguments: dict):
         self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
         self.arguments = arguments
+        print(self.config)
+        print(self.arguments)
         self.temp_file: str = os.path.join(
             tempfile.gettempdir(),
             "cz.commit{user}.backup".format(user=os.environ.get("USER", "")),
@@ -59,7 +61,9 @@ def prompt_commit_questions(self) -> str:
 
         if not answers:
             raise NoAnswersError()
-        return cz.message(answers)
+
+        check_length: bool = self.arguments.get("check_length", False)
+        return cz.message(answers, check_length=check_length)
 
     def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")

commitizen/cz/base.py

@@ -50,7 +50,7 @@ def questions(self) -> Questions:
         """Questions regarding the commit message."""
 
     @abstractmethod
-    def message(self, answers: dict) -> str:
+    def message(self, answers: dict, check_length: Optional[bool] = False) -> str:
         """Format your git message."""
 
     @property

commitizen/cz/conventional_commits/conventional_commits.py

@@ -1,10 +1,12 @@
 import os
 import re
+from typing import Optional
 
 from commitizen import defaults
 from commitizen.cz.base import BaseCommitizen
 from commitizen.cz.utils import multiple_line_breaker, required_validator
 from commitizen.defaults import Questions
+from commitizen.exceptions import CommitMessageLineLengthExceededError
 
 __all__ = ["ConventionalCommitsCz"]
 
@@ -150,7 +152,7 @@ def questions(self) -> Questions:
         ]
         return questions
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: dict, check_length: Optional[bool] = False) -> str:
         prefix = answers["prefix"]
         scope = answers["scope"]
         subject = answers["subject"]
@@ -167,7 +169,15 @@ def message(self, answers: dict) -> str:
         if footer:
             footer = f"\n\n{footer}"
 
-        message = f"{prefix}{scope}: {subject}{body}{footer}"
+        message = f"{prefix}{scope}: {subject}"
+        message_len = len(message)
+        MESSAGE_LEN_LIMIT = 72
+        if check_length and message_len > MESSAGE_LEN_LIMIT:
+            raise CommitMessageLineLengthExceededError(
+                f"Length of commit message exceeded limit ({message_len}/{MESSAGE_LEN_LIMIT})"
+            )
+
+        message = f"{message}{body}{footer}"
 
         return message
 

commitizen/cz/customize/customize.py

@@ -53,7 +53,7 @@ def __init__(self, config: BaseConfig):
     def questions(self) -> Questions:
         return self.custom_settings.get("questions", [{}])
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: dict, check_length: Optional[bool] = False) -> str:
         message_template = Template(self.custom_settings.get("message_template", ""))
         if getattr(Template, "substitute", None):
             return message_template.substitute(**answers)  # type: ignore

commitizen/cz/jira/jira.py

@@ -1,4 +1,5 @@
 import os
+from typing import Optional
 
 from commitizen.cz.base import BaseCommitizen
 from commitizen.defaults import Questions
@@ -44,7 +45,7 @@ def questions(self) -> Questions:
         ]
         return questions
 
-    def message(self, answers) -> str:
+    def message(self, answers: dict, check_length: Optional[bool] = False) -> str:
         return " ".join(
             filter(
                 bool,

commitizen/exceptions.py

@@ -27,6 +27,7 @@ class ExitCode(enum.IntEnum):
     NOT_ALLOWED = 20
     NO_INCREMENT = 21
     UNRECOGNIZED_CHARACTERSET_ENCODING = 22
+    COMMIT_MESSAGE_LINE_LENGTH_EXCEEDED = 23
 
 
 class CommitizenException(Exception):
@@ -153,3 +154,7 @@ class NotAllowed(CommitizenException):
 
 class CharacterSetDecodeError(CommitizenException):
     exit_code = ExitCode.UNRECOGNIZED_CHARACTERSET_ENCODING
+
+
+class CommitMessageLineLengthExceededError(CommitizenException):
+    exit_code = ExitCode.COMMIT_MESSAGE_LINE_LENGTH_EXCEEDED

docs/customization.md

@@ -210,6 +210,8 @@ Create a file starting with `cz_`, for example `cz_jira.py`. This prefix is used
 Inherit from `BaseCommitizen`, and you must define `questions` and `message`. The others are optional.
 
 ```python
+from typing import Optional
+
 from commitizen.cz.base import BaseCommitizen
 from commitizen.defaults import Questions
 
@@ -232,7 +234,7 @@ class JiraCz(BaseCommitizen):
         ]
         return questions
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: dict, check_length: Optional[bool] = False) -> str:
         """Generate the message with the given answers."""
         return '{0} (#{1})'.format(answers['title'], answers['issue'])
 

tests/test_cz_base.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 import pytest
 
 from commitizen.cz.base import BaseCommitizen
@@ -7,7 +9,7 @@ class DummyCz(BaseCommitizen):
     def questions(self):
         return [{"type": "input", "name": "commit", "message": "Initial commit:\n"}]
 
-    def message(self, answers):
+    def message(self, answers: dict, check_length: Optional[bool] = False):
         return answers["commit"]