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

git_commit_guard-0.11.0/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+---
+name: Release
+on:  # yamllint disable-line rule:truthy
+  push:
+    tags:
+      - 'v*'
+permissions:
+  contents: write
+  id-token: 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: Set up Python
+        # yamllint disable-line rule:line-length
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+      - name: Set up uv
+        # yamllint disable-line rule:line-length
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # v7.6.0
+        with:
+          enable-cache: false
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        # yamllint disable-line rule:line-length
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.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"
+      - name: Upload dist to GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+        run: gh release upload "$TAG" dist/*

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.9.0
+Version: 0.11.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
@@ -110,6 +110,13 @@ The default maximum subject line length is 72 characters. Override with
 commit-guard --max-subject-length 100
 ```
 
+By default there is no minimum description length. Enforce one with
+`--min-description-length`:
+
+```bash
+commit-guard --min-description-length 10
+```
+
 ### Type validation
 
 By default the standard conventional commit types are accepted. Use `--types`
@@ -143,9 +150,9 @@ 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`, `require-scope`, `types`, and
-`max-subject-length`. commit-guard searches upward from the working directory
-and uses the first file found.
+set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`,
+`max-subject-length`, and `min-description-length`. commit-guard searches
+upward from the working directory and uses the first file found.
 
 ```toml
 # .commit-guard.toml
@@ -154,6 +161,7 @@ scopes = ["auth", "api", "db"]
 require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
+min-description-length = 10
 ```
 
 ```toml
@@ -162,21 +170,36 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`) take full precedence and ignore config file values when
-provided.
+`--max-subject-length`, `--min-description-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
+commit-guard --range origin/main..HEAD --include-merges
+```
+
+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
-# 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
-
-# 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
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit

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

@@ -89,6 +89,13 @@ The default maximum subject line length is 72 characters. Override with
 commit-guard --max-subject-length 100
 ```
 
+By default there is no minimum description length. Enforce one with
+`--min-description-length`:
+
+```bash
+commit-guard --min-description-length 10
+```
+
 ### Type validation
 
 By default the standard conventional commit types are accepted. Use `--types`
@@ -122,9 +129,9 @@ 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`, `require-scope`, `types`, and
-`max-subject-length`. commit-guard searches upward from the working directory
-and uses the first file found.
+set defaults for `enable`, `disable`, `scopes`, `require-scope`, `types`,
+`max-subject-length`, and `min-description-length`. commit-guard searches
+upward from the working directory and uses the first file found.
 
 ```toml
 # .commit-guard.toml
@@ -133,6 +140,7 @@ scopes = ["auth", "api", "db"]
 require-scope = true
 types = ["feat", "fix", "chore", "wip"]
 max-subject-length = 100
+min-description-length = 10
 ```
 
 ```toml
@@ -141,21 +149,36 @@ enable = ["subject", "imperative"]
 ```
 
 CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`, `--types`,
-`--max-subject-length`) take full precedence and ignore config file values when
-provided.
+`--max-subject-length`, `--min-description-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
+commit-guard --range origin/main..HEAD --include-merges
+```
+
+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
-# 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
-
-# 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
+commit-guard --range origin/main..HEAD --allow-empty
 ```
 
 ### pre-commit

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

@@ -120,12 +120,13 @@ def _strip_comments(message):
     )
 
 
-def check_subject(  # noqa: PLR0913 Too many arguments in function definition (6 > 5)
+def check_subject(  # noqa: PLR0913 Too many arguments in function definition (7 > 5)
     line,
     result,
     allowed_scopes=frozenset(),
     allowed_types=TYPES,
     max_subject_length=MAX_SUBJECT_LEN,
+    min_description_length=0,
     *,
     require_scope=False,
 ):
@@ -150,6 +151,8 @@ def check_subject(  # noqa: PLR0913 Too many arguments in function definition (6
         result.error("description must not end with period")
     if len(line) > max_subject_length:
         result.error(f"subject too long: {len(line)} > {max_subject_length}")
+    if min_description_length > 0 and len(desc) < min_description_length:
+        result.error(f"description too short: {len(desc)} < {min_description_length}")
     return desc
 
 
@@ -224,6 +227,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
@@ -233,6 +253,10 @@ class Args:
     require_scope: bool
     allowed_types: frozenset
     max_subject_length: int
+    min_description_length: int
+    rev_range: str | None
+    allow_empty: bool
+    include_merges: bool
 
 
 def _resolve_enabled(args, config, parser):
@@ -259,6 +283,14 @@ def _resolve_max_subject_length(args, config):
     return MAX_SUBJECT_LEN
 
 
+def _resolve_min_description_length(args, config):
+    if args.min_description_length is not None:
+        return args.min_description_length
+    if "min-description-length" in config:
+        return config["min-description-length"]
+    return 0
+
+
 def _resolve_types(args, config):
     if args.types:
         return frozenset(t.strip() for t in args.types.split(","))
@@ -330,14 +362,50 @@ def _parse_args():
         metavar="N",
         help=f"maximum subject line length (default: {MAX_SUBJECT_LEN})",
     )
+    parser.add_argument(
+        "--min-description-length",
+        type=int,
+        default=None,
+        metavar="N",
+        help="minimum description length in characters (default: 0, off)",
+    )
+    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)
+    min_description_length = _resolve_min_description_length(args, config)
 
-    if args.message_file:
+    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.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:
@@ -358,6 +426,10 @@ def _parse_args():
         require_scope=require_scope,
         allowed_types=allowed_types,
         max_subject_length=max_subject_length,
+        min_description_length=min_description_length,
+        rev_range=args.rev_range,
+        allow_empty=args.allow_empty,
+        include_merges=args.include_merges,
     )
 
 
@@ -371,15 +443,8 @@ 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(
@@ -388,6 +453,7 @@ def main():
             args.allowed_scopes,
             args.allowed_types,
             args.max_subject_length,
+            args.min_description_length,
             require_scope=args.require_scope,
         )
     if Check.IMPERATIVE in args.enabled:
@@ -399,8 +465,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)