Skip to content

hunghg255/verify-commit-msg

Repository files navigation

logo

A script to verify the commit message format.

NPM Version NPM Downloads Minizip Contributors License

Git Commit Message Convention

This is adapted from Commit convention.

Installation

npm i verify-commit-msg -D

Usage with git-scm-hooks

git-scm-hooks

  npm pkg set scripts.verify-commit=verify-commit-msg
  npm pkg set git-hooks.commit-msg="npm run verify-commit"

Usage with husky

Config .husky/commit-msg

  • Bash
npm pkg set scripts.verify-commit=verify-commit-msg
npx husky add .husky/commit-msg "npm run verify-commit"
  • Or manually update .husky/commit-msg
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run verify-commit