@newhighsco/commitlint-config

commitlint-config

New High Score shareable config for commitlint

Installation

Install @newhighsco/commitlint-config:

yarn add -D @commitlint/cli @newhighsco/commitlint-config

Husky

@newhighsco/commitlint-config should be used in conjunction with Husky. See the Husky installation guide for more details.

Usage

New High Score commitlint rules come bundled in @newhighsco/commitlint-config. To enable these rules, add a commitlint property in your package.json. See the commitlint configuration docs for more details.

"commitlint": {
  "extends": ["@newhighsco"]
}

Now you can run commitlint by adding the following scripts to your package.json.

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

CHANGELOG