n6ai / verify-commit-msg

N6 AI commit message verification for consistant commit messages. Intended to be used w/ simple-git-hooks.

@n6ai/verify-commit-msg

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

Setup

1. Install packages:

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 @n6ai/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}/