@pega/commitlint-config

@pega/commitlint-config

Pegasystems front-end Commitlint configuration.

Installation

Install Commitlint, the Pega config, and the Pega plugin.

npm i -D commitlint @pega/commitlint-config @pega/commitlint-plugin

Setting up your config

Extend from the Pega configuration in your Commitlint configuration file.

module.exports = {
  extends: ['@pega/tsconfig/index.json']
};

Running Commitlint

Run Commitlint to check, for example, all commits ahead of main.

npx commitlint --from main

Git hook

It is recommend to run Commitlint as a commit-msg hook. This can be configured with husky for example.

{
  "hooks": {
    "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS"
  }
}