commit-check 2.18.2__py3-none-any.whl → 2.18.3__py3-none-any.whl

commit_check/__init__.py

@@ -8,7 +8,7 @@ Exports:
 
 import os
 import sys
-from importlib.metadata import version, PackageNotFoundError
+from importlib.metadata import PackageNotFoundError, version
 
 # Exit codes used across the package
 PASS = 0
@@ -40,9 +40,7 @@ def supports_color() -> bool:
         return False
     if not sys.stdout.isatty():
         return False
-    if os.environ.get("TERM") in ("", "dumb"):
-        return False
-    return True
+    return os.environ.get("TERM") not in ("", "dumb")
 
 
 # ANSI color codes used for CLI output, empty when stdout cannot render color.

commit_check/api.py

@@ -60,7 +60,6 @@ from commit_check.engine import (
 from commit_check.rule_builder import RuleBuilder
 from commit_check.rules_catalog import BRANCH_CHECKS, MESSAGE_CHECKS
 
-
 # ---------------------------------------------------------------------------
 # Internal helpers
 # ---------------------------------------------------------------------------

commit_check/config.py

@@ -1,13 +1,14 @@
 """TOML config loader and schema for commit-check."""
 
 from __future__ import annotations
-from typing import Any
-from pathlib import Path
+
 import copy
 import io
 import sys
-import urllib.request
 import urllib.error
+import urllib.request
+from pathlib import Path
+from typing import Any
 
 try:
     import tomllib
@@ -125,7 +126,7 @@ class _LazyOpener:
 
     @property
     def handlers(self) -> list[urllib.request.BaseHandler]:
-        return list(getattr(self._get(), "handlers"))
+        return list(self._get().handlers)  # type: ignore[attr-defined]
 
     def _get(self) -> urllib.request.OpenerDirector:
         if self._opener is None:
@@ -151,7 +152,7 @@ def _load_from_url(url: str) -> dict[str, Any]:
     """
     if not url.startswith("https://"):
         raise ValueError("only https:// URLs are accepted")
-    with _opener.open(url, timeout=10) as response:  # noqa: S310
+    with _opener.open(url, timeout=10) as response:
         data = response.read()
     return toml_load(io.BytesIO(data))
 

commit_check/config_merger.py

@@ -1,24 +1,27 @@
 """Configuration merger that combines CLI args, env vars, TOML config, and defaults."""
 
 from __future__ import annotations
+
+import argparse
+import difflib
 import os
 import sys
-import argparse
 from collections.abc import Callable
-from typing import Any
+from typing import Any, ClassVar
 
-from commit_check.config import deep_merge, load_config as load_toml_config
 from commit_check import (
-    DEFAULT_COMMIT_TYPES,
-    DEFAULT_BRANCH_TYPES,
-    DEFAULT_BRANCH_NAMES,
-    DEFAULT_BOOLEAN_RULES,
-    DEFAULT_PUSH_RULES,
     DEFAULT_AI_ATTRIBUTION,
     DEFAULT_AI_DISCLOSURE_PATTERN,
     DEFAULT_AI_DISCLOSURE_TRAILERS,
+    DEFAULT_BOOLEAN_RULES,
+    DEFAULT_BRANCH_NAMES,
+    DEFAULT_BRANCH_TYPES,
+    DEFAULT_COMMIT_TYPES,
+    DEFAULT_PUSH_RULES,
     DEFAULT_TAG_REGEX,
 )
+from commit_check.config import deep_merge
+from commit_check.config import load_config as load_toml_config
 
 
 def parse_bool(value: Any) -> bool:
@@ -108,11 +111,42 @@ def get_default_config() -> dict[str, Any]:
     }
 
 
+#: Read from the same file, but by other tools: ``warn`` by the rule builder,
+#: ``[jira]`` and ``[pull_request]`` by the GitHub App.
+_OTHER_KEYS = frozenset({"warn", "jira", "pull_request"})
+
+
+def unknown_setting_warnings(config: dict[str, Any]) -> list[str]:
+    """One line per setting in a config file that nothing reads.
+
+    A misspelt key used to be ignored in silence, leaving its rule off.
+    """
+    defaults = get_default_config()
+    names = []
+    for section, value in config.items():
+        if section in _OTHER_KEYS:
+            continue
+        if section not in defaults:
+            names.append((f"[{section}]", section, [*defaults, *_OTHER_KEYS]))
+        elif isinstance(value, dict):
+            names.extend(
+                (f"[{section}] {key}", key, defaults[section])
+                for key in value
+                if key not in defaults[section]
+            )
+    warnings = []
+    for shown, name, known in names:
+        match = difflib.get_close_matches(name, list(known), n=1)
+        hint = f"; did you mean {match[0]}?" if match else ""
+        warnings.append(f"⚠ unknown setting {shown} is ignored{hint}")
+    return warnings
+
+
 class ConfigMerger:
     """Merges configurations from multiple sources with priority: CLI > Env > TOML > Defaults."""
 
     # Mapping of environment variable names to config keys
-    ENV_VAR_MAPPING: dict[str, tuple[str, str, Callable[[Any], Any]]] = {
+    ENV_VAR_MAPPING: ClassVar[dict[str, tuple[str, str, Callable[[Any], Any]]]] = {
         # Commit section
         "CCHK_CONVENTIONAL_COMMITS": ("commit", "conventional_commits", parse_bool),
         "CCHK_MESSAGE_PATTERN": ("commit", "message_pattern", str),
@@ -155,7 +189,7 @@ class ConfigMerger:
     }
 
     # Mapping of CLI argument names to config keys
-    CLI_ARG_MAPPING: dict[str, tuple[str, str]] = {
+    CLI_ARG_MAPPING: ClassVar[dict[str, tuple[str, str]]] = {
         # Commit section
         "conventional_commits": ("commit", "conventional_commits"),
         "subject_capitalized": ("commit", "subject_capitalized"),
@@ -259,6 +293,8 @@ class ConfigMerger:
         try:
             toml_config = load_toml_config(config_path or "")
             if toml_config:
+                for warning in unknown_setting_warnings(toml_config):
+                    print(warning, file=sys.stderr)
                 deep_merge(config, toml_config)
         except FileNotFoundError:
             # If a specific path was provided and not found, this error is already raised

commit_check/engine.py

@@ -1,54 +1,54 @@
 """Clean validation engine following SOLID principles."""
 
 from __future__ import annotations
+
 import re
 import shlex
 import subprocess
 import sys
 from abc import ABC, abstractmethod
 from collections.abc import Iterable
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from enum import IntEnum
-from dataclasses import field
 from fnmatch import fnmatchcase
+from typing import ClassVar
 
-from commit_check import DEFAULT_AI_DISCLOSURE_TRAILERS
-from commit_check import ai_policy
-from commit_check.rule_builder import ValidationRule
+from commit_check import DEFAULT_AI_DISCLOSURE_TRAILERS, ai_policy
 from commit_check.ai_signatures import (
     detect_ai_signatures,
 )
+from commit_check.fixes import (
+    fix_branch_type,
+    fix_conventional_header,
+    fix_subject_case,
+    fix_wip,
+    signoff_trailer,
+    strip_lines_containing,
+)
+from commit_check.imperatives import IMPERATIVES, NON_IMPERATIVE_LOOKALIKES
+from commit_check.rule_builder import ValidationRule
 from commit_check.util import (
     _print_failure,
     fetch_remote_ref,
     fetch_upstream_ref,
+    format_size,
+    get_branch_name,
     get_commit_author_identity,
+    get_commit_files,
     get_commit_info,
-    get_git_user_identity,
     get_git_config_value,
-    get_branch_name,
-    get_commit_files,
-    get_push_commits,
     get_git_remotes,
+    get_git_user_identity,
+    get_push_commits,
     get_tags_at,
-    format_size,
     get_upstream_branch,
     get_upstream_remote_sha,
-    has_commits,
     git_merge_base,
     git_rev_parse_verify,
+    has_commits,
     print_error_header,
     rejection_headline,
 )
-from commit_check.imperatives import IMPERATIVES, NON_IMPERATIVE_LOOKALIKES
-from commit_check.fixes import (
-    fix_branch_type,
-    fix_conventional_header,
-    fix_subject_case,
-    fix_wip,
-    signoff_trailer,
-    strip_lines_containing,
-)
 
 
 class ValidationResult(IntEnum):
@@ -210,7 +210,6 @@ class BaseValidator(ABC):
     @abstractmethod
     def validate(self, context: ValidationContext) -> ValidationResult:
         """Perform validation and return result."""
-        pass
 
     @staticmethod
     def _resolve_current_author(context: ValidationContext) -> str:
@@ -314,7 +313,7 @@ class BaseValidator(ABC):
             try:
                 with open(context.commit_file, "r", encoding="utf-8") as f:
                     return f.read()
-            except (OSError, IOError):
+            except OSError:
                 pass
         if context.rev is not None:
             return get_commit_info("b", context.rev)
@@ -1097,7 +1096,9 @@ class BodyValidator(BaseValidator):
             return ValidationResult.PASS
 
         # Check if there's content after the first line (even if separated by empty lines)
-        if len(lines) > 1:
+        # Unreachable: the message is stripped, so two or more lines always
+        # hold two non-empty ones and have passed above.
+        if len(lines) > 1:  # pragma: no cover
             body_content = "\n".join(lines[1:]).strip()
             if body_content:
                 return ValidationResult.PASS
@@ -1324,9 +1325,8 @@ class CommitTypeValidator(BaseValidator):
         """Check if WIP commits are allowed."""
         upper_msg = message.upper()
         is_wip = (
-            upper_msg.startswith("WIP:")  # wip: / WIP:
-            or upper_msg.startswith("[WIP]")  # [wip] / [WIP]
-            or upper_msg.startswith("WIP ")  # WIP at start with space
+            # wip: / [wip] / "wip " at the start, in any case
+            upper_msg.startswith(("WIP:", "[WIP]", "WIP "))
             or upper_msg == "WIP"  # exact WIP
         )
         return not is_wip or self.rule.value
@@ -1510,7 +1510,7 @@ class AiAttributionValidator(BaseValidator):
 class ValidationEngine:
     """Main validation engine that orchestrates all validations."""
 
-    VALIDATOR_MAP: dict[str, type[BaseValidator]] = {
+    VALIDATOR_MAP: ClassVar[dict[str, type[BaseValidator]]] = {
         "message": CommitMessageValidator,
         "subject_capitalized": SubjectCapitalizationValidator,
         "subject_imperative": SubjectImperativeValidator,

commit_check/main.py

@@ -1,14 +1,23 @@
 """Modern commit-check CLI with clean architecture and TOML support."""
 
 from __future__ import annotations
+
+import argparse
 import json
 import os
 import select
 import sys
-import argparse
 
 from commit_check.config import ConfigError, find_config_path
-from commit_check.config_merger import ConfigMerger, parse_bool, parse_list, parse_int
+from commit_check.config_merger import ConfigMerger, parse_bool, parse_int, parse_list
+from commit_check.engine import (
+    CheckOutcome,
+    ValidationContext,
+    ValidationEngine,
+    ValidationResult,
+    count_warnings,
+    overall_status,
+)
 from commit_check.rule_builder import RuleBuilder
 from commit_check.rules_catalog import BRANCH_CHECKS, FILES_CHECKS, MESSAGE_CHECKS
 from commit_check.util import (
@@ -16,14 +25,7 @@ from commit_check.util import (
     git_rev_parse_verify,
     print_error_header,
 )
-from commit_check.engine import (
-    ValidationEngine,
-    ValidationContext,
-    ValidationResult,
-    CheckOutcome,
-    count_warnings,
-    overall_status,
-)
+
 from . import AI_ATTRIBUTION_POLICIES, __version__
 
 # Exit codes. ``1`` is a verdict on the commit; ``2`` means the run could not
@@ -71,7 +73,7 @@ class StdinReader:
             if not sys.stdin.isatty() and cls._has_pending_data(timeout=0.1):
                 data = sys.stdin.read()
                 return data.strip() if data else None
-        except (OSError, IOError):
+        except OSError:
             return None
         return None
 
@@ -232,6 +234,14 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
+    parser.add_argument(
+        "--fix",
+        help="rewrite the commit message file when every failed message check "
+        "has a mechanical fix, such as a type's case or a missing colon",
+        action="store_true",
+        required=False,
+    )
+
     check_group.add_argument(
         "--no-force-push",
         help="check that no force push is being performed (uses pre-push hook stdin when available, otherwise checks the current branch against its upstream)",
@@ -520,6 +530,41 @@ def _get_parser() -> argparse.ArgumentParser:
     return parser
 
 
+def _fix_message_file(path: str, rules: list, config: dict) -> None:
+    """Rewrite a commit message file when every failure in it has a fix.
+
+    A subject rule's fix is the corrected subject; every other rule's fix is
+    the corrected message. Fixes go in one at a time, re-checking after
+    each, and a failure no fix can reach leaves the file as it was.
+    """
+    with open(path, encoding="utf-8") as f:
+        original = f.read()
+    message = original.strip()
+    engine = ValidationEngine([r for r in rules if r.check in MESSAGE_CHECKS])
+    fixed = []
+    for _ in range(len(engine.rules) + 1):
+        context = ValidationContext(
+            stdin_text=message, stdin_is_message=True, config=config
+        )
+        outcomes = engine.validate_all_detailed(context)
+        failed = [o for o in outcomes if o.status == "fail"]
+        fixable = [o for o in failed if o.fix]
+        if not fixable:
+            break
+        first = fixable[0]
+        subject = message.split("\n", 1)[0]
+        if first.value == subject:
+            message = first.fix + message[len(subject) :]
+        else:
+            message = first.fix
+        fixed.append(f"{first.rule_id} {first.check.replace('_', '-')}")
+    if failed or not fixed:
+        return
+    with open(path, "w", encoding="utf-8") as f:
+        f.write(original.replace(original.strip(), message, 1))
+    print(f"✎ fixed the commit message: {', '.join(fixed)}", file=sys.stderr)
+
+
 def _resolve_commit_message_source(
     args: argparse.Namespace,
     stdin_reader: StdinReader,
@@ -600,8 +645,10 @@ _UNCONFIGURED_HINTS = (
     (
         "branch",
         ("branch", "merge_base"),
-        "--branch requested but no branch rules are configured "
-        "(conventional_branch = false and no require_rebase_target)",
+        (
+            "--branch requested but no branch rules are configured "
+            "(conventional_branch = false and no require_rebase_target)"
+        ),
     ),
 )
 
@@ -714,6 +761,11 @@ def main() -> int:
         # Next to --message, piped stdin is the message; other checks read git.
         stdin_is_message = args.message and stdin_content is not None
 
+        if args.fix and not commit_file_path:
+            parser.error("--fix rewrites a commit message file; pass one")
+        if args.fix and commit_file_path and not args.dry_run:
+            _fix_message_file(commit_file_path, filtered_rules, config_data)
+
         # Reset banner state for this run
         print_error_header.has_been_called = False
 
@@ -753,7 +805,7 @@ def main() -> int:
         # Nothing was validated, so this is not a verdict on the commit.
         print(f"Error: {e}", file=sys.stderr)
         return EXIT_CONFIG_ERROR
-    except Exception as e:
+    except Exception as e:  # noqa: BLE001 - last resort: report it, no traceback
         print(f"Error: {e}", file=sys.stderr)
         return EXIT_FAIL
 

commit_check/rule_builder.py

@@ -1,34 +1,35 @@
 """Rule builder that creates validation rules from config and catalog."""
 
 from __future__ import annotations
+
 import re
 import sys
-from typing import Any
 from dataclasses import dataclass, replace
-from commit_check.config import ConfigError
-from commit_check.util import format_size, parse_size
-from commit_check.rules_catalog import (
-    COMMIT_RULES,
-    BRANCH_RULES,
-    PUSH_RULES,
-    FILES_RULES,
-    TAG_RULES,
-    RULES_BY_CHECK,
-    RuleCatalogEntry,
-)
+from typing import Any
+
 from commit_check import (
     AI_ATTRIBUTION_POLICIES,
-    DEFAULT_COMMIT_TYPES,
-    DEFAULT_BRANCH_TYPES,
-    DEFAULT_BRANCH_NAMES,
-    DEFAULT_BOOLEAN_RULES,
-    DEFAULT_PUSH_RULES,
     DEFAULT_AI_ATTRIBUTION,
     DEFAULT_AI_DISCLOSURE_PATTERN,
     DEFAULT_AI_DISCLOSURE_TRAILERS,
+    DEFAULT_BOOLEAN_RULES,
+    DEFAULT_BRANCH_NAMES,
+    DEFAULT_BRANCH_TYPES,
+    DEFAULT_COMMIT_TYPES,
+    DEFAULT_PUSH_RULES,
     DEFAULT_TAG_REGEX,
 )
-
+from commit_check.config import ConfigError
+from commit_check.rules_catalog import (
+    BRANCH_RULES,
+    COMMIT_RULES,
+    FILES_RULES,
+    PUSH_RULES,
+    RULES_BY_CHECK,
+    TAG_RULES,
+    RuleCatalogEntry,
+)
+from commit_check.util import format_size, parse_size
 
 #: The checks each ``ai_attribution`` policy builds. ``forbid`` rejects every
 #: AI signature under one rule; ``disclose`` asks for three things, one rule
@@ -732,7 +733,7 @@ class RuleBuilder:
         # config allows "create-pull-request/.+" that way. Every alternative
         # is anchored at both ends so a name has to match the whole branch
         # name, not merely its start ("main-backup" is not "main").
-        names_pattern = "|".join(["master", "main", "HEAD", r"PR-.+"])
+        names_pattern = "master|main|HEAD|PR-.+"
         if allowed_names:
             names_pattern += "|" + "|".join(allowed_names)
         return rf"^(?:{types_pattern})/.+$|^(?:{names_pattern})$"

commit_check/rules_catalog.py

@@ -19,6 +19,7 @@ Internal bookkeeping entries that never produce a diagnostic (such as
 """
 
 from __future__ import annotations
+
 from dataclasses import dataclass
 
 #: Base URL of the rules reference documentation.

commit_check/util.py

@@ -6,12 +6,14 @@ A module containing utility functions.
 """
 
 from __future__ import annotations
+
 import os
 import subprocess
 import sys
-from subprocess import CalledProcessError
-from commit_check import RED, GREEN, YELLOW, RESET_COLOR
 from collections.abc import Iterable
+from subprocess import CalledProcessError
+
+from commit_check import GREEN, RED, RESET_COLOR, YELLOW
 from commit_check.rules_catalog import display_name
 
 
@@ -63,6 +65,50 @@ def _print_failure(
     print()
 
 
+# Where CI systems name the branch under test. Their checkouts are usually a
+# detached HEAD, where git has no branch to report. Tried in order: within
+# one system, a pull or merge request's source branch comes first, because
+# the plain branch variable of such a build names something else.
+_CI_BRANCH_VARIABLES = (
+    "GITHUB_HEAD_REF",  # GitHub Actions, pull request
+    "GITHUB_REF_NAME",  # GitHub Actions, push
+    "CI_MERGE_REQUEST_SOURCE_BRANCH_NAME",  # GitLab CI, merge request pipeline
+    "CI_COMMIT_BRANCH",  # GitLab CI, branch pipeline
+    "BITBUCKET_BRANCH",  # Bitbucket Pipelines
+    "SYSTEM_PULLREQUEST_SOURCEBRANCH",  # Azure Pipelines, pull request
+    "BUILD_SOURCEBRANCH",  # Azure Pipelines, branch build
+)
+
+# Jenkins multibranch names are generic enough to be set by hand elsewhere,
+# so they are read only inside a Jenkins build, and not in a tag build, where
+# BRANCH_NAME is the tag (TAG_NAME is set too).
+_JENKINS_BRANCH_VARIABLES = (
+    "CHANGE_BRANCH",  # pull request source branch
+    "BRANCH_NAME",  # branch build; "PR-24" on a pull request
+)
+
+
+def _ci_branch_name() -> str:
+    """The branch a CI system says it is building, or ``""``.
+
+    Azure Pipelines gives full refs (``refs/heads/feature/tools``); the branch
+    is what follows ``refs/heads/``. Any other ref — a tag, a pull request's
+    merge ref — names no branch and is passed over.
+    """
+    names: tuple[str, ...] = _CI_BRANCH_VARIABLES
+    if os.getenv("JENKINS_URL") and not os.getenv("TAG_NAME"):
+        names += _JENKINS_BRANCH_VARIABLES
+    for name in names:
+        value = (os.getenv(name) or "").strip()
+        if value.startswith("refs/heads/"):
+            value = value.removeprefix("refs/heads/")
+        elif value.startswith("refs/"):
+            continue
+        if value:
+            return value
+    return ""
+
+
 def get_branch_name() -> str:
     """Identify current branch name.
     .. note::
@@ -70,6 +116,11 @@ def get_branch_name() -> str:
         Please open an issue at https://github.com/commit-check/commit-check/issues
         if you encounter any issue.
 
+    On a detached HEAD — the usual CI checkout — git reports no branch, so
+    the name comes from the CI system's environment (GitHub Actions, GitLab
+    CI, Bitbucket Pipelines, Azure Pipelines, Jenkins), and is ``HEAD``
+    when none names one.
+
     :returns: A `str` describing the current branch name.
     """
     try:
@@ -80,10 +131,7 @@ def get_branch_name() -> str:
         branch_name = ""
 
     if not branch_name:
-        # Fallback to environment variables (GitHub Actions)
-        branch_name = (
-            os.getenv("GITHUB_HEAD_REF") or os.getenv("GITHUB_REF_NAME") or "HEAD"
-        )
+        branch_name = _ci_branch_name() or "HEAD"
     return branch_name.strip()
 
 
@@ -102,8 +150,8 @@ def get_tags_at(rev: str = "HEAD") -> list[str]:
     # and a git diagnostic must not be parsed as a tag name.
     result = subprocess.run(
         ["git", "tag", "--points-at", rev],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     output = result.stdout if result.returncode == 0 else ""
@@ -250,8 +298,8 @@ def get_commit_files(rev: str = "HEAD") -> list[tuple[str, int]]:
     # one, in a single call that also rejects an unresolvable revision.
     lineage = subprocess.run(
         ["git", "rev-list", "--parents", "-n", "1", rev],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if lineage.returncode != 0:
@@ -272,8 +320,8 @@ def get_commit_files(rev: str = "HEAD") -> list[tuple[str, int]]:
             "-z",
             *scope,
         ],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if diff.returncode != 0:
@@ -287,8 +335,8 @@ def get_commit_files(rev: str = "HEAD") -> list[tuple[str, int]]:
         try:
             tree = subprocess.run(
                 ["git", "ls-tree", "-r", "-l", "-z", "--full-tree", rev, "--", *batch],
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
+                capture_output=True,
+                check=False,
                 encoding="utf-8",
             )
         except OSError:
@@ -324,8 +372,8 @@ def get_push_commits(local_sha: str, remote_sha: str) -> list[str]:
         args = [f"{remote_sha}..{local_sha}"]
     result = subprocess.run(
         ["git", "rev-list", *args],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if result.returncode != 0:
@@ -343,8 +391,8 @@ def get_upstream_branch() -> str:
     """
     result = subprocess.run(
         ["git", "rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{upstream}"],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if result.returncode == 0 and result.stdout:
@@ -378,8 +426,8 @@ def get_remote_branch_sha(remote_name: str, branch_name: str) -> str:
 
     result = subprocess.run(
         ["git", "ls-remote", "--exit-code", remote_name, f"refs/heads/{branch_name}"],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if result.returncode != 0 or not result.stdout:
@@ -401,8 +449,8 @@ def fetch_upstream_ref(upstream_ref: str) -> bool:
     remote_name, branch_name = parts
     result = subprocess.run(
         ["git", "fetch", "--quiet", "--no-tags", remote_name, branch_name],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     return result.returncode == 0
@@ -412,8 +460,8 @@ def get_git_remotes() -> list[str]:
     """Return configured git remote names."""
     result = subprocess.run(
         ["git", "remote"],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     if result.returncode != 0 or not result.stdout:
@@ -433,8 +481,8 @@ def fetch_remote_ref(remote_name: str, remote_ref: str) -> bool:
 
     result = subprocess.run(
         ["git", "fetch", "--quiet", "--no-tags", remote_name, remote_ref],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
+        check=False,
         encoding="utf-8",
     )
     return result.returncode == 0
@@ -551,7 +599,7 @@ def git_merge_base(target_branch: str, current_branch: str) -> int:
             f"{current_branch}",
         ]
         result = subprocess.run(
-            commands, stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding="utf-8"
+            commands, capture_output=True, check=False, encoding="utf-8"
         )
         return result.returncode
     except CalledProcessError:
@@ -565,7 +613,7 @@ def cmd_output(commands: list) -> str:
     :returns: Get `str` output.
     """
     result = subprocess.run(
-        commands, stdout=subprocess.PIPE, stderr=subprocess.PIPE, encoding="utf-8"
+        commands, capture_output=True, check=False, encoding="utf-8"
     )
     if result.returncode == 0 and result.stdout is not None:
         return result.stdout

{commit_check-2.18.2.dist-info → commit_check-2.18.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commit-check
-Version: 2.18.2
+Version: 2.18.3
 Summary: Check commit message formatting, branch naming, commit author, email, and more.
 Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -83,12 +83,14 @@ Stop bad commits before they exist. In `.pre-commit-config.yaml`:
 ```yaml
 repos:
   - repo: https://github.com/commit-check/commit-check
-    rev: v2.18.1
+    rev: v2.18.2
     hooks:
       - id: check-message
       - id: check-branch
 ```
 
+Add `args: [--fix]` to `check-message` and the hook corrects mechanical slips
+itself — a type's case, a missing colon — instead of rejecting the commit.
 The hooks for the other checks (`check-author-name`, `check-author-email`,
 `check-no-force-push`, `check-tag`, `check-files`) are listed in the
 [pre-commit guide](https://commit-check.com/guides/pre-commit/).

commit_check-2.18.3.dist-info/RECORD

@@ -0,0 +1,21 @@
+commit_check/__init__.py,sha256=QTpfP0b6G9TNS4McgunE6Oozwt3CkUaN4xkqEaR4570,4390
+commit_check/ai_policy.py,sha256=gYC3ROLgGL1TDyhPkFXkV-NiYbvMt80Qt0MFrJcbJY4,8131
+commit_check/ai_signatures.py,sha256=XTfHh8zD2EbHjuCBBbukQllTJWqO7EoehVc7bADMwQY,9437
+commit_check/ai_signatures_data.py,sha256=33uiiAieL1wB6isgU-dgkz10IrQub7lVCGh8hf7XiN8,11213
+commit_check/api.py,sha256=kzFlSvY7maIdyugFNcQo_2eKyQ-9mca1imFs_F7_LOo,12817
+commit_check/config.py,sha256=Cy7DMWKrWbmVmYER1lUlpvFf9eHn5SfVUVWZ4zgit2w,9820
+commit_check/config_merger.py,sha256=1KYqwNEzJ_fFSPOd45VGGHDNTKIRsShwVSIT3-gGLFw,13128
+commit_check/engine.py,sha256=dQ8I5jh4qP7j6jd4n5HjyOFUOJFyLcmLscQZtwzNkKo,68694
+commit_check/fixes.py,sha256=AsE9ChMXoOCV61pgxbZZNkAzmQS9_ARTWvvox4HkgEg,7088
+commit_check/imperatives.py,sha256=dEd_ssu4G0j6Cann6jqPdB97lw5Adua43K0_Odg_FyA,9518
+commit_check/main.py,sha256=8tVrtcPBMxGhPsuE_sFwOjbmt0NeWU-J83s1ji4IfQY,26925
+commit_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+commit_check/rule_builder.py,sha256=9uoEXyc-PpfxQujv0s444Ow0mliPDvqRZi2YFzacHWI,29570
+commit_check/rules_catalog.py,sha256=JspIhkGXUviLkMG4HhH_IK2x5YTfX3t1p9gI7PbFD7Q,11558
+commit_check/util.py,sha256=XKSiheSa1Ia5lmPotM_Yz8k5T4TGgFLxf_ipXLmXAto,27550
+commit_check-2.18.3.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
+commit_check-2.18.3.dist-info/METADATA,sha256=5tAjqdFPqQNMYQo5SB3mnrQZ7bBvMjXv6T1X2P-Dprc,15234
+commit_check-2.18.3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+commit_check-2.18.3.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
+commit_check-2.18.3.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
+commit_check-2.18.3.dist-info/RECORD,,

commit_check-2.18.2.dist-info/RECORD

@@ -1,21 +0,0 @@
-commit_check/__init__.py,sha256=--TSQBRscNxJtSNl74Mm6OGxjX0SDh_Gqicuu2AoEYU,4420
-commit_check/ai_policy.py,sha256=gYC3ROLgGL1TDyhPkFXkV-NiYbvMt80Qt0MFrJcbJY4,8131
-commit_check/ai_signatures.py,sha256=XTfHh8zD2EbHjuCBBbukQllTJWqO7EoehVc7bADMwQY,9437
-commit_check/ai_signatures_data.py,sha256=33uiiAieL1wB6isgU-dgkz10IrQub7lVCGh8hf7XiN8,11213
-commit_check/api.py,sha256=RlLGWfpEu9iW-7zIWJ7xDHTYHdH7w4a-0AE7yJH6jU0,12818
-commit_check/config.py,sha256=3KAoCU3sREyT0llePdKE6YrM79tmGka3a2j8LqF27WA,9815
-commit_check/config_merger.py,sha256=k3heMtKEMCSca-LtAntfyvNdPaB18iusfPjt_BOe6j8,11758
-commit_check/engine.py,sha256=vjMcrKpjQR9e_HZoHYkmCUJqcmOw8iOckxpCBqUUvXk,68640
-commit_check/fixes.py,sha256=AsE9ChMXoOCV61pgxbZZNkAzmQS9_ARTWvvox4HkgEg,7088
-commit_check/imperatives.py,sha256=dEd_ssu4G0j6Cann6jqPdB97lw5Adua43K0_Odg_FyA,9518
-commit_check/main.py,sha256=dyvEHptwOdGZA01E3nxbNwNmUvxfgT-vIgfXzvLtqBM,24881
-commit_check/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-commit_check/rule_builder.py,sha256=f42vN3X_hYU47YgJ0xCniwKW9CwlDwt-4Q_WC7_Y-6E,29591
-commit_check/rules_catalog.py,sha256=Sa4jsyxWJ8g6fX2qJTdIMnd6513in5GmSxHYL5nTwws,11557
-commit_check/util.py,sha256=o0PuiiRhSgIVBmBF_20VytiHj74VlKb3nCMJ8KxB2Ds,25749
-commit_check-2.18.2.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
-commit_check-2.18.2.dist-info/METADATA,sha256=9LtV66iFvvvt72VtMZo07FUtJCB78s5hBUfqRt-YsNU,15077
-commit_check-2.18.2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-commit_check-2.18.2.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
-commit_check-2.18.2.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
-commit_check-2.18.2.dist-info/RECORD,,