-
Notifications
You must be signed in to change notification settings - Fork 0
/
commitlint.config.cjs
75 lines (72 loc) · 4.16 KB
/
commitlint.config.cjs
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
/*
<type>(<scope?>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
<类型>(<commit影响的范围>): <标题>
*/
/*
1、czg 零配置的交互式命令行工具 (cz-git + Commitizen适配器)
2、@commitlint/cli 用于commit message 的检查，并且能通过 npm 安装包的形式分享commit rules
3、@commitlint/config-conventional 是通用的commit rules，你也可以在它的基础上自定义 rules
*/
module.exports = {
// ignores: [commit => commit.includes("init")],
extends: ['@commitlint/config-conventional'],
rules: {
// 要求提交信息的标题不能为空
'subject-empty': [2, 'never'],
// 允许提交信息的标题大小写任意
'subject-case': [0],
// 要求提交信息的类型不能为空
'type-empty': [2, 'never'],
// 该规则要求在提交信息中的第一个字段必须是指定的类型之一
// 0-禁止 1-警告 2-错误 never从不(不允许) always总是 --> 下方说明 如果提交信息不是所定义的类型之一 总是会抛出错误
'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert', 'wip', 'workflow', 'types', 'release']]
},
prompt: {
settings: {},
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?"
// 中文版
type: '选择你要提交的类型 :',
scope: '选择一个提交范围（可选）:',
customScope: '请输入自定义的提交范围 :',
subject: '填写简短精炼的变更描述 :\n',
body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
footerPrefixsSelect: '选择关联issue前缀（可选）:',
customFooterPrefixs: '输入自定义issue前缀 :',
footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
confirmCommit: '是否提交或修改commit ?'
},
types: [
{ value: 'feat', name: '特性: 🚀 新增功能', emoji: '🚀' },
{ value: 'fix', name: '修复: 🐞 修复缺陷', emoji: '🐞' },
{ value: 'docs', name: '文档: 📚 文档变更', emoji: '📚' },
{ value: 'style', name: '格式: 🎨 代码格式（不影响功能，例如空格、分号等格式修正）', emoji: '🎨' },
{ value: 'refactor', name: '重构: ♻️ 代码重构（不包括 bug 修复、功能新增）', emoji: '♻️' },
{ value: 'perf', name: '性能: ⚡️ 性能优化', emoji: '⚡️' },
{ value: 'test', name: '测试: ✅ 添加疏漏测试或已有测试改动', emoji: '✅' },
{ value: 'build', name: '构建: 📦️ 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）', emoji: '📦️' },
{ value: 'ci', name: '集成: 🎡 修改 CI 配置、脚本', emoji: '🎡' },
{ value: 'chore', name: '回退: ⏪️ 回滚 commit', emoji: '⏪️' },
{ value: 'revert', name: '其他: 🔨 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）', emoji: '🔨' },
{ value: 'wip', name: '开发: 🕔 正在开发中', emoji: '🕔' },
{ value: 'workflow', name: '工作流: 📋 工作流程改进', emoji: '📋' },
{ value: 'types', name: '类型: 🔰 类型定义文件修改', emoji: '🔰' },
{ value: 'release', name: '重构: 🛠️ 代码模块重构', emoji: '🛠️' }
],
useEmoji: true
}
};