feat(check): add check against default branch

Author: bearomorphism

commitizen/cli.py

@@ -475,6 +475,13 @@ def __call__(
                         "help": "a range of git rev to check. e.g, master..HEAD",
                         "exclusive_group": "group1",
                     },
+                    {
+                        "name": ["-d", "--default-range"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "check from the default branch to HEAD. e.g, refs/remotes/origin/master..HEAD",
+                        "exclusive_group": "group1",
+                    },
                     {
                         "name": ["-m", "--message"],
                         "help": "commit message that needs to be checked",
@@ -499,6 +506,12 @@ def __call__(
                         "default": 0,
                         "help": "length limit of the commit message; 0 for no limit",
                     },
+                    {
+                        "name": ["-v", "--verbose"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "show verbose output",
+                    },
                 ],
             },
             {

commitizen/commands/check.py

@@ -3,7 +3,7 @@
 import os
 import re
 import sys
-from typing import Any
+from typing import Any, TypedDict
 
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
@@ -14,6 +14,18 @@
 )
 
 
+class CheckArgs(TypedDict, total=False):
+    commit_msg_file: str
+    commit_msg: str
+    rev_range: str
+    allow_abort: bool
+    message_length_limit: int
+    allowed_prefixes: list[str]
+    message: str
+    default_range: bool
+    verbose: bool
+
+
 class Check:
     """Check if the current commit msg matches the commitizen format."""
 
@@ -31,7 +43,9 @@ def __init__(self, config: BaseConfig, arguments: dict[str, Any], cwd=os.getcwd(
         self.allow_abort: bool = bool(
             arguments.get("allow_abort", config.settings["allow_abort"])
         )
-        self.max_msg_length: int = arguments.get("message_length_limit", 0)
+        self.default_range = bool(arguments.get("default_range"))
+        self.verbose = bool(arguments.get("verbose"))
+        self.max_msg_length = arguments.get("message_length_limit", 0)
 
         # we need to distinguish between None and [], which is a valid value
 
@@ -42,25 +56,28 @@ def __init__(self, config: BaseConfig, arguments: dict[str, Any], cwd=os.getcwd(
             else config.settings["allowed_prefixes"]
         )
 
-        self._valid_command_argument()
-
-        self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
-        self.cz = factory.committer_factory(self.config)
-
-    def _valid_command_argument(self):
-        num_exclusive_args_provided = sum(
+        num_exclusive_args_provided = self.default_range + sum(
             arg is not None
-            for arg in (self.commit_msg_file, self.commit_msg, self.rev_range)
+            for arg in (
+                self.commit_msg_file,
+                self.commit_msg,
+                self.rev_range,
+            )
         )
-        if num_exclusive_args_provided == 0 and not sys.stdin.isatty():
-            self.commit_msg = sys.stdin.read()
-        elif num_exclusive_args_provided != 1:
+
+        if num_exclusive_args_provided > 1:
             raise InvalidCommandArgumentError(
                 "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command! "
                 "See 'cz check -h' for more information"
             )
 
+        if num_exclusive_args_provided == 0 and not sys.stdin.isatty():
+            self.commit_msg = sys.stdin.read()
+
+        self.config: BaseConfig = config
+        self.encoding = config.settings["encoding"]
+        self.cz = factory.committer_factory(self.config)
+
     def __call__(self):
         """Validate if commit messages follows the conventional pattern.
 
@@ -102,7 +119,10 @@ def _get_commits(self):
             return [git.GitCommit(rev="", title="", body=self._filter_comments(msg))]
 
         # Get commit messages from git log (--rev-range)
-        return git.get_commits(end=self.rev_range or "HEAD")
+        return git.get_commits(
+            git.get_default_branch() if self.default_range else None,
+            self.rev_range or "HEAD",
+        )
 
     @staticmethod
     def _filter_comments(msg: str) -> str:
@@ -136,6 +156,9 @@ def _filter_comments(msg: str) -> str:
         return "\n".join(lines)
 
     def validate_commit_message(self, commit_msg: str, pattern: str) -> bool:
+        if self.verbose:
+            out.info(commit_msg)
+
         if not commit_msg:
             return self.allow_abort
 

commitizen/git.py

@@ -326,3 +326,10 @@ def _get_log_as_str_list(start: str | None, end: str, args: str) -> list[str]:
     if not c.out:
         return []
     return c.out.split(f"{delimiter}\n")
+
+
+def get_default_branch() -> str:
+    c = cmd.run("git symbolic-ref refs/remotes/origin/HEAD")
+    if c.return_code != 0:
+        raise GitCommandError(c.err)
+    return c.out.strip()

tests/commands/test_check_command/test_check_command_shows_description_when_use_help_option.txt

@@ -1,7 +1,7 @@
 usage: cz check [-h] [--commit-msg-file COMMIT_MSG_FILE |
-                --rev-range REV_RANGE | -m MESSAGE] [--allow-abort]
+                --rev-range REV_RANGE | -d | -m MESSAGE] [--allow-abort]
                 [--allowed-prefixes [ALLOWED_PREFIXES ...]]
-                [-l MESSAGE_LENGTH_LIMIT]
+                [-l MESSAGE_LENGTH_LIMIT] [-v]
 
 validates that a commit message matches the commitizen schema
 
@@ -13,6 +13,8 @@ options:
                         MSG_FILE=$1
   --rev-range REV_RANGE
                         a range of git rev to check. e.g, master..HEAD
+  -d, --default-range   check from the default branch to HEAD. e.g,
+                        refs/remotes/origin/master..HEAD
   -m, --message MESSAGE
                         commit message that needs to be checked
   --allow-abort         allow empty commit messages, which typically abort a
@@ -23,3 +25,4 @@ options:
                         against the regex
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
                         length limit of the commit message; 0 for no limit
+  -v, --verbose         show verbose output