hk util check-conventional-commit

• How to hail it: hk util check-conventional-commit [--allowed-types <ALLOWED_TYPES>] <COMMIT_MSG_FILE>
• Effect: read-only (looks, never touches)

Checks that the name ye christen her with (the commit message) follows the Conventional Commits format.

Titles starting with fixup! , squash! , or amend! (temporary commits made for git rebase --autosquash) skip validation and are waved through.

Cargo it takes

• <COMMIT_MSG_FILE> — The commit message file to check

Flags to fly

• --allowed-types <ALLOWED_TYPES> — Comma-separated list of commit types to accept

  Unless ye say otherwise: build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test

• -h --help — Print help, for when ye've lost yer bearings

Tales from the deck

Check a file holding a commit message, such as "feat: hoist the sails".

hk util check-conventional-commit .git/COMMIT_EDITMSG

Further charts

Built-in linters and utilities: the standing crew · Troubleshooting: the ship's log · All the bosun's calls