pummit

pummit 🚛

なんだこれは

このような綺麗な形のコミットメッセージを簡単に作成出来ます

• Select Language

使い方 💨

pummitは２つの方法で使用することができます

pummit <emojiprefix> '<subject>'
# or
pummit '<emojiprefix> <subject>'

# Example
pummit sparkles 'I am unko man'
# Run: git commit -m ':sparkles: I am unko man (path/to/added/file, path/to/added/file)'

pummit 'sparkles I am unko man'
# Run: git commit -m ':sparkles: I am unko man (path/to/added/file, path/to/added/file)'

インストール 😊

Homebrewで配布してます。

brew tap hidemaruowo/tap
brew update
brew install pummit

Goがインストールされている場合はこちらを実行してください。

go install github.com/HidemaruOwO/pummit@latest

https://github.com/HidemaruOwO/pummit/releases

インストールされていない場合はReleaseから環境にあったファイルをダウンロードして、以下のコマンドを実行してください。

tar xzvf pummit**.tar.gz
sudo mv pummit /usr/local/bin

ビルド 🔨

git clone https://github.com/HidemaruOwO/pummit.git
cd pummit
go build main.go

依存関係 🪡

pummitを使うには以下のコマンドをパスに登録してください

• git

lazygitで使うには 🔍

以下のキーバインドを.config/lazygit/config.ymlに設定してください

customCommands:
  - key: "c"
    prompts:
      - type: "input"
        title: "Commit message"
        initialValue: ""
    command: "pummit '{{index .PromptResponses 0}}'"
    context: "files"
    description: "commit changes(Custom Command)"

絵文字プレフィックスのサンプル 🌟

# ==================== Emojis ====================
# 🎉  :tada: 初めてのコミット（Initial Commit）
# ♻️   :recycle: マージ(Merge)
# 🔖  :bookmark: バージョンタグ（Version Tag）
# ✨  :sparkles: 新機能（New Feature）
# 🐛  :bug: バグ修正（Bagfix）
# 👀  :eyes: リファクタリング(Refactoring)
# 📚  :books: ドキュメント（Documentation）
# 🎨  :art: デザインUI/UX(Accessibility)
# 🐎  :horse: パフォーマンス（Performance）
# 🔧  :wrench: ツール（Tooling）
# 🚨  :rotating_light: テスト（Tests）
# 💩  :hankey: 非推奨追加（Deprecation）
# 🗑️  :wastebasket: 削除（Removal）
# 🚧  :construction: WIP(Work In Progress)
# ☃️  :snowman: 仕様変更

# ==================== Format ====================
# :emoji: Subject (Dir/AddedFile Dir/AddedFile)
#
# Commit body...

エイリアス機能について 📎

例えばwastebasketを入力するのは少し大変ですが、エイリアス機能を使うとwbで簡単に入力できるようになります。

$ pummit wb モジュールの削除
# Result: :wastebasket: モジュールの削除 (path/to/added/file)

デフォルトで設定されているエイリアスは以下の通りです。

 📎 There is aliases
Alias : Prefix : Emoji
----------------------
  sm : snowman : ☃️
  h : horse : 🐎
  w : wrench : 🔧
  l : rotating_light : 🚨
  p : hankey : 💩
  wb : wastebasket : 🗑️
  c : construction : 🚧
  r : recycle : ♻️
  s : sparkles : ✨
  t : tada : 🎉
  e : eyes : 👀
  b : bug : 🐛
  d : books : 📚
  a : art : 🎨

Add command

このコマンドはエイリアスを追加することが出来ます。

$ pummit alias add 's' 'sparkles'

この場合ではsというエイリアスを入力するだけでコミットメッセージのEmoji prefixにsparklesを代入できるようになります。

$ pummit s 新機能の追加
# Run: git commit -m ':sparkles: 新機能の追加 (path/to/added/file)'

Delete command

このコマンドはエイリアスを削除することが出来ます。

$ pummit alias delete s

この場合では、s=spaklesというエイリアスが登録されている前提でこのコマンドを実行した場合sとsparklesの関連付けがなくなるため、以下のコマンドを実行してもEmoji prefixにはsしか代入されません。

$ pummit s 新機能の追加
# Run: git commmit -m ':s: 新機能の追加 (path/to/added/file)'

また引数に削除したいエイリアスを複数指定することが出来ます。

$ pummit alias delete s sm c h

Delete --all command

このコマンドは登録されているエイリアスを全て削除します。

$ pummit alias delete --all

List command

このコマンドは登録されているエイリアスを全て表示します。

$ pummit alias list

もし、エイリアスにs=sparklesとt=tadaが登録されている場合は以下のように出力されます。

📎 There is aliases
Alias : Prefix : Emoji
  s : sparkles : ✨
  t : tada : 🎉

Reset command

このコマンドをエイリアスをリセットします。

$ pummit alias reset

もし、エイリアスがこのように沢山あって混乱するほどあったり、config.jsonを直接弄ってバグらせてしまったときのリカバリとして使うことが出来ます。

$ pummit alias list
 📎 There is aliases
Alias : Prefix : Emoji
----------------------
  hjjciiiisadsadasda : sparkles : ✨
  w : wrench : 🔧
  s : sparkles : ✨
  l : rotating_light : 🚨
  p : hankey : 💩
  wb : wastebasket : 🗑️
  c : construction : 🚧
  sm : snowman : ☃️
  hj : sparkles : ✨
  hjjjksda : sparkles : ✨
  hjjca : sparkles : ✨
  hjjciiiia : sparkles : ✨
  a : art : 🎨
  h : horse : 🐎
  r : recycle : ♻️
  t : tada : 🎉
  b : bug : 🐛
  e : eyes : 👀
  d : books : 📚

このようにエイリアスが混乱するほどある場合でも

$ pummit alias reset
> May I reset the aliases? :(Y/n) y
[INFO] Alias reseted

 📎 There is aliases
Alias : Prefix : Emoji
----------------------
  sm : snowman : ☃️
  h : horse : 🐎
  w : wrench : 🔧
  l : rotating_light : 🚨
  p : hankey : 💩
  wb : wastebasket : 🗑️
  c : construction : 🚧
  r : recycle : ♻️
  s : sparkles : ✨
  t : tada : 🎉
  e : eyes : 👀
  b : bug : 🐛
  d : books : 📚
  a : art : 🎨

コマンド一つでこのような綺麗な状態に戻せます。

スペシャルサンクス ✨

• Qiita - GitHubのコミットメッセージに絵文字を入れて開発効率をあげる