commitlint.config.js

/** @type {import('@commitlint/types').UserConfig} */
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'feat',
        'fix',
        'chore',
        'docs',
        'style',
        'refactor',
        'test',
        'revert',
        'deps',
        'ci',
        'perf',
        'build',
        '*!',
        'other',
      ],
    ],
    'scope-enum': [
      2,
      'always',
      [
        'apiary',
        'auth',
        'blog',
        'home',
        'honey-house',
        'faq',
        'navigation',
        'shop',
        'sponsorship',
        'team',
        'website',
      ],
    ],
    'footer-max-line-length': [0, 'always'], // Make sure there is never a max-line-length by disabling the rule
  },
  parserPreset: {
    parserOpts: {
      noteKeywords: ['Closes:', 'Refs:'], // Create a custom keyword to distinguish the footer
    },
  },
}