11个版本
0.1.10 | 2022年10月12日 |
---|---|
0.1.9 | 2022年10月11日 |
0.1.8 | 2021年8月4日 |
0.1.7 | 2021年6月9日 |
0.1.2 | 2016年11月13日 |
#696 在 开发工具
每月 41 次下载
22KB
386 行
Emoji Commit
使用表情符号使您的git日志更美观易读 🎉
表情符号提交器的想法是使用与semver升级相对应的表情符号标记每个提交。这些信息可以用于自动发布新版本,生成变更日志,并使git日志能够快速查看发生了什么。
目录
安装
cargo install emoji-commit
使用方法
表情符号提交器可以使用两种方式。要么直接调用,要么通过配置git来调用。
直接调用
只需像调用任何其他命令一样调用 emoji-commit
emoji-commit
配置Git
您可以在git中设置 core.editor
配置,使表情符号提交器在提交时始终使用它。
git config --global core.editor 'emoji-commit'
表情符号
以下表情符号被选为表情符号提交器
表情符号 | 名称 | Semver | 含义 |
---|---|---|---|
💥 | 碰撞 | major | 破坏性更改 |
🎉 | 派对炮竹 | minor | 新功能 |
🐛 | 虫子 | patch | 错误修复 |
🔥 | 火焰 | patch | 清理/性能 |
🌹 | 玫瑰 | 元 |
💥 破坏性更改
如果您所做的更改以任何方式破坏了预期消费者,请使用此提交类型。请注意,“破坏”在不同的上下文中有不同的含义,例如,向结构体添加字段在Rust中是破坏性更改,但在Node.js中通常被认为是向后兼容的更改。
🎉 新功能
如果您以完全向后兼容的方式添加了新功能,请使用此提交类型。请注意,为以前未记录的功能添加文档可能符合此类型,因为未记录的API不是公共API的一部分。
🐛 错误修复
如果您修复了错误,请使用此提交类型。有两个“补丁”类型的原因是能够快速列出已修复的所有错误。
🔥 清理/性能
使用此提交,如果您的更改以某种方式影响消费者,无论是更改文档、优化if语句还是简单地删除一些不必要的分号。
🌹 元数据
当您更改 不会对消费者造成任何影响 时,请使用此提交。这 不包括 代码更改,这些更改仍然应该“表现得一样”,因为那些更改应该导致发布新的构建。
此表情符号的一个常见用例是编辑您的 .travis.yml
文件以更改构建中的某些内容,或添加更多测试。
版本升级
许多发布工具,例如npm,都有一个步骤,您将在某个文件中升级版本,提交该更改,然后将所有内容发布到注册表。对于这个特定的用例,我们引入了一个特殊的表情符号。
🚢 发布
当您进行新版本发布时,请使用此提交类型。带有此表情符号的提交最好由某种持续交付系统自动创建,该系统还发布包。
我希望能尽快发布一些使这更简单的工具。在此期间,您可以使用以下方便的快捷方式来使用 npm
npm version <bump> -m '🚢 %s'
故障排除
git log
在macOS上不显示表情符号
macOS自带一个非常过时的 less
,它不支持直接显示表情符号。有关正确解决方案的更多信息,请参阅这篇博客文章,或运行以下命令以使其正常工作™。
git config --global core.pager 'less -r'
依赖项
~12MB
~290K SLoC