@dazhicheng/common 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/commitlint.config.cjs +118 -121
  2. package/package.json +1 -1
package/commitlint.config.cjs CHANGED
@@ -1,121 +1,118 @@
1
- /**
2
- * commitlint 配置文件
3
- * 文档
4
- * https://commitlint.js.org/#/reference-rules
5
- * https://cz-git.qbb.sh/zh/guide/
6
- */
7
-
8
- const taskIdPlugin = {
9
- rules: {
10
- 'task-id-required': (parsed) => {
11
- const { header } = parsed;
12
- if (!/#\d+#/.test(header)) {
13
- return [false, 'commit message 必须包含任务ID，格式为 #任务ID#（如 #1234567#）'];
14
- }
15
- return [true, ''];
16
- },
17
- },
18
- };
19
-
20
- module.exports = {
21
- // 继承的规则
22
- extends: ['@commitlint/config-conventional'],
23
- // 自定义插件
24
- plugins: [taskIdPlugin],
25
- // 自定义规则
26
- rules: {
27
- // 提交类型枚举，git提交type必须是以下类型
28
- 'type-enum': [
29
- 2,
30
- 'always',
31
- [
32
- 'feat', // 新增功能
33
- 'fix', // 修复缺陷
34
- 'docs', // 文档变更
35
- 'style', // 代码格式（不影响功能，例如空格、分号等格式修正）
36
- 'refactor', // 代码重构（不包括 bug 修复、功能新增）
37
- 'perf', // 性能优化
38
- 'test', // 添加疏漏测试或已有测试改动
39
- 'build', // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
40
- 'ci', // 修改 CI 配置、脚本
41
- 'revert', // 回滚 commit
42
- 'chore', // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
43
- 'wip', // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
44
- ],
45
- ],
46
- 'subject-case': [0], // subject大小写不做校验
47
- 'task-id-required': [2, 'always'], // 必须包含任务ID
48
- },
49
-
50
- prompt: {
51
- messages: {
52
- type: '选择你要提交的类型 :',
53
- scope: '请输入任务ID :',
54
- customScope: '请输入任务ID（必填）:\n',
55
- subject: '填写简短精炼的变更描述 :\n',
56
- body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
57
- breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
58
- footerPrefixesSelect: '选择关联issue前缀（可选）:',
59
- customFooterPrefix: '输入自定义issue前缀 :',
60
- footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
61
- generatingByAI: '正在通过 AI 生成你的提交简短描述...',
62
- generatedSelectByAI: '选择一个 AI 生成的简短描述:',
63
- confirmCommit: '是否提交或修改commit ?',
64
- },
65
- // prettier-ignore
66
- types: [
67
- { value: "feat", name: "feat: 新增功能" },
68
- { value: "fix", name: "fix: 修复缺陷" },
69
- { value: "docs", name: "docs: 文档变更" },
70
- { value: "style", name: "style: 代码格式（不影响功能，例如空格、分号等格式修正）" },
71
- { value: "refactor", name: "refactor: 代码重构（不包括 bug 修复、功能新增）" },
72
- { value: "perf", name: "perf: 性能优化" },
73
- { value: "test", name: "test: 添加疏漏测试或已有测试改动" },
74
- { value: "build", name: "build: 构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）" },
75
- { value: "ci", name: "ci: 修改 CI 配置、脚本" },
76
- { value: "revert", name: "revert: 回滚 commit" },
77
- { value: "chore", name: "chore: 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）" },
78
- ],
79
- useEmoji: true,
80
- emojiAlign: 'center',
81
- useAI: false,
82
- aiNumber: 1,
83
- themeColorCode: '',
84
- scopes: [],
85
- allowCustomScopes: true,
86
- allowEmptyScopes: false,
87
- formatMessageCB: ({ type, scope, subject, body, breaking, footer }) => {
88
- let header;
89
- if (scope) {
90
- header = `${type}: #${scope}# ${subject}`;
91
- } else {
92
- header = `${type}: ${subject}`;
93
- }
94
- return [header, body, breaking, footer].filter(Boolean).join('\n\n');
95
- },
96
- customScopesAlign: 'bottom',
97
- customScopesAlias: 'custom',
98
- emptyScopesAlias: 'empty',
99
- upperCaseSubject: false,
100
- markBreakingChangeMode: false,
101
- allowBreakingChanges: ['feat', 'fix'],
102
- breaklineNumber: 100,
103
- breaklineChar: '|',
104
- skipQuestions: ['breaking', 'footerPrefix', 'footer'], // 跳过的步骤
105
- issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
106
- customIssuePrefixAlign: 'top',
107
- emptyIssuePrefixAlias: 'skip',
108
- customIssuePrefixAlias: 'custom',
109
- allowCustomIssuePrefix: true,
110
- allowEmptyIssuePrefix: true,
111
- confirmColorize: true,
112
- maxHeaderLength: Infinity,
113
- maxSubjectLength: Infinity,
114
- minSubjectLength: 0,
115
- scopeOverrides: undefined,
116
- defaultBody: '',
117
- defaultIssues: '',
118
- defaultScope: '',
119
- defaultSubject: '',
120
- },
121
- };
1
+ /**
2
+ * commitlint 配置文件
3
+ * 文档
4
+ * https://commitlint.js.org/#/reference-rules
5
+ * https://cz-git.qbb.sh/zh/guide/
6
+ */
7
+
8
+ const customRules = {
9
+ rules: {
10
+ "header-match-team-format": ({ header }) => {
11
+ const reg = /^([^:\s]+):\s#\d+#\s.+$/;
12
+ return [reg.test(header), "commit message 必须符合格式：type: #任务ID# 描述，例如 feat: #123456# 新增导出功能"];
13
+ },
14
+ },
15
+ };
16
+
17
+ module.exports = {
18
+ // 继承的规则
19
+ extends: ["@commitlint/config-conventional"],
20
+ // 自定义插件
21
+ plugins: [customRules],
22
+ // 自定义规则
23
+ rules: {
24
+ // 提交类型枚举，git提交type必须是以下类型
25
+ "type-enum": [
26
+ 2,
27
+ "always",
28
+ [
29
+ "feat", // 新增功能
30
+ "fix", // 修复缺陷
31
+ "docs", // 文档变更
32
+ "style", // 代码格式（不影响功能，例如空格、分号等格式修正）
33
+ "refactor", // 代码重构（不包括 bug 修复、功能新增）
34
+ "perf", // 性能优化
35
+ "test", // 添加疏漏测试或已有测试改动
36
+ "build", // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
37
+ "ci", // 修改 CI 配置、脚本
38
+ "revert", // 回滚 commit
39
+ "chore", // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
40
+ "wip", // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
41
+ ],
42
+ ],
43
+ "subject-case": [0], // subject大小写不做校验
44
+ "header-match-team-format": [2, "always"],
45
+ },
46
+
47
+ prompt: {
48
+ messages: {
49
+ type: "选择你要提交的类型 :",
50
+ scope: "请输入任务ID :",
51
+ customScope: "请输入任务ID（必填）:\n",
52
+ subject: "填写简短精炼的变更描述 :\n",
53
+ body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
54
+ breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
55
+ footerPrefixesSelect: "选择关联issue前缀（可选）:",
56
+ customFooterPrefix: "输入自定义issue前缀 :",
57
+ footer: "列举关联issue (可选) 例如: #31, #I3244 :\n",
58
+ generatingByAI: "正在通过 AI 生成你的提交简短描述...",
59
+ generatedSelectByAI: "选择一个 AI 生成的简短描述:",
60
+ confirmCommit: "是否提交或修改commit ?",
61
+ },
62
+ // prettier-ignore
63
+ types: [
64
+ { value: "feat", name: "feat: 新增功能" },
65
+ { value: "fix", name: "fix: 修复缺陷" },
66
+ { value: "docs", name: "docs: 文档变更" },
67
+ { value: "style", name: "style: 代码格式（不影响功能，例如空格、分号等格式修正）" },
68
+ { value: "refactor", name: "refactor: 代码重构（不包括 bug 修复、功能新增）" },
69
+ { value: "perf", name: "perf: 性能优化" },
70
+ { value: "test", name: "test: 添加疏漏测试或已有测试改动" },
71
+ { value: "build", name: "build: 构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）" },
72
+ { value: "ci", name: "ci: 修改 CI 配置、脚本" },
73
+ { value: "revert", name: "revert: 回滚 commit" },
74
+ { value: "chore", name: "chore: 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）" },
75
+ ],
76
+ useEmoji: true,
77
+ emojiAlign: "center",
78
+ useAI: false,
79
+ aiNumber: 1,
80
+ themeColorCode: "",
81
+ scopes: [],
82
+ allowCustomScopes: true,
83
+ allowEmptyScopes: false,
84
+ formatMessageCB: ({ type, scope, subject, body, breaking, footer }) => {
85
+ let header;
86
+ if (scope) {
87
+ header = `${type}: #${scope}# ${subject}`;
88
+ } else {
89
+ header = `${type}: ${subject}`;
90
+ }
91
+ return [header, body, breaking, footer].filter(Boolean).join("\n\n");
92
+ },
93
+ customScopesAlign: "bottom",
94
+ customScopesAlias: "custom",
95
+ emptyScopesAlias: "empty",
96
+ upperCaseSubject: false,
97
+ markBreakingChangeMode: false,
98
+ allowBreakingChanges: ["feat", "fix"],
99
+ breaklineNumber: 100,
100
+ breaklineChar: "|",
101
+ skipQuestions: ["breaking", "footerPrefix", "footer"], // 跳过的步骤
102
+ issuePrefixes: [{ value: "closed", name: "closed: ISSUES has been processed" }],
103
+ customIssuePrefixAlign: "top",
104
+ emptyIssuePrefixAlias: "skip",
105
+ customIssuePrefixAlias: "custom",
106
+ allowCustomIssuePrefix: true,
107
+ allowEmptyIssuePrefix: true,
108
+ confirmColorize: true,
109
+ maxHeaderLength: Infinity,
110
+ maxSubjectLength: Infinity,
111
+ minSubjectLength: 0,
112
+ scopeOverrides: undefined,
113
+ defaultBody: "",
114
+ defaultIssues: "",
115
+ defaultScope: "",
116
+ defaultSubject: "",
117
+ },
118
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dazhicheng/common",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "共享配置文件",
5
5
  "type": "module",
6
6
  "files": [