Skip to content

Latest commit

 

History

History
283 lines (214 loc) · 7.14 KB

README.zh-TW.md

File metadata and controls

283 lines (214 loc) · 7.14 KB

普米特🚛

Test CLI最終コミットリポジトリのスター問題オープンな問題バグの問題

image

這是什麼?

您可以輕鬆創建像這樣的漂亮提交訊息。

image
  • 選擇語言
🎌日本語 🤡English 🐉简体中文 🍜繁体中文 🌸한국어

如何使用💨

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輸入起來有點困難,但是如果使用alias功能就可以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 : 🎨

新增命令

此命令允許您新增別名。

$ pummit alias add 's' 'sparkles'

在這種情況下s只需在提交訊息中輸入別名“表情符號前綴”即可。sparkles將能夠被替代。

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

刪除命令

此命令允許您刪除別名。

$ pummit alias delete s

在這種情況下,s=spakles如果您執行此命令並假設別名已註冊ssparkles由於 Emoji 前綴的關聯將會遺失,因此即使執行以下命令,Emoji 前綴也不會被關聯s僅被分配。

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

您也可以指定多個要刪除的別名作為參數。

$ pummit alias delete s sm c h

刪除 --all 命令

此命令刪除所有已註冊的別名。

$ pummit alias delete --all

列表命令

此指令顯示所有已註冊的別名。

$ pummit alias list

如果別名s=sparklest=tada如果已註冊,將輸出以下內容。

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

重設指令

此命令重置別名。

$ 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 : 🎨

您只需一個命令即可將其恢復到這種美麗的狀態。

特別感謝✨