git-commit-guard 0.8.0__tar.gz → 0.9.0__tar.gz

git_commit_guard-0.9.0/.github/workflows/lint-python.yml

@@ -0,0 +1,24 @@
+---
+name: Lint Python
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  lint-python:
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+      pull-requests: write
+    steps:
+      - name: Checkout code
+        # yamllint disable-line rule:line-length
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+      - name: Run ruff
+        # yamllint disable-line rule:line-length
+        uses: benner/action-ruff@b36eb590165f0ea36700bb92de15235c121f24f0  # v0.1.0
+        with:
+          fail_level: error
+          reporter: github-pr-review

{git_commit_guard-0.8.0 → git_commit_guard-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.8.0
+Version: 0.9.0
 Summary: Opinionated conventional commit message linter with imperative mood detection
 Project-URL: Homepage, https://github.com/benner/commit-guard
 Project-URL: Repository, https://github.com/benner/commit-guard
@@ -101,6 +101,28 @@ Available checks:
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
 
+### Subject length
+
+The default maximum subject line length is 72 characters. Override with
+`--max-subject-length`:
+
+```bash
+commit-guard --max-subject-length 100
+```
+
+### Type validation
+
+By default the standard conventional commit types are accepted. Use `--types`
+to replace the allowed set entirely:
+
+```bash
+# restrict to a subset
+commit-guard --types feat,fix,chore
+
+# add a project-specific type
+commit-guard --types feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert,wip
+```
+
 ### Scope validation
 
 By default any scope is accepted and scope is optional. Use `--scopes` to
@@ -121,15 +143,17 @@ commit-guard --scopes auth,api --require-scope
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
-set defaults for `enable`, `disable`, `scopes`, and `require-scope`.
-commit-guard searches upward from the working directory and uses the first file
-found.
+set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`, and
+`max-subject-length`. commit-guard searches upward from the working directory
+and uses the first file found.
 
 ```toml
 # .commit-guard.toml
 disable = ["signature", "body"]
 scopes = ["auth", "api", "db"]
 require-scope = true
+types = ["feat", "fix", "chore", "wip"]
+max-subject-length = 100
 ```
 
 ```toml
@@ -137,8 +161,9 @@ require-scope = true
 enable = ["subject", "imperative"]
 ```
 
-CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`) take full
-precedence and ignore config file values when provided.
+CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
+`--max-subject-length`) take full precedence and ignore config file values when
+provided.
 
 ### Checking a range of commits
 
@@ -206,8 +231,9 @@ body
 trailers
 ```
 
-Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`,
-`build`, `ci`, `chore`, `revert`.
+Default types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`,
+`build`, `ci`, `chore`, `revert`. Override with `--types` or the `types` config
+key.
 
 Scope is optional. Mark breaking changes with `!` before
 the colon.

{git_commit_guard-0.8.0 → git_commit_guard-0.9.0}/README.md

@@ -80,6 +80,28 @@ Available checks:
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
 
+### Subject length
+
+The default maximum subject line length is 72 characters. Override with
+`--max-subject-length`:
+
+```bash
+commit-guard --max-subject-length 100
+```
+
+### Type validation
+
+By default the standard conventional commit types are accepted. Use `--types`
+to replace the allowed set entirely:
+
+```bash
+# restrict to a subset
+commit-guard --types feat,fix,chore
+
+# add a project-specific type
+commit-guard --types feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert,wip
+```
+
 ### Scope validation
 
 By default any scope is accepted and scope is optional. Use `--scopes` to
@@ -100,15 +122,17 @@ commit-guard --scopes auth,api --require-scope
 ### Configuration file
 
 Place `.commit-guard.toml` in your project root (or any parent directory) to
-set defaults for `enable`, `disable`, `scopes`, and `require-scope`.
-commit-guard searches upward from the working directory and uses the first file
-found.
+set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`, and
+`max-subject-length`. commit-guard searches upward from the working directory
+and uses the first file found.
 
 ```toml
 # .commit-guard.toml
 disable = ["signature", "body"]
 scopes = ["auth", "api", "db"]
 require-scope = true
+types = ["feat", "fix", "chore", "wip"]
+max-subject-length = 100
 ```
 
 ```toml
@@ -116,8 +140,9 @@ require-scope = true
 enable = ["subject", "imperative"]
 ```
 
-CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`) take full
-precedence and ignore config file values when provided.
+CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
+`--max-subject-length`) take full precedence and ignore config file values when
+provided.
 
 ### Checking a range of commits
 
@@ -185,8 +210,9 @@ body
 trailers
 ```
 
-Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`,
-`build`, `ci`, `chore`, `revert`.
+Default types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`,
+`build`, `ci`, `chore`, `revert`. Override with `--types` or the `types` config
+key.
 
 Scope is optional. Mark breaking changes with `!` before
 the colon.

git_commit_guard-0.9.0/ruff.toml

@@ -0,0 +1,13 @@
+target-version = "py312"
+
+[lint]
+select = ["ALL"]
+ignore = [
+  "ANN",    # flake8-annotations (ANN)
+  "COM812", # missing-trailing-comma
+  "D",      # pydocstyle (D)
+  "RET504", # Unnecessary assignment to X before `return` statement
+]
+
+[lint.per-file-ignores]
+"tests/**" = ["S101"]  # assert is expected in tests

