gitmoji-cliを使って、Gitのコミットメッセージに絵文字を簡単に追加する

Updated

2022.10.15

Published

2020.06.26

gitmojiという、コミットメッセージに関するオープンソースガイドラインがあります。メッセージの先頭に絵文字をつけることで、それぞれのコミットの意味が視覚的にわかりやすくなるというものです。

手動で絵文字を入力すると面倒ですが、gitmoji-cliを使えば、コマンドを打つと絵文字の検索からメッセージの入力、コミットまでをスムーズに行えます。

導入方法

gitmoji-cliのパッケージをインストールします。

npm i -g gitmoji-cli

使い方

gitmoji --help して確認します。

  A gitmoji client for using emojis on commit messages.

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

git commit の代わりに gitmoji -c を入力すると、絵文字の選択からコミットの追加まで実行できます。

キーワードから絵文字の検索だけしたいときは、 gitmoji {keyword} -s を入力します。
ヒットした絵文字が一覧で表示されます。

参考記事

ろくデブログ

gitmoji-cliを使って、Gitのコミットメッセージに絵文字を簡単に追加する

written by

Genta