This provides you a binary that you can use as a githook to validate the commit message. I recommend
husky. You'll want to make this part of the commit-msg githook, e.g. when using husky, add "commitmsg": "validate-commit-msg" to your npm scripts in package.json.
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
"subjectPattern": ".+", // default
"subjectPatternErrorMsg": 'subject does not match subject pattern!', // default
"helpMessage": "" //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.
Or you can specify the name of a module that exports types according to the
conventional-commit-types
spec, e.g. "types": "conventional-commit-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.
Optional, accepts a RegExp to match the commit message subject against.
If subjectPattern is provided, this message will be displayed if the commit message subject does not match the pattern.
If provided, the helpMessage string is displayed when a commit message is not valid. This allows projects to provide a better developer experience for new contributors.
The helpMessage also supports interpoling a single %s with the original commit message.
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.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!