commit-check 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

commit_check/config_merger.py

@@ -0,0 +1,220 @@
+"""Configuration merger that combines CLI args, env vars, TOML config, and defaults."""
+
+from __future__ import annotations
+import os
+import argparse
+from typing import Dict, Any, Optional, List, Callable, Tuple
+
+from commit_check.config import load_config as load_toml_config
+from commit_check import (
+    DEFAULT_COMMIT_TYPES,
+    DEFAULT_BRANCH_TYPES,
+    DEFAULT_BRANCH_NAMES,
+    DEFAULT_BOOLEAN_RULES,
+)
+
+
+def parse_bool(value: Any) -> bool:
+    """Parse a boolean value from string, int, or bool.
+
+    Accepts: true/false, yes/no, 1/0, t/f, y/n (case-insensitive)
+    """
+    if isinstance(value, bool):
+        return value
+    if isinstance(value, int):
+        return bool(value)
+    if isinstance(value, str):
+        normalized = value.lower().strip()
+        if normalized in ("true", "yes", "1", "t", "y"):
+            return True
+        if normalized in ("false", "no", "0", "f", "n"):
+            return False
+        raise ValueError(f"Cannot parse '{value}' as boolean")
+    raise TypeError(f"Cannot convert {type(value).__name__} to bool")
+
+
+def parse_list(value: Any) -> List[str]:
+    """Parse a list from comma-separated string or list."""
+    if isinstance(value, list):
+        return value
+    if isinstance(value, str):
+        # Split by comma and strip whitespace
+        return [item.strip() for item in value.split(",") if item.strip()]
+    raise TypeError(f"Cannot convert {type(value).__name__} to list")
+
+
+def parse_int(value: Any) -> int:
+    """Parse an integer value."""
+    if isinstance(value, int):
+        return value
+    if isinstance(value, str):
+        try:
+            return int(value.strip())
+        except ValueError:
+            raise ValueError(f"Cannot parse '{value}' as integer")
+    raise TypeError(f"Cannot convert {type(value).__name__} to int")
+
+
+def get_default_config() -> Dict[str, Any]:
+    """Get the default configuration with all options."""
+    return {
+        "commit": {
+            "conventional_commits": True,
+            "subject_capitalized": DEFAULT_BOOLEAN_RULES["subject_capitalized"],
+            "subject_imperative": DEFAULT_BOOLEAN_RULES["subject_imperative"],
+            "subject_max_length": 80,
+            "subject_min_length": 5,
+            "allow_commit_types": DEFAULT_COMMIT_TYPES.copy(),
+            "allow_merge_commits": DEFAULT_BOOLEAN_RULES["allow_merge_commits"],
+            "allow_revert_commits": DEFAULT_BOOLEAN_RULES["allow_revert_commits"],
+            "allow_empty_commits": DEFAULT_BOOLEAN_RULES["allow_empty_commits"],
+            "allow_fixup_commits": DEFAULT_BOOLEAN_RULES["allow_fixup_commits"],
+            "allow_wip_commits": DEFAULT_BOOLEAN_RULES["allow_wip_commits"],
+            "require_body": DEFAULT_BOOLEAN_RULES["require_body"],
+            "require_signed_off_by": DEFAULT_BOOLEAN_RULES["require_signed_off_by"],
+            "ignore_authors": [],
+        },
+        "branch": {
+            "conventional_branch": True,
+            "allow_branch_types": DEFAULT_BRANCH_TYPES.copy(),
+            "allow_branch_names": DEFAULT_BRANCH_NAMES.copy(),
+            "require_rebase_target": "",
+            "ignore_authors": [],
+        },
+    }
+
+
+def deep_merge(base: Dict[str, Any], override: Dict[str, Any]) -> None:
+    """Deep merge override into base dictionary (modifies base in-place)."""
+    for key, value in override.items():
+        if key in base and isinstance(base[key], dict) and isinstance(value, dict):
+            deep_merge(base[key], value)
+        else:
+            base[key] = value
+
+
+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]]] = {
+        # Commit section
+        "CCHK_CONVENTIONAL_COMMITS": ("commit", "conventional_commits", parse_bool),
+        "CCHK_SUBJECT_CAPITALIZED": ("commit", "subject_capitalized", parse_bool),
+        "CCHK_SUBJECT_IMPERATIVE": ("commit", "subject_imperative", parse_bool),
+        "CCHK_SUBJECT_MAX_LENGTH": ("commit", "subject_max_length", parse_int),
+        "CCHK_SUBJECT_MIN_LENGTH": ("commit", "subject_min_length", parse_int),
+        "CCHK_ALLOW_COMMIT_TYPES": ("commit", "allow_commit_types", parse_list),
+        "CCHK_ALLOW_MERGE_COMMITS": ("commit", "allow_merge_commits", parse_bool),
+        "CCHK_ALLOW_REVERT_COMMITS": ("commit", "allow_revert_commits", parse_bool),
+        "CCHK_ALLOW_EMPTY_COMMITS": ("commit", "allow_empty_commits", parse_bool),
+        "CCHK_ALLOW_FIXUP_COMMITS": ("commit", "allow_fixup_commits", parse_bool),
+        "CCHK_ALLOW_WIP_COMMITS": ("commit", "allow_wip_commits", parse_bool),
+        "CCHK_REQUIRE_BODY": ("commit", "require_body", parse_bool),
+        "CCHK_REQUIRE_SIGNED_OFF_BY": ("commit", "require_signed_off_by", parse_bool),
+        "CCHK_IGNORE_AUTHORS": ("commit", "ignore_authors", parse_list),
+        # Branch section
+        "CCHK_CONVENTIONAL_BRANCH": ("branch", "conventional_branch", parse_bool),
+        "CCHK_ALLOW_BRANCH_TYPES": ("branch", "allow_branch_types", parse_list),
+        "CCHK_ALLOW_BRANCH_NAMES": ("branch", "allow_branch_names", parse_list),
+        "CCHK_REQUIRE_REBASE_TARGET": ("branch", "require_rebase_target", str),
+        "CCHK_BRANCH_IGNORE_AUTHORS": ("branch", "ignore_authors", parse_list),
+    }
+
+    # Mapping of CLI argument names to config keys
+    CLI_ARG_MAPPING: Dict[str, Tuple[str, str]] = {
+        # Commit section
+        "conventional_commits": ("commit", "conventional_commits"),
+        "subject_capitalized": ("commit", "subject_capitalized"),
+        "subject_imperative": ("commit", "subject_imperative"),
+        "subject_max_length": ("commit", "subject_max_length"),
+        "subject_min_length": ("commit", "subject_min_length"),
+        "allow_commit_types": ("commit", "allow_commit_types"),
+        "allow_merge_commits": ("commit", "allow_merge_commits"),
+        "allow_revert_commits": ("commit", "allow_revert_commits"),
+        "allow_empty_commits": ("commit", "allow_empty_commits"),
+        "allow_fixup_commits": ("commit", "allow_fixup_commits"),
+        "allow_wip_commits": ("commit", "allow_wip_commits"),
+        "require_body": ("commit", "require_body"),
+        "require_signed_off_by": ("commit", "require_signed_off_by"),
+        "ignore_authors": ("commit", "ignore_authors"),
+        # Branch section
+        "conventional_branch": ("branch", "conventional_branch"),
+        "allow_branch_types": ("branch", "allow_branch_types"),
+        "allow_branch_names": ("branch", "allow_branch_names"),
+        "require_rebase_target": ("branch", "require_rebase_target"),
+        "branch_ignore_authors": ("branch", "ignore_authors"),
+    }
+
+    @staticmethod
+    def parse_env_vars() -> Dict[str, Any]:
+        """Parse environment variables with CCHK_ prefix into config dict."""
+        config: Dict[str, Any] = {"commit": {}, "branch": {}}
+
+        for env_var, (section, key, parser) in ConfigMerger.ENV_VAR_MAPPING.items():
+            value = os.environ.get(env_var)
+            if value is not None:
+                try:
+                    parsed_value = parser(value)
+                    config[section][key] = parsed_value
+                except (ValueError, TypeError) as e:
+                    # Log warning but don't fail - just skip invalid env vars
+                    print(f"Warning: Invalid value for {env_var}: {e}")
+
+        # Remove empty sections
+        config = {k: v for k, v in config.items() if v}
+        return config
+
+    @staticmethod
+    def parse_cli_args(args: argparse.Namespace) -> Dict[str, Any]:
+        """Parse CLI arguments into config dict."""
+        config: Dict[str, Any] = {"commit": {}, "branch": {}}
+
+        for arg_name, (section, key) in ConfigMerger.CLI_ARG_MAPPING.items():
+            if hasattr(args, arg_name):
+                value = getattr(args, arg_name)
+                if value is not None:
+                    config[section][key] = value
+
+        # Remove empty sections
+        config = {k: v for k, v in config.items() if v}
+        return config
+
+    @staticmethod
+    def from_all_sources(
+        cli_args: argparse.Namespace, config_path: Optional[str] = None
+    ) -> Dict[str, Any]:
+        """Merge configs from all sources with priority: CLI > Env > TOML > Defaults.
+
+        Args:
+            cli_args: Parsed command line arguments
+            config_path: Optional path to TOML config file
+
+        Returns:
+            Merged configuration dictionary
+        """
+        # 1. Start with defaults
+        config = get_default_config()
+
+        # 2. Merge TOML config (if exists)
+        try:
+            toml_config = load_toml_config(config_path or "")
+            if toml_config:
+                deep_merge(config, toml_config)
+        except FileNotFoundError:
+            # If a specific path was provided and not found, this error is already raised
+            # If no path provided and no default files exist, that's fine
+            if config_path:
+                raise
+
+        # 3. Merge environment variables
+        env_config = ConfigMerger.parse_env_vars()
+        if env_config:
+            deep_merge(config, env_config)
+
+        # 4. Merge CLI arguments (highest priority)
+        cli_config = ConfigMerger.parse_cli_args(cli_args)
+        if cli_config:
+            deep_merge(config, cli_config)
+
+        return config