{git_commit_guard-0.8.0 → git_commit_guard-0.9.0}/src/git_commit_guard/__init__.py

@@ -1,13 +1,13 @@
 import re
 import subprocess
 import sys
+import tomllib
 from argparse import ArgumentParser
 from dataclasses import dataclass, field
 from enum import StrEnum
 from pathlib import Path
 
 import nltk
-import tomllib
 from nltk.corpus import wordnet
 
 TYPES = frozenset(
@@ -120,13 +120,21 @@ def _strip_comments(message):
     )
 
 
-def check_subject(line, result, allowed_scopes=frozenset(), *, require_scope=False):
+def check_subject(  # noqa: PLR0913 Too many arguments in function definition (6 > 5)
+    line,
+    result,
+    allowed_scopes=frozenset(),
+    allowed_types=TYPES,
+    max_subject_length=MAX_SUBJECT_LEN,
+    *,
+    require_scope=False,
+):
     m = SUBJECT_RE.match(line)
     if not m:
         result.error(f"subject does not match 'type(scope): description': {line}")
         return None
 
-    if m.group("type") not in TYPES:
+    if m.group("type") not in allowed_types:
         result.error(f"unknown type: {m.group('type')}")
 
     scope = m.group("scope")
@@ -140,8 +148,8 @@ def check_subject(line, result, allowed_scopes=frozenset(), *, require_scope=Fal
         result.error("description must not start with uppercase")
     if desc.endswith("."):
         result.error("description must not end with period")
-    if len(line) > MAX_SUBJECT_LEN:
-        result.error(f"subject too long: {len(line)} > {MAX_SUBJECT_LEN}")
+    if len(line) > max_subject_length:
+        result.error(f"subject too long: {len(line)} > {max_subject_length}")
     return desc
 
 
@@ -223,6 +231,8 @@ class Args:
     enabled: frozenset
     allowed_scopes: frozenset
     require_scope: bool
+    allowed_types: frozenset
+    max_subject_length: int
 
 
 def _resolve_enabled(args, config, parser):
@@ -241,6 +251,22 @@ def _resolve_enabled(args, config, parser):
     return enabled
 
 
+def _resolve_max_subject_length(args, config):
+    if args.max_subject_length is not None:
+        return args.max_subject_length
+    if "max-subject-length" in config:
+        return config["max-subject-length"]
+    return MAX_SUBJECT_LEN
+
+
+def _resolve_types(args, config):
+    if args.types:
+        return frozenset(t.strip() for t in args.types.split(","))
+    if config.get("types"):
+        return frozenset(config["types"])
+    return TYPES
+
+
 def _resolve_scopes(args, config):
     if args.scopes:
         allowed_scopes = frozenset(s.strip() for s in args.scopes.split(","))
@@ -292,10 +318,24 @@ def _parse_args():
         default=False,
         help="require a scope in the subject line",
     )
+    parser.add_argument(
+        "--types",
+        metavar="TYPE[,TYPE,...]",
+        help="allowed commit types (replaces defaults when set)",
+    )
+    parser.add_argument(
+        "--max-subject-length",
+        type=int,
+        default=None,
+        metavar="N",
+        help=f"maximum subject line length (default: {MAX_SUBJECT_LEN})",
+    )
     args = parser.parse_args()
     config = _load_config()
     enabled = _resolve_enabled(args, config, parser)
     allowed_scopes, require_scope = _resolve_scopes(args, config)
+    allowed_types = _resolve_types(args, config)
+    max_subject_length = _resolve_max_subject_length(args, config)
 
     if args.message_file:
         rev = None
@@ -316,6 +356,8 @@ def _parse_args():
         enabled=enabled,
         allowed_scopes=allowed_scopes,
         require_scope=require_scope,
+        allowed_types=allowed_types,
+        max_subject_length=max_subject_length,
     )
 
 
@@ -341,7 +383,12 @@ def main():
     desc = None
     if Check.SUBJECT in args.enabled:
         desc = check_subject(
-            lines[0], result, args.allowed_scopes, require_scope=args.require_scope
+            lines[0],
+            result,
+            args.allowed_scopes,
+            args.allowed_types,
+            args.max_subject_length,
+            require_scope=args.require_scope,
         )
     if Check.IMPERATIVE in args.enabled:
         if desc is None:

{git_commit_guard-0.8.0 → git_commit_guard-0.9.0}/tests/test_git_commit_guard.py

@@ -1,9 +1,12 @@
 import subprocess
-from argparse import ArgumentParser
+from argparse import ArgumentParser, Namespace
 from unittest.mock import MagicMock, patch
 
 import pytest
