Git 是前端工程师工作中不可或缺的工具，而使用规范化的 commit message 也变得越来越重要，因为它可以让代码更易读、易维护。git-cz 是一个可以帮助我们规范 commit message 的 npm 包，本文将详细介绍它的使用方法。
安装
安装 git-cz 相当简单，只需在你的项目中安装它即可：
npm install --save-dev git-cz
使用方法
安装完成后，我们可以在 package.json 中添加一个 script，方便使用 git-cz：
"scripts": {
"commit": "git-cz"
}然后，我们就可以使用 npm run commit 命令来提交 commit 了。
接下来，git-cz 会引导我们填写相关信息，包括选择 commit 类型、填写 commit 简要描述、填写详细描述等。这些信息都将在我们提交代码时，包含在 commit message 中。
选择 commit 类型
git-cz 中内置了一些常用的 commit 类型，我们可以通过键盘选择对应的类型。
- feat：新功能。
- fix：修复 bug。
- docs：文档变更。
- style：不影响代码含义的更改（如空格、格式化、去掉末尾分号等）。
- refactor：代码重构。
- perf：性能优化。
- test：添加或修改测试。
- chore：构建过程或辅助工具的变动。
- ci：CI 相关的修改。
填写 commit 简要描述
填写 commit 简要描述时，我们需要简明扼要地描述出本次 commit 的主要更改内容。描述合理与否，直接影响了其他人阅读的难度。
填写详细描述
填写详细描述时，我们需要更详细地描述我们所做的修改。它应该给其他人一个足够清晰的印象，以便他们能够了解我们做了什么和为什么这样做。
示例代码
-- -------------------- ---- ------- - --- --- - - ------ - ------ --- ---- -- ------ ---- ------ ----------- ---- ----- ----- - ----- - --- ------- ---- - --- --- ----- ------------- ---- ------- ------ ------- ---- -- --- ------ --- ------- -- --- ---- ------------- ----------- ------- ------------ ---- --------- - ---- ------ ---- ------- ----- - --- --- ---- - ------- ----- - ---- ------ ---- -------- ----------- ----- ------ ------- -- ---------- -------- ----- ------ ------- -- --- ----- ------- -- --------- ----- --- --------- ---- -- ------------- ---------- --- ------- -- --- -- ------------- ----- --- ------- - ---- -- --- ----- -- ---- ------ ----- --------- -- ---- ------ ------ ----- -- ----- - ----- - ------ ---------- ----- ----------- -- --- ------ ---- -- ------- ---------- ---- - ------- - ------ ----------- -- --- ------- --- ---- - --- ----- --- -------- -------- -- - ---- ---- ------ ------ --- ---- -------- ------ ----- -- -----
总结
使用规范化的 commit message，可以让代码更易读、易维护。而 git-cz 则是一个简单易用的工具，使我们能够更方便地规范 commit message。希望本文能够对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64597