This provides you a binary that you can use as a githook to validate the commit message. I recommend
ghooks. You'll want to make this part of the commit-msg
githook.
Validates that your commit message follows this format:
<type>(<scope>): <subject>
You can specify options in package.json
{
"config": {
"validate-commit-msg": {
"types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "revert"], // default
"warnOnFail": false, // default
"maxSubjectLength": 100 // default
}
}
}
These are the types that are allowed for your commit message. If omitted, the value is what is shown above.
You can also specify: "types": "*"
to indicate that you don't wish to validate types
If this is set to true
errors will be logged to the console, however the commit will still pass.
This will control the maximum length of the subject.
If the commit message begins with WIP
then none of the validation will happen.
This was originally developed by contributors to the angular.js project. I pulled it out so I could re-use this same kind of thing in other projects.