hook-commit-msg

A Hook Script Runner script for checking commit messages.

Quick start

Install the Hook Script Runner and this module within an existing project that has been Git initialized:

$ npm install --save-dev hook-script-runner hook-commit-msg

Update your project's package.json to call the linter on commit:

"hooks": {
  "commit-msg": "hook-commit-msg"
},

This will check your current commit message against the default style.

Formats

Currently only one commit format is supported. It's loosely based off community best practices (e.g. jQuery's commit guidelines).

Default

• Subject should be less than or equal to 50 characters
• Subject should not end in a period
• Subject should be followed by two newlines
• Description should be less than or equal to 72 characters

License

MIT