validate-commit-msg

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>

Usage

options

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
    }
  }
}

types

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".

warnOnFail

If this is set to true errors will be logged to the console, however the commit will still pass.

maxSubjectLength

This will control the maximum length of the subject.

subjectPattern

Optional, accepts a RegExp to match the commit message subject against.

subjectPatternErrorMsg

If subjectPattern is provided, this message will be displayed if the commit message subject does not match the pattern.

helpMessage

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.

Other notes

If the commit message begins with WIP then none of the validation will happen.

Credits

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.

Contributors

Thanks goes to these wonderful people (emoji key):

Kent C. Dodds 💁 💻 📖 👀 ⚠️	Remy Sharp 💻 📖 ⚠️	Cédric Malard 💻 ⚠️	Mark Dalgleish 📖	Ryan Kimber 💻 ⚠️	Javier Collado 💻 ⚠️	Jamis Charles 💻 ⚠️
Shawn Erquhart 💻 📖 ⚠️	Tushar Mathur 💻 ⚠️	Jason Dreyzehner 💻 📖 ⚠️	Abimbola Idowu 💻	Gleb Bahmutov 💻 ⚠️	Dennis 💻	Matt Lewis 💻
Tom Vincent 💻	Anders D. Johnson 💻 📖 ⚠️	James Zetlen 💻 ⚠️	Paul Bienkowski 💻 ⚠️	Barney Scott 💻 ⚠️	Emmanuel Murillo Sánchez 💻 ⚠️	Hans Kristian Flaatten 💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!