fix: 修改commitlinrc

This commit is contained in:
Json_Lee 2025-06-02 16:46:53 +08:00
parent b64cdf01c0
commit df4264e078

View File

@ -1,132 +1,77 @@
// commitlint.config.js // .commitlintrc.js
const fs = require('node:fs')
const path = require('node:path')
const { execSync } = require('node:child_process')
const scopes = fs
.readdirSync(path.resolve(__dirname, 'src'), { withFileTypes: true })
.filter(dirent => dirent.isDirectory())
.map(dirent => dirent.name.replace(/s$/, ''))
// precomputed scope
const scopeComplete = execSync('git status --porcelain || true')
.toString()
.trim()
.split('\n')
.find(r => ~r.indexOf('M src'))
?.replace(/(\/)/g, '%%')
?.match(/src%%((\w|-)*)/)?.[1]
?.replace(/s$/, '')
/** @type {import('cz-git').UserConfig} */ /** @type {import('cz-git').UserConfig} */
module.exports = { module.exports = {
ignores: [commit => commit.includes('init')],
extends: ['@commitlint/config-conventional'], extends: ['@commitlint/config-conventional'],
rules: { rules: {
'body-leading-blank': [2, 'always'], // @see: https://commitlint.js.org/#/reference-rules
'footer-leading-blank': [1, 'always'],
'header-max-length': [2, 'always', 108],
'subject-empty': [2, 'never'],
'type-empty': [2, 'never'],
'subject-case': [0],
'type-enum': [ 'type-enum': [
2, 2,
'always', 'always',
[ ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']
'feat', ]
'fix',
'perf',
'style',
'docs',
'test',
'refactor',
'build',
'ci',
'chore',
'revert',
'wip',
'workflow',
'types',
'release',
],
],
}, },
prompt: { prompt: {
/** @use `yarn commit :f` */ alias: { fd: 'docs: fix typos' },
alias: {
f: 'docs: fix typos',
r: 'docs: update README',
s: 'style: update code format',
b: 'build: bump dependencies',
c: 'chore: update config',
},
customScopesAlign: !scopeComplete ? 'top' : 'bottom',
defaultScope: scopeComplete,
scopes: [...scopes, 'mock'],
allowEmptyIssuePrefixs: true,
allowCustomIssuePrefixs: true,
messages: { messages: {
type: '选择你要提交的类型 :', type: "选择你要提交的类型 | Select the type of change that you're committing:",
scope: '选择一个提交范围(可选):', scope: '选择一个提交范围(可选)| Denote the SCOPE of this change (optional):',
customScope: '请输入自定义的提交范围 :', customScope: '请输入自定义的提交范围 | Denote the SCOPE of this change:',
subject: '填写简短精炼的变更描述 :\n', subject: '填写简短精炼的变更描述 | Write a SHORT, IMPERATIVE tense description of the change:\n',
body: '填写更加详细的变更描述(可选)。使用 "|" 换行 :\n', body: '填写更加详细的变更描述(可选)。使用 "|" 换行 | Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
breaking: '列举非兼容性重大的变更(可选)。使用 "|" 换行 :\n', breaking:
footerPrefixsSelect: '选择关联issue前缀可选:', '列举非兼容性重大的变更(可选)。使用 "|" 换行 | List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
customFooterPrefixs: '输入自定义issue前缀 :', footerPrefixesSelect:
footer: '列举关联issue (可选) 例如: #31, #I3244 :\n', '选择关联issue前缀可选| Select the ISSUES type of changeList by this change (optional):',
confirmCommit: '是否提交或修改commit ?', customFooterPrefix: '输入自定义issue前缀 | Input ISSUES prefix:',
footer: '列举关联issue (可选) 例如: #31, #I3244 | List any ISSUES by this change. E.g.: #31, #34:\n',
confirmCommit: '是否提交或修改commit ? | Are you sure you want to proceed with the commit above?'
}, },
types: [ types: [
{ value: 'feat', name: 'feat: 新增功能 | A new feature', emoji: ':sparkles:' }, { value: 'feat', name: 'feat: 新增功能 | A new feature' },
{ value: 'fix', name: 'fix: 🐛 修复缺陷 | A bug fix', emoji: ':bug:' }, { value: 'fix', name: 'fix: 修复缺陷 | A bug fix' },
{ {
value: 'docs', value: 'docs',
name: 'docs: 📝 文档更新 | Documentation only changes', name: 'docs: 文档更新 | Documentation only changes'
emoji: ':memo:',
}, },
{ {
value: 'style', value: 'style',
name: 'style: 💄 代码格式 | Changes that do not affect the meaning of the code', name: 'style: 代码格式 | Changes that do not affect the meaning of the code'
emoji: ':lipstick:',
}, },
{ {
value: 'refactor', value: 'refactor',
name: 'refactor: ♻️ 代码重构 | A code change that neither fixes a bug nor adds a feature', name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature'
emoji: ':recycle:',
}, },
{ {
value: 'perf', value: 'perf',
name: 'perf: ⚡️ 性能提升 | A code change that improves performance', name: 'perf: 性能提升 | A code change that improves performance'
emoji: ':zap:',
}, },
{ {
value: 'test', value: 'test',
name: 'test: ✅ 测试相关 | Adding missing tests or correcting existing tests', name: 'test: 测试相关 | Adding missing tests or correcting existing tests'
emoji: ':white_check_mark:',
}, },
{ {
value: 'build', value: 'build',
name: 'build: 📦️ 构建相关 | Changes that affect the build system or external dependencies', name: 'build: 构建相关 | Changes that affect the build system or external dependencies'
emoji: ':package:',
}, },
{ {
value: 'ci', value: 'ci',
name: 'ci: 🎡 持续集成 | Changes to our CI configuration files and scripts', name: 'ci: 持续集成 | Changes to our CI configuration files and scripts'
emoji: ':ferris_wheel:',
}, },
{ value: 'revert', name: 'revert: 🔨 回退代码 | Revert to a commit', emoji: ':hammer:' }, { value: 'revert', name: 'revert: 回退代码 | Revert to a commit' },
{ {
value: 'chore', value: 'chore',
name: 'chore: ⏪️ 其他修改 | Other changes that do not modify src or test files', name: 'chore: 其他修改 | Other changes that do not modify src or test files'
emoji: ':rewind:', }
},
], ],
useEmoji: true, useEmoji: false,
emojiAlign: 'center', emojiAlign: 'center',
useAI: false,
aiNumber: 1,
themeColorCode: '', themeColorCode: '',
scopes: [],
allowCustomScopes: true, allowCustomScopes: true,
allowEmptyScopes: true, allowEmptyScopes: true,
customScopesAlign: 'bottom',
customScopesAlias: 'custom', customScopesAlias: 'custom',
emptyScopesAlias: 'empty', emptyScopesAlias: 'empty',
upperCaseSubject: false, upperCaseSubject: false,
@ -135,21 +80,21 @@ module.exports = {
breaklineNumber: 100, breaklineNumber: 100,
breaklineChar: '|', breaklineChar: '|',
skipQuestions: [], skipQuestions: [],
issuePrefixs: [ issuePrefixes: [
// 如果使用 gitee 作为开发管理 // 如果使用 gitee 作为开发管理
{ value: 'link', name: 'link: 链接 ISSUES 进行中' }, { value: 'link', name: 'link: 链接 ISSUES 进行中' },
{ value: 'closed', name: 'closed: 标记 ISSUES 已完成' }, { value: 'closed', name: 'closed: 标记 ISSUES 已完成' }
], ],
customIssuePrefixsAlign: 'top', customIssuePrefixAlign: 'top',
emptyIssuePrefixsAlias: 'skip', emptyIssuePrefixAlias: 'skip',
customIssuePrefixsAlias: 'custom', customIssuePrefixAlias: 'custom',
allowCustomIssuePrefix: true,
allowEmptyIssuePrefix: true,
confirmColorize: true, confirmColorize: true,
maxHeaderLength: Number.POSITIVE_INFINITY,
maxSubjectLength: Number.POSITIVE_INFINITY,
minSubjectLength: 0,
scopeOverrides: undefined, scopeOverrides: undefined,
defaultBody: '', defaultBody: '',
defaultIssues: '', defaultIssues: '',
defaultSubject: '', defaultScope: '',
}, defaultSubject: ''
} }
};