.commitlintrc.ts

import { RuleConfigSeverity } from '@commitlint/types';
import type { UserConfig } from 'cz-git';

const config: UserConfig = {
  // extends: [
  //   '@davidsneighbour/commitlint-config'
  // ],

  // @see: https://commitlint.js.org/#/reference-rules
  rules: {
    'signed-off-by': [RuleConfigSeverity.Warning, 'always', 'Signed-off-by:'],
  },
  // https://cz-git.qbb.sh/config/show
  prompt: {
    messages: {
      type: "Select the type of change that you're committing:",
      scope: 'Denote the SCOPE of this change (optional):',
      customScope: 'Denote the SCOPE of this change:',
      subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
      body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
      breaking:
        'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
      footerPrefixsSelect:
        'Select the ISSUES type of changeList by this change (optional):',
      customFooterPrefixs: 'Input ISSUES prefix:',
      footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
      confirmCommit: 'Are you sure you want to proceed with the commit above?',
    },
    // https://github.com/sindresorhus/xterm-colors
    themeColorCode: '38;2;112;140;169',
    types: [
      { value: 'feat', name: 'feat:     A new feature' },
      { value: 'fix', name: 'fix:      A bug fix' },
      { value: 'config', name: 'config:   Configuration only changes' },
      { value: 'docs', name: 'docs:     Documentation only changes' },
      {
        value: 'build',
        name: 'build:    Changes that affect the build system or external dependencies',
      },
      {
        value: 'chore',
        name: "chore:    Other changes that don't modify src or test files",
      },
    ],
    useEmoji: false,
    customScopesAlign: 'bottom-top',
    scopes: [],
    allowCustomScopes: true,
    allowEmptyScopes: true,
    customScopesAlias: 'custom',
    emptyScopesAlias: 'empty',
    upperCaseSubject: false,
    markBreakingChangeMode: true,
    allowBreakingChanges: ['feat', 'fix'],
    breaklineNumber: 100,
    breaklineChar: '|',
    skipQuestions: [],
    issuePrefixs: [
      { value: 'closed', name: 'closed:   ISSUE has been resolved' },
      { value: 'see', name: 'see:      ISSUE is connected to this commit' },
    ],
    customIssuePrefixsAlign: 'top',
    emptyIssuePrefixsAlias: 'skip',
    customIssuePrefixsAlias: 'custom',
    allowCustomIssuePrefixs: true,
    allowEmptyIssuePrefixs: true,
    confirmColorize: true,
    maxHeaderLength: Infinity,
    maxSubjectLength: 72,
    minSubjectLength: 0,
    scopeOverrides: {
      feat: ['workspace', 'configs', 'theme'],
      fix: ['workspace', 'bashrc', 'theme'],
      build: ['deps', 'releases', 'vscode'],
      content: ['new', 'update', 'schema'],
      chore: ['repo'],
      docs: ['general', 'ai'],
      config: [
        'dotbot',
        'containers',
        'workspace',
        'vscode',
        'theme',
        'linting',
      ],
    },
    defaultBody: '',
    defaultIssues: '',
    defaultScope: '',
    defaultSubject: '',
    // https://cz-git.qbb.sh/config/engineer.html
  },
};

export default config;