+
 from git_commit_guard import (
+    MAX_SUBJECT_LEN,
+    TYPES,
     Result,
     _download_if_missing,
     _ensure_nltk_data,
@@ -12,6 +15,8 @@ from git_commit_guard import (
     _parse_checks,
     _parse_config_checks,
     _report,
+    _resolve_max_subject_length,
+    _resolve_types,
     _strip_comments,
     check_body,
     check_imperative,
@@ -21,8 +26,6 @@ from git_commit_guard import (
     main,
 )
 
-# ruff: noqa: S101 # Use of `assert` detected
-
 
 @pytest.fixture(scope="session", autouse=True)
 def nltk_data():
@@ -147,6 +150,26 @@ class TestCheckSubject:
         check_subject("fix(anything): add token", r, allowed_scopes=frozenset())
         assert r.ok
 
+    def test_custom_max_length_enforced(self):
+        r = Result()
+        check_subject("fix: add thing", r, max_subject_length=10)
+        assert not r.ok
+
+    def test_custom_max_length_passes(self):
+        r = Result()
+        check_subject("fix: ok", r, max_subject_length=10)
+        assert r.ok
+
+    def test_custom_type_passes(self):
+        r = Result()
+        check_subject("wip: add thing", r, allowed_types=frozenset(["wip"]))
+        assert r.ok
+
+    def test_type_not_in_custom_list_fails(self):
+        r = Result()
+        check_subject("feat: add thing", r, allowed_types=frozenset(["wip"]))
+        assert not r.ok
+
     @pytest.mark.parametrize(
         "type_",
         [
@@ -409,6 +432,45 @@ class TestParseConfigChecks:
             _parse_config_checks({"disable": ["bogus"]}, "disable")
 
 
+class TestResolveMaxSubjectLength:
+    def test_defaults_when_no_config_or_flag(self):
+        result = _resolve_max_subject_length(Namespace(max_subject_length=None), {})
+        assert result == MAX_SUBJECT_LEN
+
+    def test_cli_flag_overrides_default(self):
+        result = _resolve_max_subject_length(Namespace(max_subject_length=50), {})
+        assert result == 50  # noqa: PLR2004 Magic value used in comparison, consider replacing 50 with a constant variable
+
+    def test_config_overrides_default(self):
+        result = _resolve_max_subject_length(
+            Namespace(max_subject_length=None), {"max-subject-length": 60}
+        )
+        assert result == 60  # noqa: PLR2004 Magic value used in comparison, consider replacing 60 with a constant variable
+
+    def test_cli_overrides_config(self):
+        result = _resolve_max_subject_length(
+            Namespace(max_subject_length=50), {"max-subject-length": 60}
+        )
+        assert result == 50  # noqa: PLR2004 Magic value used in comparison, consider replacing 50 with a constant variable
+
+
+class TestResolveTypes:
+    def test_defaults_when_no_config_or_flag(self):
+        assert _resolve_types(Namespace(types=None), {}) == TYPES
+
+    def test_cli_flag_replaces_defaults(self):
+        result = _resolve_types(Namespace(types="wip,deploy"), {})
+        assert result == frozenset({"wip", "deploy"})
+
+    def test_config_replaces_defaults(self):
+        result = _resolve_types(Namespace(types=None), {"types": ["wip", "deploy"]})
+        assert result == frozenset({"wip", "deploy"})
+
+    def test_cli_overrides_config(self):
+        result = _resolve_types(Namespace(types="wip"), {"types": ["deploy"]})
+        assert result == frozenset({"wip"})
+
+
 class TestParseChecks:
     def test_invalid_check_name(self):
         parser = ArgumentParser()
@@ -641,3 +703,131 @@ class TestMain:
             ),
         ):
             assert main() == 0
+
+    def test_types_flag_valid(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("wip: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--types",
+            "wip,feat,fix",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 0
+
+    def test_types_flag_invalid(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("chore: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--types",
+            "feat,fix",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 1
+
+    def test_types_from_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("wip: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = ["cg", "--message-file", str(f), "--disable", "signature"]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"types": ["wip", "feat"]},
+            ),
+        ):
+            assert main() == 0
+
+    def test_max_subject_length_flag_passes(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("fix: ok\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--max-subject-length",
+            "10",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 0
+
+    def test_max_subject_length_flag_fails(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(_VALID_MSG)
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--max-subject-length",
+            "5",
+        ]
+        with patch("sys.argv", argv):
+            assert main() == 1
+
+    def test_max_subject_length_from_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(_VALID_MSG)
+        argv = ["cg", "--message-file", str(f), "--disable", "signature"]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"max-subject-length": 5},
+            ),
+        ):
+            assert main() == 1
+
+    def test_max_subject_length_cli_overrides_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text(_VALID_MSG)
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--max-subject-length",
+            "100",
+        ]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"max-subject-length": 5},
+            ),
+        ):
+            assert main() == 0
+
+    def test_types_cli_overrides_config(self, tmp_path):
+        f = tmp_path / "msg"
+        f.write_text("wip: add thing\n\nbody\n\nSigned-off-by: A User <a@b.com>")
+        argv = [
+            "cg",
+            "--message-file",
+            str(f),
+            "--disable",
+            "signature",
+            "--types",
+            "wip",
+        ]
+        with (
+            patch("sys.argv", argv),
+            patch(
+                "git_commit_guard._load_config",
+                return_value={"types": ["deploy"]},
+            ),
+        ):
+            assert main() == 0