git-commit-guard 0.17.0__tar.gz → 0.18.0__tar.gz

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/.github/workflows/lint-commits.yml

@@ -22,7 +22,7 @@ jobs:
           key: nltk-averaged-perceptron-tagger-punkt
       - name: Lint commits
         # yamllint disable-line rule:line-length
-        uses: benner/commit-guard@064132b8b0cf5ec26083de7193f4e78d37a615d4  # v0.15.1
+        uses: benner/commit-guard@d4c9fbe4a203ab32f63f66e1902d780528f781f2  # v0.17.0
         with:
           range: origin/${{ github.base_ref }}..HEAD
           disable: signature

git_commit_guard-0.18.0/.github/workflows/lint-workflows.yml

@@ -0,0 +1,47 @@
+---
+name: Lint GitHub Actions workflows
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  actionlint:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Checkout code
+        # yamllint disable-line rule:line-length
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # ratchet:actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Run actionlint
+        # yamllint disable-line rule:line-length
+        uses: reviewdog/action-actionlint@6fb7acc99f4a1008869fa8a0f09cfca740837d9d  # ratchet:reviewdog/action-actionlint@v1
+        with:
+          github_token: ${{ github.token }}
+          reporter: github-pr-review
+
+  zizmor:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Checkout code
+        # yamllint disable-line rule:line-length
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # ratchet:actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up uv
+        # yamllint disable-line rule:line-length
+        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78  # ratchet:astral-sh/setup-uv@v7
+      - name: Set up reviewdog
+        # yamllint disable-line rule:line-length
+        uses: reviewdog/action-setup@d8a7baabd7f3e8544ee4dbde3ee41d0011c3a93f  # ratchet:reviewdog/action-setup@v1
+      - name: Run zizmor
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
+        run: |
+          uvx zizmor==1.24.1 --format=sarif . |
+            reviewdog -f=sarif -name=zizmor \
+              -reporter=github-pr-review -fail-on-error

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.17.0
+Version: 0.18.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
@@ -94,7 +94,7 @@ commit-guard --disable body,signed-off,signature
 Available checks:
 
 * `subject` - Format matches `type(scope): description`, valid type,
-    lowercase start, no trailing period, max 72 chars
+    lowercase start, no trailing `.` `!` `?` or space, max 72 chars
 * `imperative` - First word is an imperative verb (for example `add` not `added`)
 * `body` - Blank line separates subject from body, and body is non-empty
 * `signed-off` - `Signed-off-by:` trailer exists
@@ -131,8 +131,8 @@ In `.commit-guard.toml`:
 require-lowercase = false
 ```
 
-By default trailing `.` is forbidden. To change the set of forbidden trailing
-characters (any character is valid, including space):
+By default `.`, `!`, `?`, and space are forbidden as trailing characters.
+To change the set (any character is valid):
 
 ```bash
 commit-guard --no-trailing-chars ".,"
@@ -246,7 +246,7 @@ COMMIT_GUARD_GIT_TIMEOUT=30 commit-guard --range origin/main..HEAD
 In GitHub Actions, set it at the step or job level:
 
 ```yaml
-- uses: benner/commit-guard@v0.17.0
+- uses: benner/commit-guard@v0.18.0
   env:
     COMMIT_GUARD_GIT_TIMEOUT: 30
   with:
@@ -330,7 +330,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.17.0
+  - uses: benner/commit-guard@v0.18.0
 ```
 
 Check all commits in a pull request:
@@ -346,7 +346,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
@@ -354,7 +354,7 @@ jobs:
 Check a specific commit SHA (mirrors the positional CLI argument):
 
 ```yaml
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           rev: ${{ github.sha }}
 ```
@@ -372,7 +372,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -391,7 +391,7 @@ jobs:
 When `output-file` is set the action exposes the path as an output:
 
 ```yaml
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -407,7 +407,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.17.0
+    rev: v0.18.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/README.md

@@ -73,7 +73,7 @@ commit-guard --disable body,signed-off,signature
 Available checks:
 
 * `subject` - Format matches `type(scope): description`, valid type,
-    lowercase start, no trailing period, max 72 chars
+    lowercase start, no trailing `.` `!` `?` or space, max 72 chars
 * `imperative` - First word is an imperative verb (for example `add` not `added`)
 * `body` - Blank line separates subject from body, and body is non-empty
 * `signed-off` - `Signed-off-by:` trailer exists
@@ -110,8 +110,8 @@ In `.commit-guard.toml`:
 require-lowercase = false
 ```
 
