Commit message helper for commitizen

Committezen 插件的提交消息助手
注意，您可以实现一致的提交消息
注意，您可以自定义提交消息模版

英文 README.md

https://github.com/linpengteng/cz-message-helper/blob/main/README.md

安装

因为cz-message-helper是committen的插件, 所以您需要安装以下依赖项

• commitizen ------------------------- 规范你的提交消息
• @commitlint/cli --------------------- commitizen cli 工具
• @commitlint/config-conventional ---- 提交消息规范规则
• husky ------------------------------- 用于 git 提交前对 message 进行 commitlint 校验

1  # commitizen
2  pnpm add commitizen -g
3  yarn global add commitizen
4
5
6  # @commitlint/cli @commitlint/config-conventional
7  pnpm add @commitlint/cli @commitlint/config-conventional -D
8  yarn add @commitlint/cli @commitlint/config-conventional -D
9
10
11  # husky
12  pnpm add husky -D
13  yarn add husky -D
14
15
16  # cz-message-helper
17  pnpm add cz-message-helper -D
18  yarn add cz-message-helper -D

如何使用

1. 在package.json中添加commitizen配置

1{
2  "config": {
3    "cz-message-helper": {
4      "config": ".cz-message.cjs"
5    },
6    "commitizen": {
7      "path": "node_modules/cz-message-helper"
8    }
9  }
10}

2. 在项目根目录下创建 .cz-message.cjs 配置文件

1module.exports = {
2  language: 'cn' // 选项: en | cn
3}

3. 在项目根目录下创建 commitlint.config.js 配置文件

1module.exports = {
2  extends: ['@commitlint/config-conventional'],
3  rules: {
4    'type-enum': [
5      2,
6      'always',
7      [
8        'fix',
9        'feat',
10        'begin',
11        'docs',
12        'style',
13        'refactor',
14        'chore',
15        'perf',
16        'test',
17        'merge',
18        'revert',
19        'wip'
20      ]
21    ],
22    'type-case': [0],
23    'scope-case': [0],
24    'subject-case': [0],
25    'header-case': [0],
26    'body-case': [0],
27    'type-empty': [2, 'never'],
28    'scope-empty': [0],
29    'subject-empty': [2, 'never'],
30    'body-empty': [0],
31    'subject-full-stop': [0],
32    'header-full-stop': [0],
33    'body-full-stop': [0],
34    'header-max-length': [2, 'always', 100],
35    'body-leading-blank': [2, 'always'],
36    'footer-leading-blank': [2, 'always']
37  }
38}
39

4. husky 初始化安装 和 添加 git commit-msg 钩子

1  # step1
2  npx husky install  
3
4  # step2 
5  npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
6  npx husky add .husky/pre-commit 'npx lint-staged'

5. Good, 接下来你能通过 git add . 和 git cz 进行使用

6. 有关其他一些问题

• 当 package.json 中 type: "module" 时, 需在根目录下创建 .cz-message.cjs 配置文件
• 当 package.json 中 type: "module" 时, 后缀需改成 .cjs, 例 "config": ".cz-message.cjs"

更多配置选项 -- .cz-message.cjs

1module.exports = {
2  questions: [
3    {
4      type: 'list',
5      name: 'type',
6      message: '请选择要提交的更改类型:',
7      choices: [
8        { value: 'fix', name: 'fix: -------- 修复BUG' },
9        { value: 'feat', name: 'feat: ------- 新功能' },
10        { value: 'begin', name: 'begin: ------ 创建新存储库' },
11        { value: 'docs', name: 'docs: ------- 仅文档更改' },
12        { value: 'style', name: 'style: ------ 不影响代码运行的更改(调整空白、格式、缺少分号等)' },
13        { value: 'chore', name: 'chore: ------ 对构建过程或辅助工具的更改以及文档生成等库' },
14        { value: 'refactor', name: 'refactor: --- 重构架构或代码' },
15        { value: 'perf', name: 'perf:  ------ 改进性能的代码更改' },
16        { value: 'test', name: 'test:  ------ 添加测试单元' },
17        { value: 'revert', name: 'revert: ----- 回退至某一个版本' },
18        { value: 'merge', name: 'merge: ------ 合并一个分支, 解决冲突分支' },
19        { value: 'wip', name: 'wip: -------- 正在进行中的工作' }
20      ]
21    },
22
23    {
24      type: 'list',
25      name: 'scope',
26      message: '请选择更改的范围:',
27      choices() {
28        return [
29          { name: '无', value: false },
30          { name: '自定义', value: 'custom' }
31        ]
32      },
33      filter(value, answers) {
34        return value || ''
35      }
36    },
37
38    {
39      type: 'input',
40      name: 'customScope',
41      message: '请输入自定义的变更的范围(可选):',
42      when(answers) {
43        return answers.scope === 'custom'
44      },
45      filter(value, answers) {
46        answers.scope = value || ''
47        return value || ''
48      }
49    },
50
51    {
52      type: 'input',
53      name: 'subject',
54      message: '请简明扼要的摘要描述(建议字数在72字内):',
55      validate(value) {
56        if (!value.trim()) {
57          return '描述内容不可为空'
58        }
59
60        return value.length > 72
61          ? `描述内容字数不能超过72`
62          : true
63      }
64    },
65
66    {
67      type: 'input',
68      name: 'body',
69      message: '请提供更详细的变更说明(可选), 使用“\\n”换行:'
70    },
71
72    {
73      type: 'input',
74      name: 'breaking',
75      message: '请列出任何重大变化(可选)',
76      when(answers) {
77        return /^(\:[a-z0-9A-Z_-]+(\:)(\s*))?(feat|fix)(\2\s*)?$/.test(answers.type.toLowerCase())
78      }
79    },
80
81    {
82      type: 'input',
83      name: 'footer',
84      message: '请列出此更改关闭的任何问题(可选), 例如: #31,#34:'
85    }
86  ],
87
88  templater: (answers, wrap) => {
89    let template = ''
90
91    template += answers.type ? `${answers.type}` : ``
92    template += answers.scope ? `(${answers.scope})` : ``
93    template += answers.subject ? `: ${answers.subject}` : ``
94    template += answers.body ? `\n\n${wrap(answers.body)}` : ``
95    template += answers.breaking ? `\n\nBREAKING CHANGE: ${wrap(answers.breaking)}` : ``
96    template += answers.footer ? `\n\nISSUES CLOSED: ${wrap(answers.footer)}` : ``
97
98    return template
99  },
100
101  language: 'cn'
102}
103

说明

1. templater --- 指定生成消息的模板
2. questions --- 关于问题选项和描述, 请看 Inquirer
3. language ---- 预设选项仅支持中文和英文，自定义 questions 时无效

Licence

MIT