feat(check): add check against default branch

Author: bearomorphism

commitizen/cli.py

@@ -471,6 +471,13 @@ def __call__(
                         "help": "a range of git rev to check. e.g, master..HEAD",
                         "exclusive_group": "group1",
                     },
+                    {
+                        "name": ["-d", "--use-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",

commitizen/commands/check.py

@@ -21,6 +21,7 @@ class CheckArgs(TypedDict, total=False):
     message_length_limit: int
     allowed_prefixes: list[str]
     message: str
+    use_default_range: bool
 
 
 class Check:
@@ -40,6 +41,7 @@ def __init__(self, config: BaseConfig, arguments: CheckArgs, *args: object) -> N
         self.allow_abort = bool(
             arguments.get("allow_abort", config.settings["allow_abort"])
         )
+        self.use_default_range = bool(arguments.get("use_default_range"))
         self.max_msg_length = arguments.get("message_length_limit", 0)
 
         # we need to distinguish between None and [], which is a valid value
@@ -50,25 +52,28 @@ def __init__(self, config: BaseConfig, arguments: CheckArgs, *args: object) -> N
             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) -> None:
         num_exclusive_args_provided = 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) -> None:
         """Validate if commit messages follows the conventional pattern.
 
@@ -109,7 +114,10 @@ def _get_commits(self) -> list[git.GitCommit]:
             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)
+        return git.get_commits(
+            git.get_default_branch() if self.use_default_range else None,
+            self.rev_range,
+        )
 
     @staticmethod
     def _filter_comments(msg: str) -> str:
@@ -134,7 +142,7 @@ def _filter_comments(msg: str) -> str:
             The filtered commit message without comments.
         """
 
-        lines = []
+        lines: list[str] = []
         for line in msg.split("\n"):
             if "# ------------------------ >8 ------------------------" in line:
                 break

commitizen/git.py

@@ -332,3 +332,10 @@ def _get_log_as_str_list(start: str | None, end: str, args: str) -> list[str]:
     if c.return_code != 0:
         raise GitCommandError(c.err)
     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()

docs/commands/check.md

@@ -27,35 +27,37 @@ $ cz check --rev-range REV_RANGE
 
 For example, if you'd like to check all commits on a branch, you can use `--rev-range master..HEAD`. Or, if you'd like to check all commits starting from when you first implemented commit message linting, you can use `--rev-range <first_commit_sha>..HEAD`.
 
+You can also use `--use-default-range` to check all commits from the default branch up to HEAD. This is equivalent to using `--rev-range <default_branch>..HEAD`.
+
 For more information on how git commit ranges work, you can check the [git documentation](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_commit_ranges).
 
 ### Commit Message
 
 There are two ways you can provide your plain message and check it.
 
-#### Method 1: use -m or --message
+#### Method 1: use `-m` or `--message`
 
 ```bash
 $ cz check --message MESSAGE
 ```
 
-In this option, MESSAGE is the commit message to be checked.
+In this option, `MESSAGE` is the commit message to be checked.
 
 #### Method 2: use pipe to pipe it to `cz check`
 
 ```bash
 $ echo MESSAGE | cz check
 ```
 
-In this option, MESSAGE is piped to cz check and will be checked.
+In this option, `MESSAGE` is piped to `cz check` and will be checked.
 
 ### Commit Message File
 
 ```bash
 $ cz check --commit-msg-file COMMIT_MSG_FILE
 ```
 
-In this option, COMMIT_MSG_FILE is the path of the temporary file that contains the commit message.
+In this option, `COMMIT_MSG_FILE` is the path of the temporary file that contains the commit message.
 This argument can be useful when cooperating with git hooks. Please check [Automatically check message before commit](../tutorials/auto_check.md) for more information about how to use this argument with git hooks.
 
 ### Allow Abort
@@ -65,12 +67,18 @@ cz check --message MESSAGE --allow-abort
 ```
 
 Empty commit messages typically instruct Git to abort a commit, so you can pass `--allow-abort` to
-permit them. Since `git commit` accepts an `--allow-empty-message` flag (primarily for wrapper scripts), you may wish to disallow such commits in CI. `--allow-abort` may be used in conjunction with any of the other options.
+permit them. Since `git commit` accepts the `--allow-empty-message` flag (primarily for wrapper scripts), you may wish to disallow such commits in CI. `--allow-abort` may be used in conjunction with any of the other options.
 
 ### Allowed Prefixes
 
 If the commit message starts with some specific prefixes, `cz check` returns `True` without checking the regex.
-By default, the following prefixes are allowed: `Merge`, `Revert`, `Pull request`, `fixup!` and `squash!`.
+By default, the following prefixes are allowed:
+
+- `Merge`
+- `Revert`
+- `Pull request`
+- `fixup!`
+- `squash!`
 
 ```bash
 cz check --message MESSAGE --allowed-prefixes 'Merge' 'Revert' 'Custom Prefix'
@@ -83,5 +91,5 @@ For example, `cz check --message MESSAGE -l 3` would fail the check, since `MESS
 By default, the limit is set to 0, which means no limit on the length.
 
 **Note that the limit applies only to the first line of the message.**
-Specifically, for `ConventionalCommitsCz` the length only counts from the type of change to the subject,
-while the body and the footer are not counted.
+
+Specifically, for `ConventionalCommitsCz` the length only counts from the type of change to the subject, while the body and the footer are not counted.

tests/commands/test_check_command/test_check_command_shows_description_when_use_help_option.txt

@@ -1,5 +1,5 @@
 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]
 
@@ -13,6 +13,9 @@ options:
                         MSG_FILE=$1
   --rev-range REV_RANGE
                         a range of git rev to check. e.g, master..HEAD
+  -d, --use-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

tests/test_git.py

@@ -480,3 +480,22 @@ def test_create_commit_cmd_string(mocker, os_name, committer_date, expected_cmd)
     mocker.patch("os.name", os_name)
     result = git._create_commit_cmd_string("", committer_date, "temp.txt")
     assert result == expected_cmd
+
+
+def test_get_default_branch_success(mocker: MockFixture):
+    mocker.patch(
+        "commitizen.cmd.run", return_value=FakeCommand(out="refs/remotes/origin/main\n")
+    )
+    assert git.get_default_branch() == "refs/remotes/origin/main"
+
+
+def test_get_default_branch_error(mocker: MockFixture):
+    mocker.patch(
+        "commitizen.cmd.run",
+        return_value=FakeCommand(
+            err="fatal: ref refs/remotes/origin/HEAD is not a symbolic ref",
+            return_code=1,
+        ),
+    )
+    with pytest.raises(exceptions.GitCommandError):
+        git.get_default_branch()