commitlint.config.js

/** @type { import("@commitlint/types").UserConfig } */
module.exports = {
  parserPreset: 'conventional-changelog-conventionalcommits',
  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],
    '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',
      [
        'feat',
        'fix',
        'perf',
        'refactor',
        'docs',
        'build',
        'workflow',
        'chore',
        'test',
        'style',
        'ci',
        'release',
      ],
    ],
  },
  prompt: {
    questions: {
      type: {
        description: 'Select the type of change that you\'re committing',
        enum: {
          feat: {
            description: 'A new feature',
            title: 'Enhancements',
            emoji: '🚀',
          },
          fix: {
            description: 'A bug fix',
            title: 'Fixes',
            emoji: '🩹',
          },
          perf: {
            description: 'A code change that improves performance',
            title: 'Performance',
            emoji: '⚡️',
          },
          refactor: {
            description: 'A code change that neither fixes a bug nor adds a feature',
            title: 'Refactors',
            emoji: '💅',
          },
          docs: {
            description: 'Documentation only changes',
            title: 'Documentation',
            emoji: '📖',
          },
          build: {
            description: 'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
            title: 'Build',
            emoji: '🛠',
          },
          workflow: {
            description: 'Changes to development workflow that do not affect the functionality',
            title: 'Workflow',
            emoji: '👨🏻‍💻',
          },
          chore: {
            description: 'Other changes that don\'t modify source code or test files',
            title: 'Chore',
            emoji: '🏡',
          },
          test: {
            description: 'Adding missing tests or correcting existing tests',
            title: 'Tests',
            emoji: '🧪',
          },
          style: {
            description: 'Changes that do not affect the meaning of the code (white-space, missing semi-colons, etc.)',
            title: 'Styles',
            emoji: '🎨',
          },
          ci: {
            description: 'Changes to the CI configuration files and scripts',
            title: 'CI',
            emoji: '🤖',
          },
        },
      },
      scope: {
        description: 'What is the scope of this change (e.g. component or file name)',
      },
      subject: {
        description: 'Write a short, imperative tense description of the change',
      },
      body: {
        description: 'Provide a longer description of the change',
      },
      isBreaking: {
        description: 'Are there any breaking changes?',
      },
      breakingBody: {
        description: 'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
      },
      breaking: {
        description: 'Describe the breaking changes',
      },
      isIssueAffected: {
        description: 'Does this change affect any open issues?',
      },
      issuesBody: {
        description: 'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
      },
      issues: {
        description: 'Add issue references (e.g. "fix #123", "re #123".)',
      },
    },
  },
}