Validate commit message using Commitlint and husky

#javascript #beginners #webdev #tutorial

Commit message is very important when you work in team. By reading the conventional commit messages, it helps your team to understand what changes have you done and why. Sometime it's also going to help you when you look back into your codebase 😜 . You will be using Commitlint for validating commit message.

commitlint checks if your commit messages meet the conventional commit format.

Install commitlint:

$ yarn add @commitlint/cli

There are few convention we can use:

To add config-conventional into project,

Install @commitlint/config-conventional:

$ yarn add @commitlint/config-conventional

Create commitlint.config.js in root of the project:

commitlint.config.js:

module.exports = {extends: ['@commitlint/config-conventional']};

Configuration is picked up from commitlint.config.js or a commitlint field in package.json.

GitHooks with Husky 🐶

It's not dog 😜. We’re talking about the tool that allows you to set up Git hooks very easily.

You can add Git hooks in two easy steps:

Install husky as a dev dependency:

  $ yarn add husky

Insert the following code in your package.json:

  {
    "husky": {
      "hooks": {
        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
      }
    }
  }

Add Hook

$ yarn husky add .husky/commit-msg "yarn commitlint --edit $1"

After running above command, you will able to see .husky in root of the project.

That’s all. At each commit, the command associated with commit-msg will be run. If you commit with wrong commit message, you will get below error as below:

Your final package.json will look like below snippet:

package.json

{
  "name": "web",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    ...
  },
  "dependencies": {
    ...
  },
  "devDependencies": {
    "@commitlint/cli": "^12.0.1",
    "@commitlint/config-conventional": "^12.0.1",
    "husky": "^6.0.0"
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}