commit_check/imperatives.py

@@ -70,6 +70,8 @@ IMPERATIVES = {
     "encapsulate",
     "encode",
     "end",
+    "enforce",
+    "enhance",
     "ensure",
     "enumerate",
     "establish",

commit_check/main.py

@@ -5,7 +5,7 @@ import sys
 import argparse
 from typing import Optional
 
-from commit_check.config import load_config
+from commit_check.config_merger import ConfigMerger, parse_bool, parse_list, parse_int
 from commit_check.rule_builder import RuleBuilder
 from commit_check.engine import ValidationEngine, ValidationContext, ValidationResult
 from . import __version__
@@ -86,6 +86,160 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
+    # Commit configuration options
+    parser.add_argument(
+        "--conventional-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="enforce conventional commits format (true/false)",
+    )
+
+    parser.add_argument(
+        "--subject-capitalized",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="require subject to start with capital letter (true/false)",
+    )
+
+    parser.add_argument(
+        "--subject-imperative",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="require subject to use imperative mood (true/false)",
+    )
+
+    parser.add_argument(
+        "--subject-max-length",
+        type=parse_int,
+        default=None,
+        metavar="INT",
+        help="maximum length of commit subject",
+    )
+
+    parser.add_argument(
+        "--subject-min-length",
+        type=parse_int,
+        default=None,
+        metavar="INT",
+        help="minimum length of commit subject",
+    )
+
+    parser.add_argument(
+        "--allow-commit-types",
+        type=parse_list,
+        default=None,
+        metavar="LIST",
+        help="comma-separated list of allowed commit types (e.g., feat,fix,docs)",
+    )
+
+    parser.add_argument(
+        "--allow-merge-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="allow merge commits (true/false)",
+    )
+
+    parser.add_argument(
+        "--allow-revert-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="allow revert commits (true/false)",
+    )
+
+    parser.add_argument(
+        "--allow-empty-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="allow empty commit messages (true/false)",
+    )
+
+    parser.add_argument(
+        "--allow-fixup-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="allow fixup commits (true/false)",
+    )
+
+    parser.add_argument(
+        "--allow-wip-commits",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="allow WIP commits (true/false)",
+    )
+
+    parser.add_argument(
+        "--require-body",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="require commit body (true/false)",
+    )
+
+    parser.add_argument(
+        "--require-signed-off-by",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="require 'Signed-off-by' trailer (true/false)",
+    )
+
+    parser.add_argument(
+        "--ignore-authors",
+        type=parse_list,
+        default=None,
+        metavar="LIST",
+        help="comma-separated list of authors to ignore for commit checks",
+    )
+
+    # Branch configuration options
+    parser.add_argument(
+        "--conventional-branch",
+        type=parse_bool,
+        default=None,
+        metavar="BOOL",
+        help="enforce conventional branch naming (true/false)",
+    )
+
+    parser.add_argument(
+        "--allow-branch-types",
+        type=parse_list,
+        default=None,
+        metavar="LIST",
+        help="comma-separated list of allowed branch types (e.g., feature,bugfix,hotfix)",
+    )
+
+    parser.add_argument(
+        "--allow-branch-names",
+        type=parse_list,
+        default=None,
+        metavar="LIST",
+        help="comma-separated list of additional allowed branch names",
+    )
+
+    parser.add_argument(
+        "--require-rebase-target",
+        type=str,
+        default=None,
+        metavar="BRANCH",
+        help="target branch for rebase validation",
+    )
+
+    parser.add_argument(
+        "--branch-ignore-authors",
+        type=parse_list,
+        default=None,
+        metavar="LIST",
+        help="comma-separated list of authors to ignore for branch checks",
+    )
+
     return parser
 
 
@@ -135,8 +289,8 @@ def main() -> int:
     stdin_reader = StdinReader()
 
     try:
-        # Load configuration
-        config_data = load_config(args.config)
+        # Load and merge configuration from all sources: CLI > Env > TOML > Defaults
+        config_data = ConfigMerger.from_all_sources(args, args.config)
 
         # Build validation rules from config
         rule_builder = RuleBuilder(config_data)

{commit_check-2.3.0.dist-info → commit_check-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commit-check
-Version: 2.3.0
+Version: 2.4.0
 Summary: Check commit message formatting, branch naming, commit author, email, and more.
 Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -111,6 +111,12 @@ For more information, see the `docs <https://commit-check.github.io/commit-check
 Configuration
 -------------
 
+Commit Check can be configured in three ways (in order of priority):
+
+1. **Command-line arguments** — Override settings for specific runs
+2. **Environment variables** — Configure via ``CCHK_*`` environment variables
+3. **Configuration files** — Use ``cchk.toml`` or ``commit-check.toml``
+
 Use Default Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -118,11 +124,38 @@ Use Default Configuration
 
 - The default configuration is lenient — it only checks whether commit messages follow the `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/#summary>`_ specification and branch names follow the `Conventional Branch <https://conventional-branch.github.io/#summary>`_ convention.
 
-Use Custom Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~
+Use Custom Configuration File
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To customize the behavior, create a configuration file named ``cchk.toml`` or ``commit-check.toml`` in your repository's root directory or in the ``.github`` folder, e.g., `cchk.toml <https://github.com/commit-check/commit-check/blob/main/cchk.toml>`_ or ``.github/cchk.toml``.
 
+Use CLI Arguments or Environment Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For one-off checks or CI/CD pipelines, you can configure via CLI arguments or environment variables:
+
+.. code-block:: bash
+
+    # Using CLI arguments
+    commit-check --message --subject-imperative=true --subject-max-length=72
+
+    # Using environment variables
+    export CCHK_SUBJECT_IMPERATIVE=true
+    export CCHK_SUBJECT_MAX_LENGTH=72
+    commit-check --message
+
+    # In pre-commit hooks (.pre-commit-config.yaml)
+    repos:
+      - repo: https://github.com/commit-check/commit-check
+        rev: v2.3.0
+        hooks:
+          - id: commit-check
+            args:
+              - --subject-imperative=false
+              - --subject-max-length=100
+
+See the `Configuration documentation <https://commit-check.github.io/commit-check/configuration.html>`_ for all available options.
+
 Usage
 -----
 

commit_check-2.4.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
+commit_check/config.py,sha256=88zOLW6W2DHQjglxfSR3LQhCXgw-QcfEg118-OaWxIg,1031
+commit_check/config_merger.py,sha256=QwOLi3-pm-1w77aMiBeJzJLKoERDJlzH4IfTyNa421I,9427
+commit_check/engine.py,sha256=O9H39JgqrzWclfVTZYf-tJP8lAhHzGfV7j-CIxAsXWA,19348
+commit_check/imperatives.py,sha256=btNOK7HWYB3-Dc58OdgWnxW0YSHl4Q5oFEiN9jqsByM,3612
+commit_check/main.py,sha256=Hth6h2wrHFnrJro6TKL5AzkTORaUWp-p2xCjgq3v2-4,10977
+commit_check/rule_builder.py,sha256=0UqMQxDiPNgqEjmRTYnyHimCA7vZRZqgqdm7ughp3DY,9205
+commit_check/rules_catalog.py,sha256=FSRsdecwfUteEp3J8lnfehLu4j6owZlWfDzPa1ar1Fg,4288
+commit_check/util.py,sha256=4c9cxbBR3ZBSmYGNmzj87XWWr0zsCV8tmg1Z1yZ3iBI,8501
+commit_check-2.4.0.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
+commit_check-2.4.0.dist-info/METADATA,sha256=f18hat-Ayk0bgUFqQSx7yxS09RVvuTdATDeharpmG-k,10723
+commit_check-2.4.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+commit_check-2.4.0.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
+commit_check-2.4.0.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
+commit_check-2.4.0.dist-info/RECORD,,

commit_check-2.3.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
-commit_check/config.py,sha256=88zOLW6W2DHQjglxfSR3LQhCXgw-QcfEg118-OaWxIg,1031
-commit_check/engine.py,sha256=O9H39JgqrzWclfVTZYf-tJP8lAhHzGfV7j-CIxAsXWA,19348
-commit_check/imperatives.py,sha256=b_olcxhoHW2LMHaO9COVlVUdLE-7uifo9WeSY7rPql4,3582
-commit_check/main.py,sha256=SSQfN5p5AQoG0G_AFXA2wAoTcOJK8N8m8_gj8hkH-OI,7040
-commit_check/rule_builder.py,sha256=0UqMQxDiPNgqEjmRTYnyHimCA7vZRZqgqdm7ughp3DY,9205
-commit_check/rules_catalog.py,sha256=FSRsdecwfUteEp3J8lnfehLu4j6owZlWfDzPa1ar1Fg,4288
-commit_check/util.py,sha256=4c9cxbBR3ZBSmYGNmzj87XWWr0zsCV8tmg1Z1yZ3iBI,8501
-commit_check-2.3.0.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
-commit_check-2.3.0.dist-info/METADATA,sha256=TlR6GZ1noth7Nx-brsfWEs9bSur2rRiu4GaE5N2zle4,9540
-commit_check-2.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-commit_check-2.3.0.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
-commit_check-2.3.0.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
-commit_check-2.3.0.dist-info/RECORD,,