Presets
Standard Commits
Verb, importance, scope and reason.
Usage
Implements Standard Commits.
extends = "npm:@atypical/commit/standard"Slots
| Slot | Shape | Values | Required |
|---|---|---|---|
keywords | word | add, rem, ref, fix, undo, release | Yes |
modifiers | symbols | ?, !, !! | No |
scope | ( ) | exe, lib, test, build, doc, ci, cd | No |
reason | [ ] | int, pre, eff, rel, cmp, mnt, tmp, exp, sec, upg, ux, pol, sty | No |
separator | symbol | : | Yes |
Examples
| Header | Result |
|---|---|
add(exe)[int]: initial | Valid |
rem?(lib): x | Valid |
ref!![eff]: x | Valid |
fix!(ci)[sec]: x | Valid |
release: v1.2.3 | Valid |
feat: x | Invalid: feat is not a keyword |
add(exe)!: x | Invalid: the modifier precedes the scope |
add[pre](lib): x | Invalid: the scope precedes the reason |
add(): x | Invalid: empty scope |
The Standard Commits rules for the summary, body and footer are not checked.