在 commit 里使用 emoji~
# 230.在 commit 里使用 emoji~
在 git commit 上使用 emoji 提供了一种简单的方法,仅通过查看所使用的 emoji 来确定提交的目的或意图,非常好理解,阅读体验很棒。
# 效果
以我的 博客项目 (opens new window) 为例,可以看到不少的 emoji :
# 使用方法
直接在提交信息里写入表情符号的代码即可,例如:
$ git commit -m ":art: 测试emoji"
2
3
效果:
(https://image.peterjxl.com/blog/image-20230115103728-r47nw9r.png)
# 获取 emoji 表情
那么在哪里获取这些表情呢?
网上有很多网站,例如 gitmoji.dev (opens new window),可以预览、复制、搜索相关的 emoji:
其实 gitmoji 是一个开源项目,你可以 fork 一份然后搭建一个自己的,例如这是一个汉化后的镜像站:gitmoji.js.org (opens new window)
# 部分 emoji 示例
这里列出部分 emoji:
emoji | emoji 代码 | commit 说明 |
---|---|---|
🎨 (调色板) | :art: | 改进代码结构/代码格式 |
🚚(卡车) | :truck: | 移动或重命名文件 |
💩(大便) | :poop: | 写了很差的代码,后期需要改善 |
⚡️ (闪电) | :zap: | 提升性能 |
🐎 (赛马) | :racehorse: | 提升性能 |
🔥 (火焰) | :fire: | 移除代码或文件 |
🐛 (bug) | :bug: | 修复 bug |
🚑 (急救车) | :ambulance: | 重要补丁 |
✨ (火花) | :sparkles: | 引入新功能 |
🚀 (火箭) | :rocket: | 部署功能 |
💄 (口红) | :lipstick: | 更新 UI 和样式文件 |
🎉 (庆祝) | :tada: | 初次提交 |
✅ (白色复选框) | :white_check_mark: | 增加测试 |
🔒 (锁) | :lock: | 修复安全问题 |
🍎 (苹果) | :apple: | 修复 macOS 下的问题 |
🐧 (企鹅) | :penguin: | 修复 Linux 下的问题 |
🏁 (旗帜) | :checked_flag: | 修复 Windows 下的问题 |
🔖 (书签) | :bookmark: | 发行/版本标签 |
🚨 (警车灯) | :rotating_light: | 移除 linter 警告 |
🚧 (施工) | :construction: | 工作进行中 |
💚 (绿心) | :green_heart: | 修复 CI 构建问题 |
⬇️ (下降箭头) | :arrow_down: | 降级依赖 |
⬆️ (上升箭头) | :arrow_up: | 升级依赖 |
👷 (工人) | :construction_worker: | 添加 CI 构建系统 |
📈 (上升趋势图) | :chart_with_upwards_trend: | 添加分析或跟踪代码 |
🔨 (锤子) | :hammer: | 重大重构 |
➖ (减号) | :heavy_minus_sign: | 减少一个依赖 |
🐳 (鲸鱼) | :whale: | 相关工作 |
➕ (加号) | :heavy_plus_sign: | 增加一个依赖 |
🔧 (扳手) | :wrench: | 修改配置文件 |
🌐 (地球) | :globe_with_meridians: | 国际化与本地化 |
✏️ (铅笔) | :pencli2: | 修复 typo |
# 在命令行中显示 emoji
默认情况下,在命令行中并不会显示出 emoji,仅显示 emoji 代码:
$ git log --oneline
b626627 :memo: add blog
a5902d1 :memo: update rss info
4fd1ec4 :memo: update browser console output
4940024 :memo: add blogs
c6c8609 :memo: update friend link
2
3
4
5
6
不过可以使用 emojify, 使得在命令行也可显示 emoji。emojify 是一个 shell 脚本,安装与使用都很简单,参考官网:github.com/mrowa44/emojify (opens new window)
如果是 Windows,可以用 gitmoji-cli,通过 npm 的方式来使用。官网:github.com/carloscuesta/gitmoji-cli (opens new window)
# IDE 插件
可以在 IDEA 搜索:Gitmoji Plus: Commit Button
安装并重启,可以在 Git 的提交栏看到表情选择框:
点击可以选择相关表情:
VSCode 也推出了类似插件:
提交时的操作是类似的,会出现一个弹框选择 emoji:
# 最后
现代人都不喜欢好好说话,动不动就斗 Emoji,当然这与苹果公司有很大的关系。
自从苹果公司在 iOS 5 输入法中加入了 Emoji 表情后,这种呆萌的表情符号开始席卷全球,已经超越了国籍和文化,让人类能在虚拟世界里表达自己的情绪。
而在 commit msg 里使用 emoji 符号,可以美化提交记录和 GitHub 仓库页面,对提交记录进行分类,提高可读性。
# 参考
Git Commit emoji Guide 提交表情使用指北 (opens new window)
git commit 时使用 Emoji ? - 知乎 (opens new window)