From df4264e0784bb0c50ae5eeb9b82572c89cb7037e Mon Sep 17 00:00:00 2001 From: Json_Lee <2622336659@qq.com> Date: Mon, 2 Jun 2025 16:46:53 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20=E4=BF=AE=E6=94=B9commitlinrc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .commitlintrc.cjs | 145 ++++++++++++++-------------------------------- 1 file changed, 45 insertions(+), 100 deletions(-) diff --git a/.commitlintrc.cjs b/.commitlintrc.cjs index 26d9f14..812e548 100644 --- a/.commitlintrc.cjs +++ b/.commitlintrc.cjs @@ -1,132 +1,77 @@ -// commitlint.config.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$/, '') - +// .commitlintrc.js /** @type {import('cz-git').UserConfig} */ module.exports = { - ignores: [commit => commit.includes('init')], extends: ['@commitlint/config-conventional'], rules: { - 'body-leading-blank': [2, 'always'], - 'footer-leading-blank': [1, 'always'], - 'header-max-length': [2, 'always', 108], - 'subject-empty': [2, 'never'], - 'type-empty': [2, 'never'], - 'subject-case': [0], + // @see: https://commitlint.js.org/#/reference-rules 'type-enum': [ 2, 'always', - [ - 'feat', - 'fix', - 'perf', - 'style', - 'docs', - 'test', - 'refactor', - 'build', - 'ci', - 'chore', - 'revert', - 'wip', - 'workflow', - 'types', - 'release', - ], - ], + ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test'] + ] }, prompt: { - /** @use `yarn commit :f` */ - 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, + alias: { fd: 'docs: fix typos' }, messages: { - type: '选择你要提交的类型 :', - scope: '选择一个提交范围（可选）:', - customScope: '请输入自定义的提交范围 :', - subject: '填写简短精炼的变更描述 :\n', - body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n', - breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n', - footerPrefixsSelect: '选择关联issue前缀（可选）:', - customFooterPrefixs: '输入自定义issue前缀 :', - footer: '列举关联issue (可选) 例如: #31, #I3244 :\n', - confirmCommit: '是否提交或修改commit ?', + 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', + footerPrefixesSelect: + '选择关联issue前缀（可选）| Select the ISSUES type of changeList by this change (optional):', + 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: [ - { value: 'feat', name: 'feat: ✨ 新增功能 | A new feature', emoji: ':sparkles:' }, - { value: 'fix', name: 'fix: 🐛 修复缺陷 | A bug fix', emoji: ':bug:' }, + { value: 'feat', name: 'feat: 新增功能 | A new feature' }, + { value: 'fix', name: 'fix: 修复缺陷 | A bug fix' }, { value: 'docs', - name: 'docs: 📝 文档更新 | Documentation only changes', - emoji: ':memo:', + name: 'docs: 文档更新 | Documentation only changes' }, { value: 'style', - name: 'style: 💄 代码格式 | Changes that do not affect the meaning of the code', - emoji: ':lipstick:', + name: 'style: 代码格式 | Changes that do not affect the meaning of the code' }, { value: 'refactor', - name: 'refactor: ♻️ 代码重构 | A code change that neither fixes a bug nor adds a feature', - emoji: ':recycle:', + name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature' }, { value: 'perf', - name: 'perf: ⚡️ 性能提升 | A code change that improves performance', - emoji: ':zap:', + name: 'perf: 性能提升 | A code change that improves performance' }, { value: 'test', - name: 'test: ✅ 测试相关 | Adding missing tests or correcting existing tests', - emoji: ':white_check_mark:', + name: 'test: 测试相关 | Adding missing tests or correcting existing tests' }, { value: 'build', - name: 'build: 📦️ 构建相关 | Changes that affect the build system or external dependencies', - emoji: ':package:', + name: 'build: 构建相关 | Changes that affect the build system or external dependencies' }, { value: 'ci', - name: 'ci: 🎡 持续集成 | Changes to our CI configuration files and scripts', - emoji: ':ferris_wheel:', + name: 'ci: 持续集成 | Changes to our CI configuration files and scripts' }, - { value: 'revert', name: 'revert: 🔨 回退代码 | Revert to a commit', emoji: ':hammer:' }, + { value: 'revert', name: 'revert: 回退代码 | Revert to a commit' }, { value: 'chore', - name: 'chore: ⏪️ 其他修改 | Other changes that do not modify src or test files', - emoji: ':rewind:', - }, + name: 'chore: 其他修改 | Other changes that do not modify src or test files' + } ], - useEmoji: true, + useEmoji: false, emojiAlign: 'center', + useAI: false, + aiNumber: 1, themeColorCode: '', + scopes: [], allowCustomScopes: true, allowEmptyScopes: true, + customScopesAlign: 'bottom', customScopesAlias: 'custom', emptyScopesAlias: 'empty', upperCaseSubject: false, @@ -135,21 +80,21 @@ module.exports = { breaklineNumber: 100, breaklineChar: '|', skipQuestions: [], - issuePrefixs: [ + issuePrefixes: [ // 如果使用 gitee 作为开发管理 { value: 'link', name: 'link: 链接 ISSUES 进行中' }, - { value: 'closed', name: 'closed: 标记 ISSUES 已完成' }, + { value: 'closed', name: 'closed: 标记 ISSUES 已完成' } ], - customIssuePrefixsAlign: 'top', - emptyIssuePrefixsAlias: 'skip', - customIssuePrefixsAlias: 'custom', + customIssuePrefixAlign: 'top', + emptyIssuePrefixAlias: 'skip', + customIssuePrefixAlias: 'custom', + allowCustomIssuePrefix: true, + allowEmptyIssuePrefix: true, confirmColorize: true, - maxHeaderLength: Number.POSITIVE_INFINITY, - maxSubjectLength: Number.POSITIVE_INFINITY, - minSubjectLength: 0, scopeOverrides: undefined, defaultBody: '', defaultIssues: '', - defaultSubject: '', - }, -} \ No newline at end of file + defaultScope: '', + defaultSubject: '' + } +};