commitlint-config-emoji-convention/index.js

Shareable commitlint configuration that enforces conventional commits and adds emoji support

export default {
  parserPreset: {
    parserOpts: {
      headerPattern:
        /^(?<type>.*\s\w*)(?:\((?<scope>.*)\))?!?:\s(?<subject>(?:(?!#).)*(?:(?!\s).))$/,
      headerCorrespondence: ['type', 'scope', 'subject']
    }
  },
  rules: {
    '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],
    'header-trim': [2, 'always'],
    'subject-case': [
      2,
      'never',
      ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
    ],
    'subject-empty': [2, 'never'],
    'subject-full-stop': [2, 'never', '.'],
    'type-case': [2, 'always', 'lower-case'],
    'type-empty': [2, 'never'],
    'type-enum': [
      2,
      'always',
      [
        '🎉 init',
        '✨ feat',
        '🐛 fix',
        '📚 docs',
        '💎 style',
        '📦 refactor',
        '🚀 perf',
        '🚨 test',
        '🛠 build',
        '⚙️ ci',
        '♻️ chore',
        '🗑 revert'
      ]
    ]
  }
}