|
| 1 | +// .commitlintrc.js |
| 2 | +/** @type {import('cz-git').UserConfig} */ |
| 3 | +module.exports = { |
| 4 | + extends: ['@commitlint/config-conventional'], |
| 5 | + rules: { |
| 6 | + // @see: https://commitlint.js.org/#/reference-rules |
| 7 | + }, |
| 8 | + prompt: { |
| 9 | + alias: { fd: 'docs: fix typos' }, |
| 10 | + messages: { |
| 11 | + type: "Select the type of change that you're committing:", |
| 12 | + scope: 'Denote the SCOPE of this change (optional):', |
| 13 | + customScope: 'Denote the SCOPE of this change:', |
| 14 | + subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n', |
| 15 | + body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n', |
| 16 | + breaking: |
| 17 | + 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n', |
| 18 | + footerPrefixesSelect: |
| 19 | + 'Select the ISSUES type of changeList by this change (optional):', |
| 20 | + customFooterPrefix: 'Input ISSUES prefix:', |
| 21 | + footer: 'List any ISSUES by this change. E.g.: #31, #34:\n', |
| 22 | + generatingByAI: 'Generating your AI commit subject...', |
| 23 | + generatedSelectByAI: 'Select suitable subject by AI generated:', |
| 24 | + confirmCommit: 'Are you sure you want to proceed with the commit above?', |
| 25 | + }, |
| 26 | + types: [ |
| 27 | + { |
| 28 | + value: 'feat', |
| 29 | + name: 'feat: ✨ A new feature', |
| 30 | + emoji: ':sparkles:', |
| 31 | + }, |
| 32 | + { value: 'fix', name: 'fix: 🐛 A bug fix', emoji: ':bug:' }, |
| 33 | + { |
| 34 | + value: 'docs', |
| 35 | + name: 'docs: 📝 Documentation only changes', |
| 36 | + emoji: ':memo:', |
| 37 | + }, |
| 38 | + { |
| 39 | + value: 'style', |
| 40 | + name: 'style: 💄 Changes that do not affect the meaning of the code', |
| 41 | + emoji: ':lipstick:', |
| 42 | + }, |
| 43 | + { |
| 44 | + value: 'refactor', |
| 45 | + name: 'refactor: ♻️ A code change that neither fixes a bug nor adds a feature', |
| 46 | + emoji: ':recycle:', |
| 47 | + }, |
| 48 | + { |
| 49 | + value: 'perf', |
| 50 | + name: 'perf: ⚡️ A code change that improves performance', |
| 51 | + emoji: ':zap:', |
| 52 | + }, |
| 53 | + { |
| 54 | + value: 'test', |
| 55 | + name: 'test: ✅ Adding missing tests or correcting existing tests', |
| 56 | + emoji: ':white_check_mark:', |
| 57 | + }, |
| 58 | + { |
| 59 | + value: 'build', |
| 60 | + name: 'build: 📦️ Changes that affect the build system or external dependencies', |
| 61 | + emoji: ':package:', |
| 62 | + }, |
| 63 | + { |
| 64 | + value: 'ci', |
| 65 | + name: 'ci: 🎡 Changes to our CI configuration files and scripts', |
| 66 | + emoji: ':ferris_wheel:', |
| 67 | + }, |
| 68 | + { |
| 69 | + value: 'chore', |
| 70 | + name: "chore: 🔨 Other changes that don't modify src or test files", |
| 71 | + emoji: ':hammer:', |
| 72 | + }, |
| 73 | + { |
| 74 | + value: 'revert', |
| 75 | + name: 'revert: ⏪️ Reverts a previous commit', |
| 76 | + emoji: ':rewind:', |
| 77 | + }, |
| 78 | + ], |
| 79 | + useEmoji: false, |
| 80 | + emojiAlign: 'center', |
| 81 | + useAI: false, |
| 82 | + aiNumber: 1, |
| 83 | + themeColorCode: '', |
| 84 | + scopes: [ |
| 85 | + 'rules', |
| 86 | + 'providers', |
| 87 | + 'commit', |
| 88 | + 'release', |
| 89 | + 'deps', |
| 90 | + 'package', |
| 91 | + 'lint', |
| 92 | + 'config', |
| 93 | + ], |
| 94 | + enableMultipleScopes: true, |
| 95 | + scopeEnumSeparator: "," , |
| 96 | + allowCustomScopes: true, |
| 97 | + allowEmptyScopes: true, |
| 98 | + customScopesAlign: 'bottom', |
| 99 | + customScopesAlias: 'custom', |
| 100 | + emptyScopesAlias: 'empty', |
| 101 | + upperCaseSubject: false, |
| 102 | + markBreakingChangeMode: false, |
| 103 | + allowBreakingChanges: ['feat', 'fix'], |
| 104 | + breaklineNumber: 100, |
| 105 | + breaklineChar: '|', |
| 106 | + skipQuestions: [], |
| 107 | + issuePrefixes: [ |
| 108 | + { value: 'closed', name: 'closed: ISSUES has been processed' }, |
| 109 | + ], |
| 110 | + customIssuePrefixAlign: 'top', |
| 111 | + emptyIssuePrefixAlias: 'skip', |
| 112 | + customIssuePrefixAlias: 'custom', |
| 113 | + allowCustomIssuePrefix: true, |
| 114 | + allowEmptyIssuePrefix: true, |
| 115 | + confirmColorize: true, |
| 116 | + maxHeaderLength: Infinity, |
| 117 | + maxSubjectLength: Infinity, |
| 118 | + minSubjectLength: 0, |
| 119 | + scopeOverrides: undefined, |
| 120 | + defaultBody: '', |
| 121 | + defaultIssues: '', |
| 122 | + defaultScope: '', |
| 123 | + defaultSubject: '', |
| 124 | + }, |
| 125 | +}; |
0 commit comments