Merge branch 'v4-9-0-test' into feat/Add-config-option-for-line-length-warning

Author: Narwhal-fish

.pre-commit-hooks.yaml

@@ -24,4 +24,4 @@
   pass_filenames: false
   language: python
   language_version: python3
-  minimum_pre_commit_version: "1.4.3"
+  minimum_pre_commit_version: "3.2.0"

commitizen/changelog.py

@@ -32,6 +32,7 @@
 from collections.abc import Generator, Iterable, Mapping, MutableMapping, Sequence
 from dataclasses import dataclass
 from datetime import date
+from itertools import chain
 from typing import TYPE_CHECKING, Any
 
 from jinja2 import (
@@ -88,33 +89,32 @@ def generate_tree_from_commits(
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser, re.MULTILINE)
     body_map_pat = re.compile(commit_parser, re.MULTILINE | re.DOTALL)
-    current_tag: GitTag | None = None
     rules = rules or TagRules()
 
     # Check if the latest commit is not tagged
-    if commits:
-        latest_commit = commits[0]
-        current_tag = get_commit_tag(latest_commit, tags)
-
-    current_tag_name: str = unreleased_version or "Unreleased"
-    current_tag_date: str = ""
-    if unreleased_version is not None:
-        current_tag_date = date.today().isoformat()
-    if current_tag is not None and current_tag.name:
-        current_tag_name = current_tag.name
-        current_tag_date = current_tag.date
 
+    current_tag = get_commit_tag(commits[0], tags) if commits else None
+    current_tag_name = unreleased_version or "Unreleased"
+    current_tag_date = (
+        date.today().isoformat() if unreleased_version is not None else ""
+    )
+
+    used_tags: set[GitTag] = set()
+    if current_tag:
+        used_tags.add(current_tag)
+        if current_tag.name:
+            current_tag_name = current_tag.name
+            current_tag_date = current_tag.date
+
+    commit_tag: GitTag | None = None
     changes: dict = defaultdict(list)
-    used_tags: list = [current_tag]
     for commit in commits:
-        commit_tag = get_commit_tag(commit, tags)
-
         if (
-            commit_tag
+            (commit_tag := get_commit_tag(commit, tags))
             and commit_tag not in used_tags
             and rules.include_in_changelog(commit_tag)
         ):
-            used_tags.append(commit_tag)
+            used_tags.add(commit_tag)
             release = {
                 "version": current_tag_name,
                 "date": current_tag_date,
@@ -127,24 +127,15 @@ def generate_tree_from_commits(
             current_tag_date = commit_tag.date
             changes = defaultdict(list)
 
-        matches = pat.match(commit.message)
-        if not matches:
+        if not pat.match(commit.message):
             continue
 
-        # Process subject from commit message
-        if message := map_pat.match(commit.message):
-            process_commit_message(
-                changelog_message_builder_hook,
-                message,
-                commit,
-                changes,
-                change_type_map,
-            )
-
-        # Process body from commit message
-        body_parts = commit.body.split("\n\n")
-        for body_part in body_parts:
-            if message := body_map_pat.match(body_part):
+        # Process subject and body from commit message
+        for message in chain(
+            [map_pat.match(commit.message)],
+            (body_map_pat.match(block) for block in commit.body.split("\n\n")),
+        ):
+            if message:
                 process_commit_message(
                     changelog_message_builder_hook,
                     message,

commitizen/cli.py

@@ -470,6 +470,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

@@ -22,6 +22,7 @@ class CheckArgs(TypedDict, total=False):
     message_length_limit: int | None
     allowed_prefixes: list[str]
     message: str
+    use_default_range: bool
 
 
 class Check:
@@ -41,7 +42,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", config.settings.get("message_length_limit", None)
         )
@@ -54,25 +55,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.
 
@@ -113,7 +117,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:
@@ -138,7 +145,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/commands/init.py

@@ -111,16 +111,6 @@ def is_npm_package(self) -> bool:
     def is_php_composer(self) -> bool:
         return os.path.isfile("composer.json")
 
-    @property
-    def latest_tag(self) -> str | None:
-        return get_latest_tag_name()
-
-    def tags(self) -> list | None:
-        """Not a property, only use if necessary"""
-        if self.latest_tag is None:
-            return None
-        return get_tag_names()
-
     @property
     def is_pre_commit_installed(self) -> bool:
         return bool(shutil.which("pre-commit"))
@@ -142,8 +132,8 @@ def __call__(self) -> None:
 
         out.info("Welcome to commitizen!\n")
         out.line(
-            "Answer the questions to configure your project.\n"
-            "For further configuration visit:\n"
+            "Answer the following questions to configure your project.\n"
+            "For further configuration, visit:\n"
             "\n"
             "https://commitizen-tools.github.io/commitizen/config/"
             "\n"
@@ -170,21 +160,6 @@ def __call__(self) -> None:
             self.config = JsonConfig(data="{}", path=config_path)
         elif "yaml" in config_path:
             self.config = YAMLConfig(data="", path=config_path)
-        values_to_add: dict[str, Any] = {}
-        values_to_add["name"] = cz_name
-        values_to_add["tag_format"] = tag_format
-        values_to_add["version_scheme"] = version_scheme
-
-        if version_provider == "commitizen":
-            values_to_add["version"] = version.public
-        else:
-            values_to_add["version_provider"] = version_provider
-
-        if update_changelog_on_bump:
-            values_to_add["update_changelog_on_bump"] = update_changelog_on_bump
-
-        if major_version_zero:
-            values_to_add["major_version_zero"] = major_version_zero
 
         # Collect hook data
         hook_types = questionary.checkbox(
@@ -202,7 +177,18 @@ def __call__(self) -> None:
 
         # Create and initialize config
         self.config.init_empty_config_content()
-        self._update_config_file(values_to_add)
+
+        self.config.set_key("name", cz_name)
+        self.config.set_key("tag_format", tag_format)
+        self.config.set_key("version_scheme", version_scheme)
+        if version_provider == "commitizen":
+            self.config.set_key("version", version.public)
+        else:
+            self.config.set_key("version_provider", version_provider)
+        if update_changelog_on_bump:
+            self.config.set_key("update_changelog_on_bump", update_changelog_on_bump)
+        if major_version_zero:
+            self.config.set_key("major_version_zero", major_version_zero)
 
         out.write("\nYou can bump the version running:\n")
         out.info("\tcz bump\n")
@@ -231,31 +217,32 @@ def _ask_name(self) -> str:
         return name
 
     def _ask_tag(self) -> str:
-        latest_tag = self.project_info.latest_tag
+        latest_tag = get_latest_tag_name()
         if not latest_tag:
             out.error("No Existing Tag. Set tag to v0.0.1")
             return "0.0.1"
 
-        is_correct_tag = questionary.confirm(
+        if questionary.confirm(
             f"Is {latest_tag} the latest tag?", style=self.cz.style, default=False
+        ).unsafe_ask():
+            return latest_tag
+
+        existing_tags = get_tag_names()
+        if not existing_tags:
+            out.error("No Existing Tag. Set tag to v0.0.1")
+            return "0.0.1"
+
+        answer: str = questionary.select(
+            "Please choose the latest tag: ",
+            # The latest tag is most likely with the largest number.
+            # Thus, listing the existing_tags in reverse order makes more sense.
+            choices=sorted(existing_tags, reverse=True),
+            style=self.cz.style,
         ).unsafe_ask()
-        if not is_correct_tag:
-            tags = self.project_info.tags()
-            if not tags:
-                out.error("No Existing Tag. Set tag to v0.0.1")
-                return "0.0.1"
-
-            # the latest tag is most likely with the largest number. Thus list the tags in reverse order makes more sense
-            sorted_tags = sorted(tags, reverse=True)
-            latest_tag = questionary.select(
-                "Please choose the latest tag: ",
-                choices=sorted_tags,
-                style=self.cz.style,
-            ).unsafe_ask()
-
-            if not latest_tag:
-                raise NoAnswersError("Tag is required!")
-        return latest_tag
+
+        if not answer:
+            raise NoAnswersError("Tag is required!")
+        return answer
 
     def _ask_tag_format(self, latest_tag: str) -> str:
         if latest_tag.startswith("v"):
@@ -360,7 +347,7 @@ def _get_config_data(self) -> dict[str, Any]:
             "rev": f"v{__version__}",
             "hooks": [
                 {"id": "commitizen"},
-                {"id": "commitizen-branch", "stages": ["push"]},
+                {"id": "commitizen-branch", "stages": ["pre-push"]},
             ],
         }
 
@@ -396,7 +383,3 @@ def _install_pre_commit_hook(self, hook_types: list[str] | None = None) -> None:
             hook_types = ["commit-msg", "pre-push"]
         self._exec_install_pre_commit_hook(hook_types)
         out.write("commitizen pre-commit hook is now installed in your '.git'\n")
-
-    def _update_config_file(self, values: dict[str, Any]) -> None:
-        for key, value in values.items():
-            self.config.set_key(key, value)

commitizen/git.py

@@ -49,6 +49,9 @@ class GitObject:
     def __eq__(self, other: object) -> bool:
         return hasattr(other, "rev") and self.rev == other.rev
 
+    def __hash__(self) -> int:
+        return hash(self.rev)
+
 
 class GitCommit(GitObject):
     def __init__(
@@ -329,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()