前言
在项目开发的过程中,提交 commit 是必不可少的一个环节。对于提交 commit 的人来说,良好的 commit 格式能够提高可读性,方便代码追踪和管理。而对于整个团队来说,commit 的一致性也显得尤为重要。
commit-emojis 就是一个基于 Git 提交信息规范的 npm 包,它提供了一些常用的 Emoji 表情符号作为 Git 提交信息中的前缀,以此来统一项目中的 commit 格式。
安装
commit-emojis 是一个 npm 包,因此需要先安装 Node.js。安装完成后,在终端中执行以下命令即可安装 commit-emojis。
npm install commit-emojis --save-dev
使用
在使用 commit-emojis 之前,需要先了解一下 Emoji 的含义。
Emoji 含义
以下是 commit-emojis 提供的一些 Emoji 以及对应的含义。
- :tada:
:tada:
初始提交 - :bug:
:bug:
修复 Bug - :sparkles:
:sparkles:
新功能 - :recycle:
:recycle:
重构 - :lipstick:
:lipstick:
更新 UI 样式 - :books:
:books:
更新文档 - :art:
:art:
改善代码结构/代码格式 - :fire:
:fire:
删除代码/文件 - :truck:
:truck:
移动/重命名文件 - :white_check_mark:
:white_check_mark:
增加测试
在 Git 提交信息中使用 Emoji 时,只需要在 commit message 的开头添加 Emoji 名称即可。例如:
:sparkles: 增加用户注册功能
这样提交的 commit message 就可以被 commit-emojis 自动识别,进而判断出该 commit 是一个“新功能”类型的 commit。
配置
为了让 commit-emojis 识别你的 commit message,需要在 package.json 文件中进行配置。
-- -------------------- ---- ------- - ---------- - --------- --------------- -- --------- - ---------------- - -------- - - -------- ----- ------- ------------------------ ------- ------ -------------- ------ -- - -------- ----- ------- ------------- ------- -------- ----- -------------- ------ -- - -------- ----- ------- --------- ------- -------- -------- -------------- ------ - - - - -展开代码
在上面的配置中,我们新增了 3 个类型,它们分别是:
- WIP: 正在进行
- Version Tag: 版本发布
- Initial Commit: 初始提交
使用 commit-emojis
完成上述配置后,我们就可以在终端使用 commit-emojis 命令了。具体流程如下:
- 使用 git add 命令将修改的文件加入暂存区
- 在终端执行 git cz 命令
这时,commit-emojis 会自动识别你的 commit message,并在之后的操作中帮助你填写提交信息。用户只需要一个个选择对应的类型,填写对应的信息即可。
结语
通过使用 commit-emojis,我们可以很方便地统一整个项目的 commit message 格式,从而达到更好的代码管理、追踪、协作等效果。同时,commit-emojis 的配置也灵活且易于使用,可以根据团队需要进行自定义。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671a730d09270238225a6