Git Commit emoji Guide  提交表情使用指北

前言

gitmoji是一个标准化和解释在GitHub提交消息上使用emoji的倡议。 gitmoji 是一个开源项目，专门规定了在 github 提交代码时应当遵循的 emoji 规范

在git commit上使用emoji提供了一种简单的方法，仅通过查看所使用的表情符号来确定提交的目的或意图。

概述

在执行 git commit 指令时使用 emoji图标为本次提交添加一个特别的图标， 这个本次提交的记录很容易突出重点，或者说光看图标就知道本次提交的目的。这样就方便在日后查看历史提交日子记录中快速的查找到对于的提交版本。由于有很多不同的表情符号，表情库更新后，没有一个可以帮助更轻松地使用表情符号的中文表情库列表。所以这里主要列出 gitmoji项目中规定的emoji规范的表情符号列表。

gitmoji 表情库

Windows Emoji 安装特殊符号更新

如果你的电脑是Windows系统无法显示表情符号，那需要Windows 7 字体库中将安装有 Segoe UI 符号 5.01 版本。下载地址：KB2729094

安装完成后，可以进入测试地址进行测试

效果展示

gitmoji的使用效果，可以去 github moji 看看使用 emoji后效果如下：

快速入门

快捷方式

将上面的gitmoji 表情库内容放入一个普通的文本文件 git-emoji-list.md，将文件放入到path环境变量指向的位置，方便需要查看的时候能直接访问查看。

$ alias emoji='cat $PATH/git-emoji-list.md'
$ emoji

使用方法

git commit时直接在注释中写入表情符号的代码部分即可完成表情emoji的提交。

举个栗子：

$ git commit -m ':tada: init commit'
$ git commit -m 'added image to repo :art:'

效果展示：

格式与规则

git commit 时，提交信息遵循以下格式：

:emoji1: :emoji2: 不超过 50 个字的摘要，简短描述本次提交，首字母大写，句末不要加句号
提交信息主体，可以详细的信息
引用相关 issue 或 PR 、jira的编号<#110>

简短格式示例：

$ git commit -m ":tada: Initialize Repo"

完整格式示例：

$ git commit -m ':sparkles: Add characters count for commit title (#101) \
:sparkles: Add title characters count \
:white_check_mark: Update spec \
:bookmark: Bump version to 1.8.8 issue #101 '

github上注释效果如下：

github在网页上使用emoji

在github上提交注释，也可以通过其他项目快速查找emoji表情符号。 Emoji searcher 列举出了上百上千的表情符号。

或者在浏览器安装插件的方式

但很多符号不适合软件程序界使用，软件行业的工程师还是使用 gitmoji

emojify 在命令行中显示 emoji

默认情况下，在命令行中并不会显示出 emoji, 仅显示 emoji 的符号代码或空字符符号。

要解决这种情况，可以使用 emojify 工具使得在命令行也可显示 emoji表情， 它是一个 shell 脚本，安装与使用都很简单，在 这里 查看官方操作手册如何安装与使用。

安装 emojify

基本上emojify替换许多服务（如GitHub）用于表情符号原始字符的表情符号别名。emojify是一个shell脚本，所以把它放在某个地方并确保它被添加到你的$PATH变量中。

$ sudo sh -c "curl https://raw.githubusercontent.com/mrowa44/emojify/master/emojify -o /usr/local/bin/emojify && chmod +x /usr/local/bin/emojify"

Win7 下安装姿势

安装了 git bash 或者 其他第三方的Linux 的shell工具

$ curl https://raw.githubusercontent.com/mrowa44/emojify/master/emojify -o /usr/bin/emojify

如果安装后不能使用，可以将路径配置在环境变量的Path变量中。

PATH=/usr/bin/

使用 emojify

$ emojify "Hey, I just :raising_hand: you, and this is :scream: , but here's my :calling: , so :telephone_receiver: me, maybe?"

被替换成表情

在使用 git bash 的时候，设置替换日志中的表情符号代码

$ git log --oneline --color | emojify | less -r

或者设置git log命令别名

$ alias gitlog='git log --oneline --color | emojify | less -r'

$ gitlog 

效果如下：

gitmoji-cli交互式客户端

交互式客户端是方便在终端使用 emoji符号，开源项目提供了终端工具 gitmoji-cli

安装

需要使用npm，如果没有安装需要单独安装npm工具

$ npm i -g gitmoji-cli

使用

$ gitmoji --help
A gitmoji interactive client for using gitmojis on commit messages.

  Usage
    $ gitmoji
  Options
    --init, -i      Initialize gitmoji as a commit hook
    --remove, -r    Remove a previously initialized commit hook
    --config, -g    Setup gitmoji-cli preferences.
    --commit, -c    Interactively commit using the prompts
    --list, -l      List all the available gitmojis
    --search, -s    Search gitmojis
    --version, -v   Print gitmoji-cli installed version
    --update, -u    Sync emoji list with the repo

查看 emoji 列表

$ gitmoji -l

查找 emoji 表情

$ gitmoji bug linter -s

Windows 无法显示 emoji 符号和表情

由于win7/8 平台无法显示 emoji 表情或符号，但是为了方便查找对应表情可以将表情在 cli 终端显示用中文展示。

本地化翻译

找到gitmojis.json文件，在目录 C:\Users\xxx\.gitmoji 下。打开gitmojis.json文件将 emoji内容修改成中文，顺便将description描述也翻译成中文。下载翻译好的 json文件

[{"emoji":"馃帹","entity":"🎨","code":":art:","description":"Improving structure / format of the code.","name":"art"}

高亮格式化输出

修改后的json可以直接显示中文，基本满足使用效果。同时修改下 gitmoji 的命令输出效果，格式化下输出和颜色高亮。修改文件 $node_path\node_global\node_modules\gitmoji-cli\src\gitmoji.js文件的 _parseGitmojis方法

  _parseGitmojis (gitmojis) {
    return gitmojis.map(gitmoji => {
      const emoji = gitmoji.emoji
      const code = gitmoji.code
      const description = gitmoji.description

      return console.log('\x1B[33m%s\x1B[39m \t-\t \x1B[34m%s\x1B[39m \t-\t %s', emoji, chalk.blue(code), description)
    })
  }

效果展示

$ gitmoji -l

$ gitmoji bug linter -s

参考资料

https://github.com/mrowa44/emojify

https://github.com/muan/emoji

https://github.com/carloscuesta/gitmoji