-
Notifications
You must be signed in to change notification settings - Fork 1
/
commitlint.config.js
180 lines (180 loc) · 9.07 KB
/
commitlint.config.js
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/* @see: https://cz-git.qbenben.com/zh/guide */
/** @type {import('cz-git').UserConfig} */
/* CHANGELOG.md @see: https://www.5axxw.com/wiki/content/yy4uxs#96t5oseui9?w */
/**
* feat:新特性、新功能
* fix:修改 Bug
* perf:优化相关,比如提升性能、体验
* style:代码格式修改, 注意不是 CSS 修改
* docs:仅文档新增、改动
* test:测试用例修改
* refactor:代码重构
* build:编译相关的修改,例如发布版本、对项目构建或者依赖的改动
* ci:持续集成修改
* chore:其他修改, 比如改变构建流程、或者增加依赖库、工具等
* revert:回滚到上一个版本
* optimize: 优化构建工具或运行时性能
* wip: 开发中
* types: 类型定义文件更改
*/
/**
* git commit -m <type>[optional scope]: <subject>
*
type :用于表明我们这次提交的改动类型,是新增了功能?还是修改了测试代码?又或者是更新了文档
optional scope:一个可选的修改范围。用于标识此次提交主要涉及到代码中哪个模块。
subject:一句话描述此次提交的主要内容,做到言简意赅
如:
* git commit -m 'fix(hooks): 修复 xxx 的 bug'
* git commit -m 'refactor: 重构整个项目'
*/
module.exports = {
ignores: [commit => commit.includes("init")],
extends: ["@commitlint/config-conventional"],
rules: {
// 参数 1:0 为 disable,1 为 warning,2 为 error,参数 2:always 开启 never 禁用,参数 3,自定义规则值
"body-leading-blank": [2, "always"], // body 换行
"footer-leading-blank": [1, "always"], // footer 以空行开头
"header-max-length": [2, "always", 150], // header 最长 150
"subject-empty": [2, "never"], // subject 不能为空
"type-empty": [2, "never"], // type 不能为空
"type-enum": [
2,
"always",
[
"feat",
"fix",
"perf",
"style",
"docs",
"test",
"refactor",
"build",
"ci",
"chore",
"revert",
"optimize",
"wip",
"types",
],
],
},
prompt: {
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',
// footerPrefixesSelect: "Select the ISSUES type of changeList by this change (optional):",
// customFooterPrefix: "Input ISSUES prefix:",
// footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
// generatingByAI: "Generating your AI commit subject...",
// generatedSelectByAI: "Select suitable subject by AI generated:",
// confirmCommit: "Are you sure you want to proceed with the commit above?",
// 中文版
type: "选择你要提交的类型 :",
scope: "选择一个提交范围(可选):",
customScope: "请输入自定义的提交范围 :",
subject: "填写简短精炼的变更描述 :\n",
body: '填写更加详细的变更描述(可选)。使用 "|" 换行 :\n',
breaking: '列举非兼容性重大的变更(可选)。使用 "|" 换行 :\n',
footerPrefixesSelect: "选择关联issue前缀(可选):",
customFooterPrefix: "输入自定义issue前缀 :",
footer: "列举关联issue (可选) 例如: #31, #I3244 :\n",
generatingByAI: "正在通过 AI 生成你的提交简短描述...",
generatedSelectByAI: "选择一个 AI 生成的简短描述:",
confirmCommit: "是否提交或修改commit ?",
},
types: [
// { value: "feat", name: "feat: 🚀 A new feature", emoji: "🚀" },
// { value: "fix", name: "fix: 🐞 A bug fix", emoji: "🐞" },
// { value: "docs", name: "docs: 📚 Documentation only changes", emoji: "📚" },
// { value: "style", name: "style: 🎨 Changes that do not affect the meaning of the code", emoji: "🎨" },
// {
// value: "refactor",
// name: "refactor: ♻️ A code change that neither fixes a bug nor adds a feature",
// emoji: "♻️",
// },
// { value: "perf", name: "perf: ⚡️ A code change that improves performance", emoji: "⚡️" },
// { value: "test", name: "test: ✅ Adding missing tests or correcting existing tests", emoji: "✅" },
// {
// value: "build",
// name: "build: 📦️ Changes that affect the build system or external dependencies",
// emoji: "📦️",
// },
// { value: "ci", name: "ci: 🎡 Changes to our CI configuration files and scripts", emoji: "🎡" },
// { value: "chore", name: "chore: 🔨 Other changes that don't modify src or test files", emoji: "🔨" },
// { value: "revert", name: "revert: ⏪️ Reverts a previous commit", emoji: "⏪️" },
// { value: "wip", name: "wip: 🥗 Code development in progress", emoji: "🥗" },
// { value: "types", name: "types: 💎 TypeScript Definition File Change", emoji: "💎" },
// 中文版
{ value: "feat", name: "feat: 🚀 新增功能", emoji: "🚀" },
{ value: "fix", name: "fix: 🐞 修复缺陷(Bug)", emoji: "🐞" },
{ value: "docs", name: "docs: 📚 文档变更", emoji: "📚" },
{ value: "style", name: "style: 🎨 代码格式(不影响功能,例如空格、分号等格式修正)", emoji: "🎨" },
{ value: "refactor", name: "refactor: ♻️ 代码重构(不包括 bug 修复、功能新增)", emoji: "♻️" },
{ value: "perf", name: "perf: ⚡️ 性能优化", emoji: "⚡️" },
{ value: "test", name: "test: ✅ 添加疏漏测试或已有测试改动", emoji: "✅" },
{
value: "build",
name: "build: 📦️ 构建流程、外部依赖变更(如升级 npm 包、修改 webpack 配置等)",
emoji: "📦️",
},
{ value: "ci", name: "ci: 🎡 修改 CI 配置、脚本", emoji: "🎡" },
{ value: "chore", name: "chore: 🔨 回滚 commit", emoji: "⏪️" },
{ value: "revert", name: "revert: ⏪️ 对构建过程或辅助工具和库的更改(不影响源文件、测试用例)", emoji: "🔨" },
{ value: "wip", name: "wip: 🥗 代码正在开发中", emoji: "🥗" },
{ value: "types", name: "types: 💎 类型定义文件更改", emoji: "💎" },
// 纯中文版
// { value: "特性", name: "特性: 🚀 新增功能", emoji: "🚀" },
// { value: "修复", name: "修复: 🐞 修复缺陷", emoji: "🐞" },
// { value: "文档", name: "文档: 📚 文档变更", emoji: "📚" },
// { value: "格式", name: "格式: 🎨 代码格式(不影响功能,例如空格、分号等格式修正)", emoji: "🎨" },
// { value: "重构", name: "重构: ♻️ 代码重构(不包括 bug 修复、功能新增)", emoji: "♻️" },
// { value: "性能", name: "性能: ⚡️ 性能优化", emoji: "⚡️" },
// { value: "测试", name: "测试: ✅ 添加疏漏测试或已有测试改动", emoji: "✅" },
// { value: "构建", name: "构建: 📦️ 构建流程、外部依赖变更(如升级 npm 包、修改 webpack 配置等)", emoji: "📦️" },
// { value: "集成", name: "集成: 🎡 修改 CI 配置、脚本", emoji: "🎡" },
// { value: "回退", name: "回退: ⏪️ 回滚 commit", emoji: "⏪️" },
// { value: "其他", name: "其他: 🔨 对构建过程或辅助工具和库的更改(不影响源文件、测试用例)", emoji: "🔨" },
// { value: "开发中", name: "开发中: 🥗 代码正在开发中", emoji: "🥗" },
// { value: "类型", name: "类型: 💎 类型定义文件更改", emoji: "💎" },
],
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: [],
issuePrefixes: [
{ value: "link", name: "link: 链接 ISSUES 进行中" },
{ value: "closed", name: "closed: 标记 ISSUES 已完成" },
],
customIssuePrefixAlign: "top",
emptyIssuePrefixAlias: "skip",
customIssuePrefixAlias: "custom",
allowCustomIssuePrefix: true,
allowEmptyIssuePrefix: true,
confirmColorize: true,
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
minSubjectLength: 0,
scopeOverrides: undefined,
defaultBody: "",
defaultIssues: "",
defaultScope: "",
defaultSubject: "",
},
};