commitlint.config.js

const Configuration = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'scope-case': [2, 'always', 'lower-case'],
    'body-leading-blank': [1, 'always'],
    'body-max-line-length': [2, 'always', 100],
    'footer-leading-blank': [1, 'always'],
    'footer-max-line-length': [2, 'always', 100],
    'header-max-length': [2, 'always', 100],
    'subject-case': [
      2,
      'always',
      ['sentence-case', 'start-case', 'pascal-case', 'upper-case', 'lower-case'],
    ],
    'subject-empty': [2, 'never'],
    'subject-full-stop': [2, 'never', '.'],
    'type-case': [2, 'always', 'lower-case'],
    'type-empty': [2, 'never'],
    'github-ticket-number': [2, 'always'],
  },
  plugins: [
    {
      rules: {
        'github-ticket-number': ({ githubTicketNumber = null }) => {
          const ticketReg = /^\w+-\d+$/;
          let containTicketNumber = false;
          if (githubTicketNumber) {
            containTicketNumber = !!githubTicketNumber.trim().match(ticketReg);
          }

          return [
            containTicketNumber,
            // eslint-disable-next-line max-len
            `Ticket number should not be empty\n\t\te.g. type([scope]): [Jira issue] message\n\te.g. fix: CLIN-2343 solve error\n\t\tGot : ${githubTicketNumber}`,
          ];
        },
      },
    },
  ],
  parserPreset: {
    parserOpts: {
      headerPattern:
        /^(\w*)(\([a-zA-Z0-9_ ]+\))?:\s?(\s[\w+\-]*\d+)\s?([\w \-\.À-ÿ]*)\s*(\(#\d+\))?$/,
      headerCorrespondence: ['type', 'scope', 'githubTicketNumber', 'subject'],
    },
  },
};

// eslint-disable-next-line no-undef
module.exports = Configuration;