mos note.

勉強のメモと執筆の練習を兼ねて。

コミットに絵文字を追加するルールを設けてみた 🎉

絵文字Prefix に出会って早一ヶ月。

f:id:mozchan:20181220225720p:plain

  • 見た目が綺麗 ✨
  • コミットするのが楽しい 😁
  • 何より可愛い ❤️

一方で...

現れた!救世主!! gitmoji-cli の導入 🎉

これを使えば、絵文字を 入力 選択 するだけ ✨

その他、使い勝手を良くするために自身が行ったことをご紹介します。

使用する絵文字のカスタマイズ

絵文字の設定ファイルは、 ~/.gitmoji/gitmojis.json にあります。
圧縮された JSON コードを整形してから始めると良いです。

(参考までに)カスタマイズ後のソースコード

f:id:mozchan:20181222150748p:plain
カスタマイズ後の絵文字リスト(一部)

💡注意

gitmoji-cli をアップデートすると gitmoji.json が 初期状態に戻る or アップデート されます。カスタマイズする場合は、JSON ファイルをバージョン管理しておくことをおすすめします。

コミット時の絵文字タイプ

初期設定 😄→ :smile: に変更した方がよいです。

f:id:mozchan:20181222012644p:plain
初期設定の変更

😄でコミットすると、Sourcetree では正しく表示されないようです。
GitHub では、どちらでも正しく表示されました。

[番外編] .gitconfig の commit.template をコメントアウト

既に .gitconfig の commit.template を設定している場合は、コメントアウトする必要があります。

# [commit]
#   template = ~/.gitmessage

これやらないでいたら、エラーでました 😅

まとめ

gitmoji-cli は今のところ使いやすい印象。タイポ もなくなり、捗っています!
ただ、gitmoji にならって絵文字を増やしてみたものの、使いこなせるのかどうかが懸念点。使ってみて取捨選択していこうと思います。

それと... 本来 絵文字Prefix は、コミットの種類を表すことを目的にしているのですが、始めて間もない私には、絵文字だけで種類を理解することができません。なので、絵文字Prefix の他に コミットの種類を表す形容詞(英語)も追加して対応しています。

例)新機能を追加した場合  
✨ Add: ●●を追加

いつか形容詞なしでも運用できる日をめざして ✊
追記:2019/1/14
一ヶ月使ってみて形容詞ありの方が分かりやすいと思った。