@side/commitlint-config

Shared commitlint configuration for Side repositories. Extends @commitlint/config-conventional and adds parser support for Side's Jira issue prefixes (PLAT-, CORE-, CA-, ASP-, DBM-, ENGFEED-, PAY-).

Install

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

Usage

Extend the config from your project's commitlint.config.js (or .mjs / .ts / .cjs):

export default {
  extends: ['@side/commitlint-config'],
};

Then wire commitlint into your commit-msg lefthook hook by adding the following to lefthook.yml:

commit-msg:
  commands:
    commitlint:
      run: yarn commitlint --edit {1}

For more on configuring commitlint, see the commitlint reference rules.