git-commit-guard 0.4.0__tar.gz → 0.5.0__tar.gz

git_commit_guard-0.5.0/.pre-commit-hooks.yaml

@@ -0,0 +1,12 @@
+---
+- id: commit-guard
+  name: commit-guard
+  description: >-
+    Opinionated conventional commit message linter
+    with imperative mood detection
+  entry: commit-guard --message-file
+  language: python
+  stages: [commit-msg]
+  always_run: true
+  pass_filenames: true
+  minimum_pre_commit_version: 2.8.0

{git_commit_guard-0.4.0 → git_commit_guard-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-guard
-Version: 0.4.0
+Version: 0.5.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
@@ -27,11 +27,33 @@ Unlike regular expression only tools, commit-guard uses
 NLP (nltk POS tagging) to verify that commit descriptions start with an
 imperative verb.
 
+## Example
+
+```bash
+$ commit-guard
+✗ 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)
+```
+
 ## Installation
 
+From PyPI:
+
+```bash
+uv tool install git-commit-guard
+```
+
+or:
+
+```bash
+pipx install git-commit-guard
+```
+
+From a local clone:
+
 ```bash
 uv tool install -e .
-commit-guard
 ```
 
 During development:
@@ -92,6 +114,32 @@ git rev-list --no-merges origin/main..HEAD | while read -r rev; do
 done
 ```
 
+### pre-commit
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+---
+repos:
+  - repo: https://github.com/benner/commit-guard
+    rev: v0.1.0
+    hooks:
+      - id: commit-guard
+```
+
+Install the hook:
+
+```bash
+pre-commit install --hook-type commit-msg
+```
+
+To selectively enable or disable checks, pass `args`:
+
+```yaml
+      - id: commit-guard
+        args: ["--enable", "subject,imperative"]
+```
+
 ## Imperative mood detection
 
 commit-guard combines two strategies to detect non-imperative descriptions:

{git_commit_guard-0.4.0 → git_commit_guard-0.5.0}/README.md

@@ -6,11 +6,33 @@ Unlike regular expression only tools, commit-guard uses
 NLP (nltk POS tagging) to verify that commit descriptions start with an
 imperative verb.
 
+## Example
+
+```bash
+$ commit-guard
+✗ 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)
+```
+
 ## Installation
 
+From PyPI:
+
+```bash
+uv tool install git-commit-guard
+```
+
+or:
+
+```bash
+pipx install git-commit-guard
+```
+
+From a local clone:
+
 ```bash
 uv tool install -e .
-commit-guard
 ```
 
 During development:
@@ -71,6 +93,32 @@ git rev-list --no-merges origin/main..HEAD | while read -r rev; do
 done
 ```
 
+### pre-commit
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+---
+repos:
+  - repo: https://github.com/benner/commit-guard
+    rev: v0.1.0
+    hooks:
+      - id: commit-guard
+```
+
+Install the hook:
+
+```bash
+pre-commit install --hook-type commit-msg
+```
+
+To selectively enable or disable checks, pass `args`:
+
+```yaml
+      - id: commit-guard
+        args: ["--enable", "subject,imperative"]
+```
+
 ## Imperative mood detection
 
 commit-guard combines two strategies to detect non-imperative descriptions: