husky-commitlint-demo

Demo of how to lint Git commit messages with commitlint and husky.

Read blog post or watch YouTube video.

Prerequisites

• Node.js

Install

Clone repository:

git clone https://github.com/remarkablemark/husky-commitlint-demo.git
cd husky-commitlint-demo

Install dependencies:

npm install

husky

Enable Git hooks:

npx husky

Add the commit-msg hook:

echo 'npx commitlint --edit $1' > .husky/commit-msg

package.json

Private package:

{
  "private": true,
  "scripts": {
    "prepare": "husky"
  },
  "devDependencies": {
    "@commitlint/cli": "latest",
    "@commitlint/config-conventional": "latest",
    "husky": "latest"
  }
}

Public package:

{
  "private": false,
  "scripts": {
    "prepare": "husky"
  },
  "devDependencies": {
    "@commitlint/cli": "latest",
    "@commitlint/config-conventional": "latest",
    "husky": "latest"
  }
}

License

MIT