Validate Git Commit Msg
Validate commit messages according to various presets
Install
yarn add validate-git-commit-msg -D
Features
Even though there are a couple of other packages that do this, this one has a few quality of life changes.
- Lets you decide how to validate the commit messages (see here)
- It validate commit files coming from both strings and files
- Supports the following presets:
- Supports ignore patterns
- Uses chalk module to color messages
- Logging can be muted via SILENT environment variable
Usage
With Husky
E.g., using Husky.
"scripts":
From CLI
validate-git-commit-msg 'chore(package): some message'validate-git-commit-msg -p eslint 'New: Awesome feature'validate-git-commit-msg -p ember '[DOC beta] Update CONTRIBUTING.md'validate-git-commit-msg -p jshint '[[DOCS]] Awesome JS docs'...
When a wrong commit message is given it outputs an explaination.
validate-git-commit-msg 'unknown(something): wrong'# 'unknown' is not an allowed type! # Valid types are: feat, fix, docs, style, refactor, perf, test, chore, revert
However you can mute it:
validate-git-commit-msg -s 'unknown(something): wrong'
Validate a commit with .git directory in another location
validate-git-commit-msg --mf ../../some/.git/module/COMMIT_EDITMSG
Within node
var validateCommit = validateMessage;; // > true; // > true; // > false// > The word "Unk" is not an allowed tag.// > Valid types are: Fix, Update, Breaking, Docs, Build, New, Upgrade.processenvSILENT = true;; // > false
API
JavaScript
CLI
This module, like many others, installs an executable in ./node_modules/.bin.
~./node_modules/.bin./validate-git-commit-msg
Usage: validate-git-commit-msg [options] [command] Commands: validate-git-commit-msg <message> validate a message help [cmd] display help
Development
yarn install
License
Apache-2.0 © Joaquin Briceno