PyPI - git-commit-guard - Versions diffs - 0.6.0__tar.gz → 0.8.0__tar.gz - Mend

git-commit-guard 0.6.0tar.gz → 0.8.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

git_commit_guard-0.8.0/.github/workflows/lint-md.yml ADDED Viewed

@@ -0,0 +1,26 @@
+---
+name: Lint Markdown
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  lint-md:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      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: Lint Markdown files with reviewdog
+        # yamllint disable-line rule:line-length
+        uses: reviewdog/action-markdownlint@3667398db9118d7e78f7a63d10e26ce454ba5f58  # v0.26.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          level: info
+          fail_on_error: true

{git_commit_guard-0.6.0 → git_commit_guard-0.8.0}/.pre-commit-hooks.yaml RENAMED Viewed

@@ -10,3 +10,14 @@
   always_run: true
   pass_filenames: true
   minimum_pre_commit_version: 2.8.0
+- id: commit-guard-signature
+  name: commit-guard (signature)
+  description: Verify commit is GPG/SSH signed
+  entry: commit-guard
+  args: [HEAD, --enable, signature]
+  language: python
+  stages: [post-commit]
+  always_run: true
+  pass_filenames: false
+  minimum_pre_commit_version: 2.8.0

{git_commit_guard-0.6.0 → git_commit_guard-0.8.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.6.0
+Version: 0.8.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
@@ -31,7 +31,8 @@ imperative verb.
 ```bash
 $ commit-guard
-✗ subject does not match 'type(scope): description': Merge pull request #5 from fix/branch
+✗ subject does not match 'type(scope): description':
+  Merge pull request #5 from fix/branch
 ✗ missing 'Signed-off-by' trailer
 ✗ commit is not signed (GPG/SSH)
 ```
@@ -100,6 +101,45 @@ Available checks:
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
+### Scope validation
+By default any scope is accepted and scope is optional. Use `--scopes` to
+restrict allowed values and `--require-scope` to enforce that a scope is always
+present:
+```bash
+# only allow known scopes
+commit-guard --scopes auth,api,db
+# require a scope
+commit-guard --require-scope
+# combine both
+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.
+```toml
+# .commit-guard.toml
+disable = ["signature", "body"]
+scopes = ["auth", "api", "db"]
+require-scope = true
+```
+```toml
+# .commit-guard.toml
+enable = ["subject", "imperative"]
+```
+CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`) take full
+precedence and ignore config file values when provided.
 ### Checking a range of commits
 ```bash
@@ -125,14 +165,19 @@ repos:
     rev: v0.1.0
     hooks:
       - id: commit-guard
+      - id: commit-guard-signature
 ```
-Install the hook:
+Install the hooks:
 ```bash
-pre-commit install --hook-type commit-msg
+pre-commit install --hook-type commit-msg --hook-type post-commit
 ```
+`commit-guard` runs at the `commit-msg` stage and checks message format.
+`commit-guard-signature` runs at the `post-commit` stage and verifies
+the GPG/SSH signature after the commit object is created.
 To selectively enable or disable checks, pass `args`:
 ```yaml
@@ -144,10 +189,9 @@ To selectively enable or disable checks, pass `args`:
 commit-guard combines two strategies to detect non-imperative descriptions:
-1. A whitelist common commit verbs (`add`, `fix`, `remove`, etc.)
-   that pass immediately without NLP.
-2. nltk POS tagging as a fallback — flags words tagged as past tense (`VBD`),
+1. nltk POS tagging — flags words tagged as past tense (`VBD`),
    gerund (`VBG`), third person (`VBZ`), etc.
+2. WordNet morphology as a fallback for words the tagger misclassifies.
 This catches common mistakes like `added logging` or `fixes bug` while
 keeping false positives low.

{git_commit_guard-0.6.0 → git_commit_guard-0.8.0}/README.md RENAMED Viewed

@@ -10,7 +10,8 @@ imperative verb.
 ```bash
 $ commit-guard
