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

git_commit_guard-0.10.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.10.0/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+---
+name: Release
+on:  # yamllint disable-line rule:truthy
+  push:
+    tags:
+      - 'v*'
+permissions:
+  contents: write
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        # yamllint disable-line rule:line-length
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Generate release notes
+        id: git-cliff
+        # yamllint disable-line rule:line-length
+        uses: orhun/git-cliff-action@c93ef52f3d0ddcdcc9bd5447d98d458a11cd4f72  # v4.7.1
+        with:
+          args: --current
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+          NOTES_FILE: ${{ steps.git-cliff.outputs.changelog }}
+        run: |-
+          gh release create "$TAG" \
+            --title "$TAG" \
+            --notes-file "$NOTES_FILE"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.8.0
+Version: 0.10.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,21 +161,37 @@ 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
 
+Use `--range` to check all commits in a revision range. All commits are
+checked and a single non-zero exit code is returned if any fail:
+
+```bash
+# check all commits in a PR
+commit-guard --range origin/main..HEAD
+
+# check between two tags
+commit-guard --range v1.0..v2.0
+
+# only subject checks on a range
+commit-guard --range origin/main..HEAD --enable subject,imperative
+```
+
+Merge commits are excluded by default. Use `--include-merges` to check them:
+
 ```bash
-# all non-merge commits between tags
-git rev-list --no-merges v1.0..v2.0 | while read -r rev; do
-    commit-guard "$rev" || git log -1 --oneline "$rev"
-done
+commit-guard --range origin/main..HEAD --include-merges
+```
 
-# only subject checks on a PR range
-git rev-list --no-merges origin/main..HEAD | while read -r rev; do
-    commit-guard "$rev" --enable subject,imperative
-done
+An empty range (no commits) exits non-zero by default — this catches
+misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
+
+```bash
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit
@@ -206,8 +246,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.10.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,21 +140,37 @@ 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
 
+Use `--range` to check all commits in a revision range. All commits are
+checked and a single non-zero exit code is returned if any fail:
+
+```bash
+# check all commits in a PR
+commit-guard --range origin/main..HEAD
+
+# check between two tags
+commit-guard --range v1.0..v2.0
+
+# only subject checks on a range
+commit-guard --range origin/main..HEAD --enable subject,imperative
+```
+
+Merge commits are excluded by default. Use `--include-merges` to check them:
+
 ```bash
-# all non-merge commits between tags
-git rev-list --no-merges v1.0..v2.0 | while read -r rev; do
-    commit-guard "$rev" || git log -1 --oneline "$rev"
-done
+commit-guard --range origin/main..HEAD --include-merges
+```
 
-# only subject checks on a PR range
-git rev-list --no-merges origin/main..HEAD | while read -r rev; do
-    commit-guard "$rev" --enable subject,imperative
-done
+An empty range (no commits) exits non-zero by default — this catches
+misconfigured range specs in CI. Use `--allow-empty` to exit 0 instead:
+
+```bash
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit
@@ -185,8 +225,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.10.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.10.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
 
 
@@ -216,6 +224,23 @@ def _get_message(rev):
         sys.exit(f"git error: {stderr}")
 
 
+def _get_range_revs(rev_range, *, include_merges=False):
+    cmd = ["git", "log", "--format=%H"]
+    if not include_merges:
+        cmd.append("--no-merges")
+    cmd.append(rev_range)
+    try:
+        output = subprocess.check_output(  # noqa: S603
+            cmd,
+            text=True,
+            stderr=subprocess.PIPE,
+            timeout=GIT_TIMEOUT,
+        ).strip()
+    except subprocess.CalledProcessError as e:
+        sys.exit(f"git error: {e.stderr.strip()}")
+    return output.split("\n") if output else []
+
+
 @dataclass
 class Args:
     rev: str | None
@@ -223,6 +248,11 @@ class Args:
     enabled: frozenset
     allowed_scopes: frozenset
     require_scope: bool
+    allowed_types: frozenset
+    max_subject_length: int
+    rev_range: str | None
+    allow_empty: bool
+    include_merges: bool
 
 
 def _resolve_enabled(args, config, parser):
@@ -241,6 +271,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,12 +338,54 @@ 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})",
+    )
+    parser.add_argument(
+        "--range",
+        dest="rev_range",
+        metavar="REF..REF",
+        help="check all commits in the given revision range",
+    )
+    parser.add_argument(
+        "--allow-empty",
+        action="store_true",
+        default=False,
+        help="exit 0 when --range yields no commits (default: exit 1)",
+    )
+    parser.add_argument(
+        "--include-merges",
+        action="store_true",
+        default=False,
+        help="include merge commits when checking a range (default: excluded)",
+    )
     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.allow_empty and not args.rev_range:
+        parser.error("--allow-empty requires --range")
+    if args.include_merges and not args.rev_range:
+        parser.error("--include-merges requires --range")
 
-    if args.message_file:
+    if args.rev_range:
+        if args.rev is not None or args.message_file:
+            parser.error("--range cannot be combined with rev or --message-file")
+        rev = None
+        message = ""
+    elif args.message_file:
         rev = None
         message = _strip_comments(args.message_file.read_text().strip())
     elif args.rev:
@@ -316,6 +404,11 @@ def _parse_args():
         enabled=enabled,
         allowed_scopes=allowed_scopes,
         require_scope=require_scope,
+        allowed_types=allowed_types,
+        max_subject_length=max_subject_length,
+        rev_range=args.rev_range,
+        allow_empty=args.allow_empty,
+        include_merges=args.include_merges,
     )
 
 
@@ -329,19 +422,17 @@ def _report(result):
     return 0 if result.ok else 1
 
 
-def main():
-    args = _parse_args()
-    lines = args.message.split("\n")
-
-    if Check.IMPERATIVE in args.enabled:
-        _ensure_nltk_data()
-
-    result = Result()
-
+def _run_checks(args, rev, message, result):
+    lines = message.split("\n")
     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:
@@ -352,8 +443,32 @@ def main():
     if Check.BODY in args.enabled:
         check_body(lines, result)
     if Check.SIGNED_OFF in args.enabled:
-        check_signed_off(args.message, result)
-    if Check.SIGNATURE in args.enabled and args.rev:
-        check_signature(args.rev, result)
+        check_signed_off(message, result)
+    if Check.SIGNATURE in args.enabled and rev:
+        check_signature(rev, result)
+
+
+def main():
+    args = _parse_args()
 
+    if Check.IMPERATIVE in args.enabled:
+        _ensure_nltk_data()
+
+    if args.rev_range:
+        revs = _get_range_revs(args.rev_range, include_merges=args.include_merges)
+        if not revs:
+            sys.stderr.write("no commits in range\n")
+            return 0 if args.allow_empty else 1
+        failed = False
+        for rev in revs:
+            message = _strip_comments(_get_message(rev))
+            sys.stderr.write(f"{rev[:7]} {message.split('\n')[0]}\n")
+            result = Result()
+            _run_checks(args, rev, message, result)
+            if _report(result) != 0:
+                failed = True
+        return 1 if failed else 0
+
+    result = Result()
+    _run_checks(args, args.rev, args.message, result)
     return _report(result)