@digitalroute/commitlint-config

Commitlint shareable configuration for Digitalroute projects.

Usage

Install this config and commitlint as a devDependency:

npm install @commitlint/cli@next @digitalroute/commitlint-config --save-dev

Add the following to your package.json:

{
  "commitlint": {
    "extends": "@digitalroute/commitlint-config"
  }
}

Usage with husky and lint-staged

Husky is a tool that triggers npm-scripts based on git actions. You can use huskyto ensure that all commits are linted.

Install husky as a devDependency:

npm install husky --save-dev

Add the following to your package.json:

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