如果你是一位前端开发者，你一定会用到 Git 进行版本控制，同时也一定遇到过开发过程中需要对提交信息做出规范的问题。cz-gitmoji 就是一款可以帮助我们规范提交信息的 npm 包，它通过使用 gitmoji 语法来使提交信息更加规范化，同时也能够提高代码提交的效率。本篇文章将会详细介绍 cz-gitmoji 的使用教程，希望能够对广大前端开发者提供一点帮助。
什么是 cz-gitmoji
cz-gitmoji 是一款使用 git commit 信息来标注commit职责的工具集，使用了它，可以在commit时选择不同的git表情，以便更好的说明当前提交的内容。
安装 cz-gitmoji
cz-gitmoji 的安装十分简单，只需要在命令行中输入以下代码即可：
npm install cz-gitmoji -g
安装成功后，就可以在 git commit 的时候使用 cz-gitmoji 的 emoji 了。
使用 cz-gitmoji
使用 cz-gitmoji 的过程十分简单，只需要按照以下步骤进行即可：
- 使用
git add命令来将你所要提交的文件添加到暂存区； - 使用
git cz命令来代替git commit，随后将会跳出 cz-gitmoji 的交互式命令行； - 按照提示来输入相应的提交信息：type、scope、subject 和 body，具体见下文。
规范的提交信息
在 cz-gitmoji 中，提交信息分为四部分：type、scope、subject 和 body，分别代表提交的类型、范围、主要内容和详细描述。
type
type 表示提交的类型。在 cz-gitmoji 中，type 只能从以下几个类型中进行选择：
- feat：新功能
- fix：修复 bug
- docs：写文档
- style：改变代码风格
- refactor：重构代码
- test：添加或修改测试
- chore：改变构建流程、或者增加依赖库等操作
scope
scope 表示影响的范围。可以是任何可描述的内容，比如组件名称等。
subject
subject 表示一句话的简要概述。与 commit 一样，应该使用第一人称现在时来阐述。
body
body 表示一些详细信息的描述，通常以英文冒号和空格（“: ”）开头，后跟一段描述。
示例
以下是一个示例，展示了使用 cz-gitmoji 进行规范提交信息的方式：
-- -------------------- ---- ------- - --- --- - - --- -- ------------- ----------- -- ---------------- - ------ --- ---- -- ------ ---- ------ ----------- ---- ----- ----- - ----- --- ---- -- --- ----- --- ------ ------ --------- ---- ----- ------- ------ ----------------- - ------------- -- ---- - - ----- - ----------- --- --- ------ --------- - ----------------------- ---- --- --- ------ ---------- - ------------------ -- ----- ------
在使用 cz-gitmoji 的时候，commit 后的信息格式如下：
<commit-type>(<范围>): <主要内容> <详细描述>
总结
cz-gitmoji 是一款非常好用的提交信息规范化工具，它可以帮助我们更加高效地记录代码的版本变化。在使用的过程中，我们只需要按照一定格式进行输入即可，非常简单方便。如果你正在寻找一款提交信息规范化工具，不妨试一试 cz-gitmoji。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055ea481e8991b448dc04f