-✗ subject does not match 'type(scope): description': Merge pull request #5 from fix/branch
+✗ subject does not match 'type(scope): description':
+  Merge pull request #5 from fix/branch
 ✗ missing 'Signed-off-by' trailer
 ✗ commit is not signed (GPG/SSH)
 ```
@@ -79,6 +80,45 @@ Available checks:
 * `signed-off` - `Signed-off-by:` trailer exists
 * `signature` - Verify GPG or SSH signature
+### Scope validation
+By default any scope is accepted and scope is optional. Use `--scopes` to
+restrict allowed values and `--require-scope` to enforce that a scope is always
+present:
+```bash
+# only allow known scopes
+commit-guard --scopes auth,api,db
+# require a scope
+commit-guard --require-scope
+# combine both
+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.
+```toml
+# .commit-guard.toml
+disable = ["signature", "body"]
+scopes = ["auth", "api", "db"]
+require-scope = true
+```
+```toml
+# .commit-guard.toml
+enable = ["subject", "imperative"]
+```
+CLI flags (`--enable`, `--disable`, `--scopes`, `--require-scope`) take full
+precedence and ignore config file values when provided.
 ### Checking a range of commits
 ```bash
@@ -104,14 +144,19 @@ repos:
     rev: v0.1.0
     hooks:
       - id: commit-guard
+      - id: commit-guard-signature
 ```
-Install the hook:
+Install the hooks:
 ```bash
-pre-commit install --hook-type commit-msg
+pre-commit install --hook-type commit-msg --hook-type post-commit
 ```
