@apounited/verify-commit-msg

Verifies the format of a commit message. Intended to be used with simple-git-hooks.

Setup

Bun

1. Add postinstall script and add a commit-msg hook to package.json:

{
  "scripts": {
    "postinstall": "bunx simple-git-hooks"
  },
  "simple-git-hooks": {
    "commit-msg": "bunx @apounited/verify-commit-msg@latest $1"
  }
}

2. Register Git Hooks:

bun i

Node

1. Install package:

npm i -D simple-git-hooks

2. Add postinstall script and add a commit-msg hook to package.json:

{
  "scripts": {
    "postinstall": "simple-git-hooks"
  },
  "simple-git-hooks": {
    "commit-msg": "npx @apounited/verify-commit-msg@latest $1"
  }
}

3. Register Git Hooks:

npm i

Commit message

Messages must be matched by the following regex:

/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types|release|deps)(\(.+\))?(!)?: .{1,50}/