Parcourir la source

build: 修改git提交文件规范

laiqi il y a 1 an
Parent
commit
071fd0ac73
1 fichiers modifiés avec 81 ajouts et 49 suppressions
  1. 81 49
      .commitlintrc.cjs

+ 81 - 49
.commitlintrc.cjs

@@ -27,27 +27,27 @@ module.exports = {
     'subject-empty': [2, 'never'],
     'type-empty': [2, 'never'],
     'subject-case': [0],
-    'type-enum': [
-      2,
-      'always',
-      [
-        'feat',
-        'fix',
-        'perf',
-        'style',
-        'docs',
-        'test',
-        'refactor',
-        'build',
-        'ci',
-        'chore',
-        'revert',
-        'wip',
-        'workflow',
-        'types',
-        'release',
-      ],
-    ],
+    // 'type-enum': [
+    //   2,
+    //   'always',
+    //   [
+    //     'feat',
+    //     'fix',
+    //     'perf',
+    //     'style',
+    //     'docs',
+    //     'test',
+    //     'refactor',
+    //     'build',
+    //     'ci',
+    //     'chore',
+    //     'revert',
+    //     'wip',
+    //     'workflow',
+    //     'types',
+    //     'release',
+    //   ],
+    // ],
   },
   prompt: {
     /** @use `pnpm commit :f` */
@@ -72,34 +72,66 @@ module.exports = {
     ],
 
     // 中英文对照版
-    // messages: {
-    //   type: '选择你要提交的类型 :',
-    //   scope: '选择一个提交范围 (可选):',
-    //   customScope: '请输入自定义的提交范围 :',
-    //   subject: '填写简短精炼的变更描述 :\n',
-    //   body: '填写更加详细的变更描述 (可选)。使用 "|" 换行 :\n',
-    //   breaking: '列举非兼容性重大的变更 (可选)。使用 "|" 换行 :\n',
-    //   footerPrefixsSelect: '选择关联issue前缀 (可选):',
-    //   customFooterPrefixs: '输入自定义issue前缀 :',
-    //   footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
-    //   confirmCommit: '是否提交或修改commit ?',
-    // },
-    // types: [
-    //   { value: 'feat', name: 'feat:     新增功能' },
-    //   { value: 'fix', name: 'fix:      修复缺陷' },
-    //   { value: 'docs', name: 'docs:     文档变更' },
-    //   { value: 'style', name: 'style:    代码格式' },
-    //   { value: 'refactor', name: 'refactor: 代码重构' },
-    //   { value: 'perf', name: 'perf:     性能优化' },
-    //   { value: 'test', name: 'test:     添加疏漏测试或已有测试改动' },
-    //   { value: 'build', name: 'build:    构建流程、外部依赖变更 (如升级 npm 包、修改打包配置等)' },
-    //   { value: 'ci', name: 'ci:       修改 CI 配置、脚本' },
-    //   { value: 'revert', name: 'revert:   回滚 commit' },
-    //   { value: 'chore', name: 'chore:    对构建过程或辅助工具和库的更改 (不影响源文件、测试用例)' },
-    //   { value: 'wip', name: 'wip:      正在开发中' },
-    //   { value: 'workflow', name: 'workflow: 工作流程改进' },
-    //   { value: 'types', name: 'types:    类型定义文件修改' },
-    // ],
+    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:
+        '选择关联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',
+      generatingByAI: 'Generating your AI commit subject...',
+      generatedSelectByAI: 'Select suitable subject by AI generated:',
+      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: 'docs', name: 'docs:     文档更新 | Documentation only changes', emoji: ':memo:' },
+      {
+        value: 'style',
+        name: 'style:    代码格式 | Changes that do not affect the meaning of the code',
+        emoji: ':lipstick:',
+      },
+      {
+        value: 'refactor',
+        name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature',
+        emoji: ':recycle:',
+      },
+      {
+        value: 'perf',
+        name: 'perf:     性能提升 | A code change that improves performance',
+        emoji: ':zap:',
+      },
+      {
+        value: 'test',
+        name: 'test:     测试相关 | Adding missing tests or correcting existing tests',
+        emoji: ':white_check_mark:',
+      },
+      {
+        value: 'build',
+        name: 'build:    构建相关 | Changes that affect the build system or external dependencies',
+        emoji: ':package:',
+      },
+      {
+        value: 'ci',
+        name: 'ci:       持续集成 | Changes to our CI configuration files and scripts',
+        emoji: ':ferris_wheel:',
+      },
+      {
+        value: 'chore',
+        name: 'chore:    其他修改 | Other changes that do not modify src or test files',
+        emoji: ':hammer:',
+      },
+      { value: 'revert', name: 'revert:   回退代码 | Revert to a commit', emoji: ':rewind:' },
+    ],
     // emptyScopesAlias: 'empty:      不填写',
     // customScopesAlias: 'custom:     自定义',
   },