refactor(check): capitalize error message, rename variable

Author: bearomorphism

commitizen/commands/check.py

@@ -72,19 +72,17 @@ def __call__(self):
             raise NoCommitsFoundError(f"No commit found with range: '{self.rev_range}'")
 
         pattern = self.cz.schema_pattern()
-        displayed_msgs_content = "\n".join(
-            [
-                f'commit "{commit.rev}": "{commit.message}"'
-                for commit in commits
-                if not self.validate_commit_message(commit.message, pattern)
-            ]
+        invalid_msgs_content = "\n".join(
+            f'commit "{commit.rev}": "{commit.message}"'
+            for commit in commits
+            if not self._validate_commit_message(commit.message, pattern)
         )
-        if displayed_msgs_content:
+        if invalid_msgs_content:
             raise InvalidCommitMessageError(
-                "commit validation: failed!\n"
-                "please enter a commit message in the commitizen format.\n"
-                f"{displayed_msgs_content}\n"
-                f"pattern: {pattern}"
+                "Commit validation: failed!\n"
+                "Please enter a commit message in the commitizen format.\n"
+                f"{invalid_msgs_content}\n"
+                f"Pattern: {pattern}"
             )
         out.success("Commit validation: successful!")
 
@@ -135,14 +133,16 @@ def _filter_comments(msg: str) -> str:
                 lines.append(line)
         return "\n".join(lines)
 
-    def validate_commit_message(self, commit_msg: str, pattern: str) -> bool:
+    def _validate_commit_message(self, commit_msg: str, pattern: str) -> bool:
         if not commit_msg:
             return self.allow_abort
 
         if any(map(commit_msg.startswith, self.allowed_prefixes)):
             return True
+
         if self.max_msg_length:
             msg_len = len(commit_msg.partition("\n")[0].strip())
             if msg_len > self.max_msg_length:
                 return False
+
         return bool(re.match(pattern, commit_msg))

tests/commands/test_check_command.py

@@ -66,7 +66,7 @@ def test_check_jira_fails(mocker: MockFixture):
     )
     with pytest.raises(InvalidCommitMessageError) as excinfo:
         cli.main()
-    assert "commit validation: failed!" in str(excinfo.value)
+    assert "Commit validation: failed!" in str(excinfo.value)
 
 
 def test_check_jira_command_after_issue_one_space(mocker: MockFixture, capsys):
@@ -362,7 +362,7 @@ def test_check_command_with_pipe_message_and_failed(mocker: MockFixture):
 
     with pytest.raises(InvalidCommitMessageError) as excinfo:
         cli.main()
-    assert "commit validation: failed!" in str(excinfo.value)
+    assert "Commit validation: failed!" in str(excinfo.value)
 
 
 def test_check_command_with_comment_in_message_file(mocker: MockFixture, capsys):