1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
| /**
| * commitlint 配置文件
| * 文档
| * https://commitlint.js.org/#/reference-rules
| * https://cz-git.qbb.sh/zh/guide/
| */
|
| module.exports = {
| // 继承的规则
| extends: ['@commitlint/config-conventional'],
| // 自定义规则
| rules: {
| // 提交类型枚举，git提交type必须是以下类型
| 'type-enum': [
| 2,
| 'always',
| [
| 'feat', // 新增功能
| 'fix', // 修复缺陷
| 'docs', // 文档变更
| 'style', // 代码格式（不影响功能，例如空格、分号等格式修正）
| 'refactor', // 代码重构（不包括 bug 修复、功能新增）
| 'perf', // 性能优化
| 'test', // 添加疏漏测试或已有测试改动
| 'build', // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
| 'ci', // 修改 CI 配置、脚本
| 'revert', // 回滚 commit
| 'chore', // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
| 'wip' // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
| ]
| ],
| 'subject-case': [0] // subject大小写不做校验
| },
|
| prompt: {
| messages: {
| type: '选择你要提交的类型 :',
| scope: '选择一个提交范围（可选）:',
| customScope: '请输入自定义的提交范围 :',
| subject: '填写简短精炼的变更描述 :\n',
| body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
| breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
| footerPrefixesSelect: '选择关联issue前缀（可选）:',
| customFooterPrefix: '输入自定义issue前缀 :',
| footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
| generatingByAI: '正在通过 AI 生成你的提交简短描述...',
| generatedSelectByAI: '选择一个 AI 生成的简短描述:',
| confirmCommit: '是否提交或修改commit ?'
| },
| // prettier-ignore
| types: [
| { value: "feat", name: "feat: 新增功能" },
| { value: "fix", name: "fix: 修复缺陷" },
| { value: "docs", name: "docs: 文档变更" },
| { value: "style", name: "style: 代码格式（不影响功能，例如空格、分号等格式修正）" },
| { value: "refactor", name: "refactor: 代码重构（不包括 bug 修复、功能新增）" },
| { value: "perf", name: "perf: 性能优化" },
| { value: "test", name: "test: 添加疏漏测试或已有测试改动" },
| { value: "build", name: "build: 构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）" },
| { value: "ci", name: "ci: 修改 CI 配置、脚本" },
| { value: "revert", name: "revert: 回滚 commit" },
| { value: "chore", name: "chore: 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）" },
| ],
| useEmoji: true,
| emojiAlign: 'center',
| useAI: false,
| aiNumber: 1,
| themeColorCode: '',
| scopes: [],
| allowCustomScopes: true,
| allowEmptyScopes: true,
| customScopesAlign: 'bottom',
| customScopesAlias: 'custom',
| emptyScopesAlias: 'empty',
| upperCaseSubject: false,
| markBreakingChangeMode: false,
| allowBreakingChanges: ['feat', 'fix'],
| breaklineNumber: 100,
| breaklineChar: '|',
| skipQuestions: ['breaking', 'footerPrefix', 'footer'], // 跳过的步骤
| issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
| customIssuePrefixAlign: 'top',
| emptyIssuePrefixAlias: 'skip',
| customIssuePrefixAlias: 'custom',
| allowCustomIssuePrefix: true,
| allowEmptyIssuePrefix: true,
| confirmColorize: true,
| maxHeaderLength: Infinity,
| maxSubjectLength: Infinity,
| minSubjectLength: 0,
| scopeOverrides: undefined,
| defaultBody: '',
| defaultIssues: '',
| defaultScope: '',
| defaultSubject: ''
| }
| }
|
|