-By default trailing `.` is forbidden. To change the set of forbidden trailing
-characters (any character is valid, including space):
+By default `.`, `!`, `?`, and space are forbidden as trailing characters.
+To change the set (any character is valid):
 
 ```bash
 commit-guard --no-trailing-chars ".,"
@@ -225,7 +225,7 @@ COMMIT_GUARD_GIT_TIMEOUT=30 commit-guard --range origin/main..HEAD
 In GitHub Actions, set it at the step or job level:
 
 ```yaml
-- uses: benner/commit-guard@v0.17.0
+- uses: benner/commit-guard@v0.18.0
   env:
     COMMIT_GUARD_GIT_TIMEOUT: 30
   with:
@@ -309,7 +309,7 @@ steps:
   - uses: actions/checkout@v4
     with:
       fetch-depth: 0
-  - uses: benner/commit-guard@v0.17.0
+  - uses: benner/commit-guard@v0.18.0
 ```
 
 Check all commits in a pull request:
@@ -325,7 +325,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
 ```
@@ -333,7 +333,7 @@ jobs:
 Check a specific commit SHA (mirrors the positional CLI argument):
 
 ```yaml
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           rev: ${{ github.sha }}
 ```
@@ -351,7 +351,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature
@@ -370,7 +370,7 @@ jobs:
 When `output-file` is set the action exposes the path as an output:
 
 ```yaml
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -386,7 +386,7 @@ Add to your `.pre-commit-config.yaml`:
 ---
 repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.17.0
+    rev: v0.18.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/action.yml

@@ -39,7 +39,7 @@ inputs:
     required: false
     default: 'false'
   no-trailing-chars:
-    description: Forbidden trailing characters, comma-separated (default '.')
+    description: Forbidden trailing characters, comma-separated (default '.', '!', '?', ' ')
     required: false
   allow-empty:
     description: Exit 0 when --range yields no commits

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/docs/index.html

@@ -355,7 +355,7 @@ $ echo "fix(auth): add token refresh" | commit-guard</code></pre>
                 <td><code>subject</code></td>
                 <td>
                   <a href="https://www.conventionalcommits.org/" target="_blank" rel="noopener">Conventional Commits</a>
-                  format: valid type, lowercase start, no trailing period,
+                  format: valid type, lowercase start, no trailing <code>.</code> <code>!</code> <code>?</code> or space,
                   max length (default 72). All limits are configurable. Use
                   <code>!</code> before the colon for breaking changes:
                   <code>feat!: remove endpoint</code>
@@ -479,13 +479,13 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: benner/commit-guard@v0.17.0
+      - uses: benner/commit-guard@v0.18.0
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
           disable: signed-off,signature</code></pre>
 
         <p>Check a specific commit SHA:</p>
-        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.17.0
+        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.18.0
         with:
           rev: ${{ github.sha }}</code></pre>
 
@@ -504,7 +504,7 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
           When <code>output-file</code> is set the action exposes the path as
           a step output, making JSONL results available to subsequent steps:
         </p>
-        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.17.0
+        <pre><code class="language-yaml">      - uses: benner/commit-guard@v0.18.0
         id: cg
         with:
           range: ${{ env.PR_BASE }}..${{ env.PR_HEAD }}
@@ -517,7 +517,7 @@ require-trailers = ["Closes", "Reviewed-by"]</code></pre>
         <p>Add to <code>.pre-commit-config.yaml</code>:</p>
         <pre><code class="language-yaml">repos:
   - repo: https://github.com/benner/commit-guard
-    rev: v0.17.0
+    rev: v0.18.0
     hooks:
       - id: commit-guard
       - id: commit-guard-signature</code></pre>

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/src/git_commit_guard/__init__.py

@@ -153,7 +153,7 @@ def check_subject(  # noqa: PLR0913 Too many arguments in function definition (9
     allowed_types=TYPES,
     max_subject_length=MAX_SUBJECT_LEN,
     min_description_length=0,
-    no_trailing_chars=frozenset("."),
+    no_trailing_chars=frozenset({".", "!", "?", " "}),
     *,
     require_scope=False,
     require_lowercase=True,
@@ -362,7 +362,7 @@ def _resolve_no_trailing_chars(args, config):
         return frozenset(c for c in args.no_trailing_chars.split(",") if c)
     if "no-trailing-chars" in config:
         return frozenset(config["no-trailing-chars"])
-    return frozenset(".")
+    return frozenset({".", "!", "?", " "})
 
 
 def _resolve_required_trailers(args, config):

{git_commit_guard-0.17.0 → git_commit_guard-0.18.0}/tests/test_git_commit_guard.py

@@ -22,6 +22,8 @@ from git_commit_guard import (
     _report_text,
     _resolve_max_subject_length,
     _resolve_min_description_length,
+    _resolve_no_trailing_chars,
+    _resolve_require_lowercase,
     _resolve_required_trailers,
     _resolve_types,
     _strip_comments,
@@ -454,6 +456,19 @@ class TestCheckImperative:
         check_imperative("", r)
         assert r.ok
 
+    def test_pos_fallback_unknown_word_fails(self):
+        r = Result()
+        with (
+            patch("git_commit_guard.wordnet.morphy", return_value=None),
+            patch(
+                "git_commit_guard.nltk.pos_tag",
+                return_value=[("to", "TO"), ("xyzzy", "NN")],
+            ),
+        ):
+            check_imperative("xyzzy something", r)
+        assert not r.ok
+        assert "POS=NN" in r.errors[0][2]
+
 
 class TestDownloadIfMissing:
     def test_skips_download_when_present(self):
@@ -617,6 +632,38 @@ class TestResolveMinDescriptionLength:
         assert result == 10
 
 
+class TestResolveRequireLowercase:
+    def test_cli_flag_overrides_default(self):
+        assert (
+            _resolve_require_lowercase(Namespace(require_lowercase=False), {}) is False
+        )
+
+    def test_config_overrides_default(self):
+        result = _resolve_require_lowercase(
+            Namespace(require_lowercase=None), {"require-lowercase": False}
+        )
+        assert result is False
+
+    def test_default_is_true(self):
+        assert _resolve_require_lowercase(Namespace(require_lowercase=None), {}) is True
+
+
+class TestResolveNoTrailingChars:
+    def test_cli_flag_overrides_default(self):
+        result = _resolve_no_trailing_chars(Namespace(no_trailing_chars=".,!"), {})
+        assert result == frozenset({".", "!"})
+
+    def test_config_overrides_default(self):
+        result = _resolve_no_trailing_chars(
+            Namespace(no_trailing_chars=None), {"no-trailing-chars": [".", "!"]}
+        )
+        assert result == frozenset({".", "!"})
+
+    def test_default_includes_common_punctuation_and_space(self):
+        result = _resolve_no_trailing_chars(Namespace(no_trailing_chars=None), {})
+        assert result == frozenset({".", "!", "?", " "})
+
+
 class TestGitTimeout:
     def test_default(self, monkeypatch):
         monkeypatch.delenv("COMMIT_GUARD_GIT_TIMEOUT", raising=False)
@@ -1458,6 +1505,27 @@ class TestOutputJsonl:
             assert data["sha"] == rev
             assert data["ok"] is True
 
+    def test_range_failing_commit_returns_nonzero(self, capsys):
+        with (
+            patch(
+                "sys.argv",
+                [
+                    "cg",
+                    "--range",
+                    "HEAD~1..HEAD",
+                    "--disable",
+                    "signature,imperative",
+                    "--output",
+                    "jsonl",
+                ],
+            ),
+            patch("git_commit_guard._get_range_revs", return_value=["aaa"]),
+            patch("git_commit_guard._get_message", return_value="bad message"),
+        ):
+            assert main() == 1
+        data = json.loads(capsys.readouterr().out)
+        assert data["ok"] is False
+
 
 class TestOutputFile:
     def test_single_commit_writes_jsonl_to_file(self, tmp_path, capsys):