+`commit-guard` runs at the `commit-msg` stage and checks message format.
+`commit-guard-signature` runs at the `post-commit` stage and verifies
+the GPG/SSH signature after the commit object is created.
 To selectively enable or disable checks, pass `args`:
 ```yaml
@@ -123,10 +168,9 @@ To selectively enable or disable checks, pass `args`:
 commit-guard combines two strategies to detect non-imperative descriptions:
-1. A whitelist common commit verbs (`add`, `fix`, `remove`, etc.)
-   that pass immediately without NLP.
-2. nltk POS tagging as a fallback — flags words tagged as past tense (`VBD`),
+1. nltk POS tagging — flags words tagged as past tense (`VBD`),
    gerund (`VBG`), third person (`VBZ`), etc.
+2. WordNet morphology as a fallback for words the tagger misclassifies.
 This catches common mistakes like `added logging` or `fixes bug` while
 keeping false positives low.

git_commit_guard-0.8.0/htmlcov/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ # Created by coverage.py
2	+ *

git_commit_guard-0.8.0/htmlcov/class_index.html ADDED Viewed

@@ -0,0 +1,161 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Coverage report</title>
+    <link rel="icon" sizes="32x32" href="favicon_32_cb_c827f16f.png">
+    <link rel="stylesheet" href="style_cb_9ff733b0.css" type="text/css">
+    <script src="coverage_html_cb_dd2e7eb5.js" defer></script>
+</head>
+<body class="indexfile">
+<header>
+    <div class="content">
+        <h1>Coverage report:
+            <span class="pc_cov">99%</span>
+        </h1>
+        <aside id="help_panel_wrapper">
+            <input id="help_panel_state" type="checkbox">
+            <label for="help_panel_state">
+                <img id="keyboard_icon" src="keybd_closed_cb_900cfef5.png" alt="Show/hide keyboard shortcuts">
+            </label>
+            <div id="help_panel">
+                <p class="legend">Shortcuts on this page</p>
+                <div class="keyhelp">
+                    <p>
+                        <kbd>f</kbd>
+                        <kbd>n</kbd>
+                        <kbd>s</kbd>
+                        <kbd>m</kbd>
+                        <kbd>x</kbd>
+                        <kbd>c</kbd>
+                        &nbsp; change column sorting
+                    </p>
+                    <p>
+                        <kbd>[</kbd>
+                        <kbd>]</kbd>
+                        &nbsp; prev/next file
+                    </p>
+                    <p>
+                        <kbd>?</kbd> &nbsp; show/hide this help
+                    </p>
+                </div>
+            </div>
+        </aside>
+        <form id="filter_container">
+            <input id="filter" type="text" value="" placeholder="filter...">
+            <div>
+                <input id="hide100" type="checkbox" >
+                <label for="hide100">hide covered</label>
+            </div>
+        </form>
+        <h2>
+                <a class="button" href="index.html">Files</a>
+                <a class="button" href="function_index.html">Functions</a>
+                <a class="button current">Classes</a>
+        </h2>
+        <p class="text">
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
+            created at 2026-04-18 23:09 +0300
+        </p>
+    </div>
+</header>
+<main id="index">
+    <table class="index" data-sortable>
+        <thead>
+            <tr class="tablehead" title="Click to sort">
+                <th id="file" class="name" aria-sort="none" data-shortcut="f">File<span class="arrows"></span></th>
+                <th id="region" class="name" aria-sort="none" data-default-sort-order="ascending" data-shortcut="n">class<span class="arrows"></span></th>
+                <th class="spacer">&nbsp;</th>
+                <th id="statements" aria-sort="none" data-default-sort-order="descending" data-shortcut="s">statements<span class="arrows"></span></th>
+                <th id="missing" aria-sort="none" data-default-sort-order="descending" data-shortcut="m">missing<span class="arrows"></span></th>
+                <th id="excluded" aria-sort="none" data-default-sort-order="descending" data-shortcut="x">excluded<span class="arrows"></span></th>
+                <th class="spacer">&nbsp;</th>
+                <th id="coverage" aria-sort="none" data-shortcut="c">coverage<span class="arrows"></span></th>
+            </tr>
+        </thead>
+        <tbody>
+            <tr class="region">
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t44">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t44"><data value='Check'>Check</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t72">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t72"><data value='Level'>Level</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t86">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t86"><data value='Result'>Result</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>4</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="4 4">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t218">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html#t218"><data value='Args'>Args</data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>0</td>
+                <td>0</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="0 0">100%</td>
+            </tr>
+            <tr class="region">
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html">src&#8201;/&#8201;git_commit_guard&#8201;/&#8201;__init__.py</a></td>
+                <td class="name"><a href="z_262b75d81d1cf686___init___py.html"><data value=''><span class='no-noun'>(no class)</span></data></a></td>
+                <td class="spacer">&nbsp;</td>
+                <td>212</td>
+                <td>2</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="210 212">99%</td>
+            </tr>
+        </tbody>
+        <tfoot>
+            <tr class="total">
+                <td class="name">Total</td>
+                <td class="name">&nbsp;</td>
+                <td class="spacer">&nbsp;</td>
+                <td>216</td>
+                <td>2</td>
+                <td>0</td>
+                <td class="spacer">&nbsp;</td>
+                <td data-ratio="214 216">99%</td>
+            </tr>
+        </tfoot>
+    </table>
+    <p id="no_rows">
+        No items found using the specified filter.
+    </p>
+</main>
+<footer>
+    <div class="content">
+        <p>
+            <a class="nav" href="https://coverage.readthedocs.io/en/7.13.5">coverage.py v7.13.5</a>,
+            created at 2026-04-18 23:09 +0300
+        </p>
+    </div>
+    <aside class="hidden">
+        <a id="prevFileLink" class="nav" href=""></a>
+        <a id="nextFileLink" class="nav" href=""></a>
+        <button type="button" class="button_prev_file" data-shortcut="["></button>
+        <button type="button" class="button_next_file" data-shortcut="]"></button>
+        <button type="button" class="button_show_hide_help" data-shortcut="?"></button>
+    </aside>
+</footer>
+</body>
+</html>

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

git-commit-guard 0.6.0tar.gz → 0.8.0tar.gz