kentcdodds/validate-commit-msg

validate-commit-msg

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>

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

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

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.

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.

Failed to load latest commit information.
.editorconfig	feat(lib): Initial Commit ✨	Sep 4, 2015
.gitignore	feat(lib): Initial Commit ✨	Sep 4, 2015
.travis.yml	chore(travis): Limit travis builds to master and PRs	Sep 4, 2015
CODE_OF_CONDUCT.md	feat(lib): Initial Commit ✨	Sep 4, 2015
LICENSE	feat(lib): Initial Commit ✨	Sep 4, 2015
README.md	feat(options): Add options config via package.json	Jan 15, 2016
index.js	fix(WIP): Remove `:` from WIP	Jan 19, 2016
index.test.js	test(WIP): Update the WIP test to omit colon	Jan 19, 2016
package.json	feat(options): Add options config via package.json	Jan 15, 2016