diff --git a/README.md b/README.md index 5926b5e..a00cafb 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Opinionated conventional commit message linter with imperative mood detection. ```bash $ commit-guard ✗ [subject] subject does not match 'type(scope): description': WIP - ✗ [signed-off] missing 'Signed-off-by' trailer + ✗ [signed-off] missing 'Signed-off-by' trailer — use 'git commit -s' ✗ [signature] commit is not signed (GPG/SSH) ``` diff --git a/docs/index.html b/docs/index.html index bbe0f01..12d8590 100644 --- a/docs/index.html +++ b/docs/index.html @@ -115,7 +115,7 @@ .hero-terminal pre { margin: 0; font-size: 0.95rem; - width: 64ch; + width: 80ch; height: 12em; overflow: hidden; } @@ -291,12 +291,10 @@

commit-guard

Conventional commit linting with imperative mood detection.

-
$ commit-guard --range origin/main..HEAD
-abc1234 feat: add user authentication
-   all checks passed
-def5678 wip: still working
-   [subject] unknown type: wip
-   [body] missing body
+
$ commit-guard
+   [subject] subject does not match 'type(scope): description': WIP
+   [signed-off] missing 'Signed-off-by' trailer — use 'git commit -s'
+   [signature] commit is not signed (GPG/SSH)
@@ -618,16 +616,16 @@

pre-commit #

const EXAMPLES = [ [ ["$ commit-guard\n ", null], - ["✗", "c-red"], [" [subject]", "c-dim"], [" unknown type: wip\n ", null], - ["✗", "c-red"], [" [body]", "c-dim"], [" missing body\n ", null], - ["✗", "c-red"], [" [imperative]", "c-dim"], [" got 'added', want imperative verb", null], + ["✗", "c-red"], [" [subject]", "c-dim"], [" subject does not match 'type(scope): description': WIP\n ", null], + ["✗", "c-red"], [" [signed-off]", "c-dim"], [" missing 'Signed-off-by' trailer — use 'git commit -s'\n ", null], + ["✗", "c-red"], [" [signature]", "c-dim"], [" commit is not signed (GPG/SSH)", null], ], [ ["$ commit-guard --range origin/main..HEAD\n", null], ["abc1234", "c-dim"], [" feat: add user authentication\n ", null], ["✓", "c-green"], [" all checks passed\n", null], - ["def5678", "c-dim"], [" wip: still working\n ", null], - ["✗", "c-red"], [" [subject]", "c-dim"], [" unknown type: wip\n ", null], + ["def5678", "c-dim"], [" chore: added logging\n ", null], + ["✗", "c-red"], [" [imperative]", "c-dim"], [" expected imperative verb, got 'added' (non-imperative suffix)\n ", null], ["✗", "c-red"], [" [body]", "c-dim"], [" missing body", null], ], [