簡介

czg 源于 commitizen/cz-cli 交互插件中 cz-git 的延伸項目，重新使用 TypeScript 編寫的零依賴獨立的 Node.js 命令行工具。旨在使用交互友好的方式，輔助用戶生成規(guī)范的 git commit message 約定式提交。

首次用戶

1. 使用 x env use czg 即可自動下載并使用

   • 在終端運行 eval "$(curl https://get.x-cmd.com)" 即可完成 x 命令安裝, 詳情參考 x-cmd 官網(wǎng)

2. x-cmd 提供1分鐘教程，其中包含了 czg 命令常用功能的 demo 示例，可以幫你快速上手 czg 。

3. 使用案例:

   

   # 安裝 czg
   x env use czg# 啟用交互式生成 git commit
   czg# 開啟 OpenAI 生成簡短描述模式
   czg ai# 啟動輸出 message 中攜帶 emoji 表情模式
   czg emoji
   

功能特點

1. 輕量級：下載 czg 軟件包不依賴任何第三方庫，僅依賴 Node.js 標準庫，體積小 (1.6MB)。無需額外下載或操作，開箱即用。
2. 交互友好：czg 的提供符合用戶習慣的命令行的交互組件，如模糊搜索、多選框、補全輸入等，旨在讓用戶減少重復輸入，能快捷提交規(guī)范的提交信息。
3. 高度可定制化：czg 提供豐富的自定義配置，用戶還可以編寫JS配置文件，利用已有信息或獲取信息進行動態(tài)配置，從而改變交互組件的交互方式，讓工具更契合用戶習慣和滿足團隊需求，在大型項目庫如 Nx 和 Element UI Plus 等項目中得到廣泛應用。
4. 多種提交模式：czg 可利用選項切換模式，例如在利用 AI 快捷生成簡短描述、在 message 中嵌入 emoji 等等。

競品和相關作品

1. Node.js - commitizen/cz-cli: 早期的的交互式輔助生成約定式提交的命令行工具，但需要搭配交互插件才能使用。
2. Python - commitizen：使用 Python 編寫的交互式輔助生成約定式提交的命令行工具，此外該工具還提供校驗提交信息，生成變更日志等功能。

進一步探索

• czg - 官網(wǎng)
• czg - 官網(wǎng) - 配置模版
• czg - 官網(wǎng) - 使用竅門示例
• czg - GitHub