@zjex/git-workflow 0.2.5 → 0.2.6

package/README.md

@@ -36,6 +36,7 @@
 ## 特性
 
 - ⚡️ **极速上手** - 零配置开箱即用，交互式菜单引导操作
+- 🤖 **AI 智能提交** - 使用 AI 自动分析代码变更生成 commit message（支持 GitHub Models、Groq 等）
 - 🎯 **规范命名** - 自动生成带日期的规范分支名，告别命名混乱
 - 🏷️ **智能版本** - 自动识别当前版本，交互式选择下一版本（支持 semver + 预发布）
 - 📝 **规范提交** - 遵循 Conventional Commits + Gitmoji，提交信息更清晰
@@ -43,6 +44,7 @@
 - ⚙️ **灵活配置** - 支持项目级配置文件，不同项目不同规范
 - 🎨 **优雅交互** - 友好的命令行界面，支持键盘快捷操作
 - 📦 **轻量依赖** - 打包体积小，安装快速无负担
+- 🔔 **版本提醒** - 自动检测新版本，一键更新
 
 ## 快速开始
 
@@ -348,12 +350,58 @@ gw st
 
 遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/) 规范，并自动添加 [Gitmoji](https://gitmoji.dev/) 表情：
 
+#### 🤖 AI 自动生成（推荐）
+
+使用 AI 自动分析代码变更生成 commit message：
+
+```bash
+gw c
+# 已暂存的文件:
+#   src/ai-service.ts
+#   src/commands/commit.ts
+# ────────────────────────────────────────
+# ? 选择 commit 方式:
+# ❯ 🤖 AI 自动生成 commit message
+#   ✍️  手动编写 commit message
+#
+# ✔ AI 生成完成
+#
+# AI 生成的 commit message:
+# feat(ai): 添加 AI commit message 自动生成功能
+# ────────────────────────────────────────
+# ? 使用这个 commit message?
+# ❯ ✅ 使用
+#   ❌ 不使用，切换到手动模式
+```
+
+**特点：**
+
+- ⚡️ 快速：2-3 秒生成
+- 🎯 准确：自动识别 feat/fix/docs 等类型
+- 📝 规范：符合 Conventional Commits
+- 🇨🇳 支持中英文
+- 🔄 可预览、可拒绝、可降级到手动模式
+
+**支持的 AI 提供商：**
+
+- **GitHub Models**（免费，推荐）- 使用 GitHub 账号，每天 150 次
+- **Groq**（免费）- 需要注册，每天 14,400 次
+- **OpenAI**（付费）- 需要 API key
+- **Claude**（付费）- 需要 API key
+- **Ollama**（本地）- 需要安装 Ollama
+
+#### ✍️ 手动编写
+
 ```bash
 gw c
 # 已暂存的文件:
 #   src/index.ts
 #   src/utils.ts
 # ────────────────────────────────────────
+# ? 选择 commit 方式:
+#   🤖 AI 自动生成 commit message
+# ❯ ✍️  手动编写 commit message
+#
 # ? 选择提交类型:
 #   ✨  feat       新功能
 #   🐛  fix        修复 Bug
@@ -369,7 +417,9 @@ gw c
 # ? 输入影响范围 scope (可跳过): auth
 # ? 输入简短描述: add login validation
 # ? 输入详细描述 (可跳过):
-# ? 是否包含破坏性变更 (BREAKING CHANGE)? No
+# ? 是否包含破坏性变更 (BREAKING CHANGE)?
+# ❯ 否
+#   是
 # ? 关联 Issue (如 #123, 可跳过): #42
 # ────────────────────────────────────────
 # 提交信息预览:
@@ -377,11 +427,15 @@ gw c
 #
 # #42
 # ────────────────────────────────────────
-# ? 确认提交? Yes
+# ? 确认提交?
+# ❯ ✅ 确认提交
+#   ❌ 取消
 # ✔ 提交成功
 # commit: a1b2c3d
 ```
 
+#### 自动暂存
+
 如果没有暂存的更改，根据配置决定行为：
 
 **默认行为（`autoStage: true`）：**
@@ -434,7 +488,15 @@ gw c
   "defaultTagPrefix": "v",
   "autoPush": true,
   "autoStage": true,
-  "useEmoji": true
+  "useEmoji": true,
+  "aiCommit": {
+    "enabled": true,
+    "provider": "github",
+    "apiKey": "",
+    "model": "gpt-4o-mini",
+    "language": "zh-CN",
+    "maxTokens": 200
+  }
 }
 ```
 
@@ -453,11 +515,59 @@ gw c
 | `autoStage`        | `boolean` | `true`       | commit 时是否自动暂存所有更改              |
 | `useEmoji`         | `boolean` | `true`       | commit 时是否使用 emoji                    |
 | `commitEmojis`     | `object`  | -            | 自定义各类型 commit 的 emoji               |
+| `aiCommit`         | `object`  | -            | AI commit 配置                             |
+
+#### AI Commit 配置项
+
+| 配置项               | 类型      | 默认值     | 说明                                                          |
+| -------------------- | --------- | ---------- | ------------------------------------------------------------- |
+| `aiCommit.enabled`   | `boolean` | `true`     | 是否启用 AI commit 功能                                       |
+| `aiCommit.provider`  | `string`  | `"github"` | AI 提供商：`github` / `groq` / `openai` / `claude` / `ollama` |
+| `aiCommit.apiKey`    | `string`  | -          | API key，留空使用内置 key                                     |
+| `aiCommit.model`     | `string`  | 根据提供商 | 模型名称                                                      |
+| `aiCommit.language`  | `string`  | `"zh-CN"`  | 生成语言：`zh-CN` / `en-US`                                   |
+| `aiCommit.maxTokens` | `number`  | `200`      | 最大 token 数                                                 |
 
 ### 常见配置场景
 
 <details>
-<summary><b>场景一：强制要求关联 Issue</b></summary>
+<summary><b>场景一：启用 AI Commit（推荐）</b></summary>
+
+```json
+{
+  "aiCommit": {
+    "enabled": true,
+    "provider": "github",
+    "language": "zh-CN"
+  }
+}
+```
+
+**说明：**
+
+- 使用 GitHub Models（免费）
+- 生成中文 commit message
+- 使用内置 API key（开箱即用）
+
+如果想使用自己的 key：
+
+```json
+{
+  "aiCommit": {
+    "enabled": true,
+    "provider": "github",
+    "apiKey": "ghp_your_token_here",
+    "language": "zh-CN"
+  }
+}
+```
+
+获取 GitHub Token：https://github.com/settings/tokens/new
+
+</details>
+
+<details>
+<summary><b>场景二：强制要求关联 Issue</b></summary>
 
 ```json
 {