@zjex/git-workflow 0.4.7 → 0.5.0

package/docs/.vitepress/cache/deps/_metadata.json

@@ -1,43 +1,43 @@
 {
-  "hash": "f08de2d7",
-  "configHash": "e91271f8",
-  "lockfileHash": "f6311290",
-  "browserHash": "b692a8b2",
+  "hash": "34593c6c",
+  "configHash": "87a4fd77",
+  "lockfileHash": "0a4b9561",
+  "browserHash": "34bbb8ad",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "6f2468ef",
+      "fileHash": "d12345be",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "1a2fc2f9",
+      "fileHash": "af4a54c9",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "b2503aca",
+      "fileHash": "086467ba",
       "needsInterop": false
     },
     "vitepress > @vueuse/integrations/useFocusTrap": {
       "src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
       "file": "vitepress___@vueuse_integrations_useFocusTrap.js",
-      "fileHash": "d3937329",
+      "fileHash": "7fb617a4",
       "needsInterop": false
     },
     "vitepress > mark.js/src/vanilla.js": {
       "src": "../../../../node_modules/mark.js/src/vanilla.js",
       "file": "vitepress___mark__js_src_vanilla__js.js",
-      "fileHash": "9d53e58c",
+      "fileHash": "b6046c11",
       "needsInterop": false
     },
     "vitepress > minisearch": {
       "src": "../../../../node_modules/minisearch/dist/es/index.js",
       "file": "vitepress___minisearch.js",
-      "fileHash": "4ea50106",
+      "fileHash": "a184113e",
       "needsInterop": false
     }
   },

package/docs/.vitepress/config.ts

@@ -39,6 +39,7 @@ export default defineConfig({
           text: "核心功能",
           items: [
             { text: "AI 智能提交", link: "/guide/ai-commit" },
+            { text: "AI 代码审查", link: "/guide/ai-review" },
             { text: "分支管理", link: "/guide/branch-management" },
             { text: "Tag 管理", link: "/guide/tag-management" },
             { text: "Stash 管理", link: "/guide/stash-management" },
@@ -69,6 +70,7 @@ export default defineConfig({
             { text: "交互式菜单", link: "/commands/interactive" },
             { text: "分支命令", link: "/commands/branch" },
             { text: "提交命令", link: "/commands/commit" },
+            { text: "AI 代码审查", link: "/commands/review" },
             { text: "日志命令", link: "/commands/log" },
             { text: "修改提交信息", link: "/commands/amend" },
             { text: "修改提交时间", link: "/commands/amend-date" },

package/docs/commands/index.md

@@ -12,6 +12,7 @@ Git Workflow 提供了一套简洁而强大的命令，涵盖了 Git 工作流
 | `gw f`     | `feat`, `feature` | 创建 feature 分支   | `gw f --base develop` |
 | `gw h`     | `fix`, `hotfix`   | 创建 hotfix 分支    | `gw h`                |
 | `gw c`     | `cm`, `commit`    | 提交代码（AI 模式） | `gw c`                |
+| `gw review`| `rw`              | AI 代码审查         | `gw review abc1234`   |
 | `gw log`   | `ls`, `l`         | 查看提交历史        | `gw log`              |
 | `gw amend` | -                 | 修改提交信息        | `gw amend a1b2c3d`    |
 | `gw ad`    | `amend:date`      | 修改提交时间        | `gw ad`               |
@@ -187,6 +188,7 @@ DEBUG=gw:* gw c
 处理代码提交和提交信息：
 
 - [**gw c**](/commands/commit) - 交互式提交（支持 AI 生成）
+- [**gw review**](/commands/review) - AI 代码审查，生成详细审查报告
 - [**gw log**](/commands/log) - 查看 Git 提交历史（GitHub 风格）
 - [**gw amend**](/commands/amend) - 修改指定 commit 的提交信息
 - [**gw ad**](/commands/amend-date) - 修改指定 commit 的提交时间
@@ -281,6 +283,7 @@ gw d
 - [**交互式菜单**](/commands/interactive) - 了解主菜单的所有功能
 - [**分支命令**](/commands/branch) - 掌握分支管理的最佳实践
 - [**提交命令**](/commands/commit) - 深入了解 AI 提交和手动提交
+- [**代码审查**](/commands/review) - AI 智能代码审查
 - [**日志命令**](/commands/log) - GitHub 风格的提交历史查看
 - [**Tag 命令**](/commands/tag) - 学习版本标签的高级用法
 - [**Stash 命令**](/commands/stash) - 高效管理代码暂存
@@ -297,6 +300,7 @@ gw d
 
 - **我想创建分支** → `gw f` (feature) 或 `gw h` (hotfix)
 - **我想提交代码** → `gw c` (commit)
+- **我想审查代码** → `gw review` (AI 代码审查)
 - **我想查看历史** → `gw log` (log)
 - **我想创建版本** → `gw t` (tag) 或 `gw r` (release)
 - **我想删除分支** → `gw brd` (branch delete)

package/docs/commands/review.md

@@ -0,0 +1,142 @@
+# review - AI 代码审查
+
+使用 AI 对代码变更进行智能审查，生成详细的 Markdown 审查报告。
+
+## 基本用法
+
+```bash
+# 交互式选择要审查的 commits
+gw review
+
+# 审查指定的 commit
+gw review abc1234
+
+# 审查多个 commits
+gw review abc1234 def5678
+
+# 审查最近 N 个 commits
+gw review -n 3
+gw review --last 3
+
+# 审查暂存区的更改
+gw review -s
+gw review --staged
+
+# 指定输出文件路径
+gw review -o ./my-review.md
+```
+
+## 命令别名
+
+- `gw rw` - review 的简写
+
+## 选项
+
+| 选项 | 简写 | 说明 |
+|------|------|------|
+| `--last <number>` | `-n` | 审查最近 N 个 commits |
+| `--staged` | `-s` | 审查暂存区的更改 |
+| `--output <path>` | `-o` | 指定输出文件路径 |
+
+## 审查报告
+
+审查报告会保存在 `.gw-reviews/` 目录下，文件名格式为：
+
+```
+review-{commit-hash}-{timestamp}.md
+```
+
+报告内容包括：
+
+1. **变更统计** - 文件数、新增行数、删除行数
+2. **审查的提交** - 相关 commit 信息
+3. **AI 审查结果**
+   - 概述 - 变更内容和整体评价
+   - 问题列表 - 按严重程度分类
+   - 改进建议 - 具体的代码改进建议
+   - 亮点 - 代码中写得好的地方
+
+## 问题严重程度
+
+- 🔴 **严重** - 必须修复的问题（安全漏洞、严重 Bug）
+- 🟡 **警告** - 建议修复的问题（潜在 Bug、性能问题）
+- 🔵 **建议** - 可选的改进（代码风格、最佳实践）
+
+## 审查维度
+
+AI 会从以下维度进行代码审查：
+
+1. **代码质量** - 可读性、可维护性、代码风格
+2. **潜在 Bug** - 空指针、边界条件、异常处理
+3. **安全问题** - SQL 注入、XSS、敏感信息泄露
+4. **性能问题** - 不必要的循环、内存泄漏、重复计算
+5. **最佳实践** - 设计模式、SOLID 原则、DRY 原则
+
+## 配置
+
+AI 审查使用与 AI Commit 相同的配置，在 `.gwrc.json` 中设置：
+
+```json
+{
+  "aiCommit": {
+    "enabled": true,
+    "provider": "github",
+    "apiKey": "your-api-key",
+    "model": "gpt-4o",
+    "language": "zh-CN"
+  }
+}
+```
+
+### 支持的 AI 提供商
+
+| 提供商 | 默认模型 | 说明 |
+|--------|----------|------|
+| `github` | gpt-4o | GitHub Models（推荐） |
+| `openai` | gpt-4o | OpenAI API |
+| `claude` | claude-3-5-sonnet | Anthropic Claude |
+| `ollama` | qwen2.5-coder:14b | 本地 Ollama |
+
+## 示例
+
+### 审查最近的提交
+
+```bash
+$ gw review -n 1
+
+────────────────────────────────────────
+📊 变更统计:
+   文件: 3 个
+   新增: +45 行
+   删除: -12 行
+────────────────────────────────────────
+✔ AI 审查完成
+
+✅ 审查报告已生成: .gw-reviews/review-abc1234-2024-01-20T10-30-00.md
+```
+
+### 交互式选择
+
+```bash
+$ gw review
+
+────────────────────────────────────────
+? 选择要审查的内容 (空格选择，回车确认):
+❯ ◯ 📦 暂存区的更改 (staged changes)
+  ◯ abc1234 feat: 添加用户登录功能 - 张三 (2024-01-20)
+  ◯ def5678 fix: 修复数据获取失败 - 李四 (2024-01-19)
+  ◯ ghi9012 docs: 更新 README - 王五 (2024-01-18)
+```
+
+## 注意事项
+
+1. **API Key 必需** - 除 Ollama 外，其他提供商需要配置 API Key
+2. **代码长度限制** - 过长的 diff 会被截断以避免超出 token 限制
+3. **网络要求** - 需要能够访问 AI 服务的网络环境
+4. **报告目录** - 建议将 `.gw-reviews/` 添加到 `.gitignore`
+
+## 相关命令
+
+- [commit](./commit.md) - AI 辅助提交
+- [log](./log.md) - 查看提交日志
+- [amend](./amend.md) - 修改提交信息

package/docs/guide/ai-review.md

@@ -0,0 +1,159 @@
+# AI 代码审查
+
+AI 代码审查是 Git Workflow 的核心功能之一，使用 AI 对代码变更进行智能审查，生成详细的 Markdown 审查报告。
+
+## 🎯 功能特点
+
+- **智能分析** - AI 自动分析代码变更，识别潜在问题
+- **多维度审查** - 覆盖代码质量、安全、性能、最佳实践等维度
+- **详细报告** - 生成结构化的 Markdown 审查报告
+- **灵活选择** - 支持审查暂存区、指定 commit 或交互式选择
+
+## 🚀 快速开始
+
+```bash
+# 交互式选择要审查的 commits
+gw review
+
+# 审查指定的 commit
+gw review abc1234
+
+# 审查多个 commits
+gw review abc1234 def5678
+
+# 审查最近 N 个 commits
+gw review -n 3
+
+# 审查暂存区的更改
+gw review -s
+```
+
+## 📊 审查维度
+
+AI 会从以下维度进行代码审查：
+
+| 维度 | 说明 | 示例 |
+|------|------|------|
+| **代码质量** | 可读性、可维护性、代码风格 | 命名规范、函数长度、注释完整性 |
+| **潜在 Bug** | 空指针、边界条件、异常处理 | 未处理的 null、数组越界 |
+| **安全问题** | SQL 注入、XSS、敏感信息泄露 | 硬编码密码、未转义输入 |
+| **性能问题** | 不必要的循环、内存泄漏、重复计算 | N+1 查询、大数组遍历 |
+| **最佳实践** | 设计模式、SOLID 原则、DRY 原则 | 代码重复、职责不清 |
+
+## 🔴🟡🔵 问题严重程度
+
+审查报告会按严重程度对问题进行分类：
+
+- 🔴 **严重** - 必须修复的问题（安全漏洞、严重 Bug）
+- 🟡 **警告** - 建议修复的问题（潜在 Bug、性能问题）
+- 🔵 **建议** - 可选的改进（代码风格、最佳实践）
+
+## 📝 审查报告
+
+审查报告会保存在 `.gw-reviews/` 目录下，包含：
+
+1. **变更统计** - 文件数、新增行数、删除行数
+2. **审查的提交** - 相关 commit 信息
+3. **AI 审查结果**
+   - 概述 - 变更内容和整体评价
+   - 问题列表 - 按严重程度分类
+   - 改进建议 - 具体的代码改进建议
+   - 亮点 - 代码中写得好的地方
+
+### 报告示例
+
+```markdown
+# 🔍 代码审查报告
+
+> 生成时间: 2024/1/20 10:30:00
+
+## 📊 变更统计
+
+| 指标 | 数值 |
+|------|------|
+| 文件数 | 3 |
+| 新增行 | +45 |
+| 删除行 | -12 |
+
+## 🤖 AI 审查结果
+
+### 概述
+本次变更主要添加了用户登录功能，整体代码质量良好...
+
+### 问题列表
+
+🔴 **严重问题**
+1. `src/auth.ts:25` - 密码未加密存储
+
+🟡 **警告**
+1. `src/login.ts:42` - 缺少输入验证
+
+🔵 **建议**
+1. `src/utils.ts:18` - 建议使用 const 替代 let
+```
+
+## ⚙️ 配置
+
+AI 审查使用与 AI Commit 相同的配置：
+
+```json
+{
+  "aiCommit": {
+    "enabled": true,
+    "provider": "github",
+    "apiKey": "your-api-key",
+    "model": "gpt-4o",
+    "language": "zh-CN"
+  }
+}
+```
+
+### 支持的 AI 提供商
+
+| 提供商 | 默认模型 | 说明 |
+|--------|----------|------|
+| `github` | gpt-4o | GitHub Models（推荐，免费） |
+| `openai` | gpt-4o | OpenAI API |
+| `claude` | claude-3-5-sonnet | Anthropic Claude |
+| `ollama` | qwen2.5-coder:14b | 本地 Ollama（离线可用） |
+
+## 💡 使用技巧
+
+### 1. 提交前审查
+
+在提交代码前，先审查暂存区的更改：
+
+```bash
+git add .
+gw review -s
+# 根据审查结果修改代码
+gw c
+```
+
+### 2. Code Review 辅助
+
+在进行代码审查时，先用 AI 审查相关 commits：
+
+```bash
+# 审查某个 PR 的所有 commits
+gw review abc1234 def5678 ghi9012
+```
+
+### 3. 定期代码审计
+
+定期审查最近的提交，发现潜在问题：
+
+```bash
+# 审查最近 10 个 commits
+gw review -n 10
+```
+
+## 📋 命令参考
+
+详细的命令选项请参考 [review 命令文档](/commands/review)。
+
+## 🔗 相关功能
+
+- [AI 智能提交](/guide/ai-commit) - AI 自动生成 commit message
+- [提交命令](/commands/commit) - 交互式提交代码
+- [日志命令](/commands/log) - 查看提交历史

package/docs/guide/index.md

@@ -25,6 +25,7 @@ Git Workflow 遵循"少即是多"的设计理念：
 利用现代技术提升开发体验：
 
 - **AI 智能提交** - 自动分析代码变更生成提交信息
+- **AI 代码审查** - 智能审查代码变更，生成详细审查报告
 - **智能版本递增** - 根据现有版本自动推荐下一版本
 - **智能分支检测** - 自动检测基础分支和远程状态
 
@@ -132,6 +133,7 @@ Git Workflow 遵循"少即是多"的设计理念：
 - ✅ 分支管理（创建、删除、命名规范）
 - ✅ Tag 管理（创建、删除、版本递增）
 - ✅ 提交管理（AI 生成、规范格式）
+- ✅ AI 代码审查（智能审查、详细报告）
 - ✅ Stash 管理（可视化操作）
 - ✅ 版本发布（package.json 更新）
 - ✅ 配置系统（项目级、全局配置）

package/docs/index.md

@@ -20,6 +20,9 @@ features:
   - icon: 🤖
     title: AI 智能提交
     details: 使用 AI 自动分析代码变更生成 commit message，支持 GitHub Models、OpenAI 等多种提供商
+  - icon: 🔍
+    title: AI 代码审查
+    details: AI 智能审查代码变更，生成详细的 Markdown 审查报告，支持多 commit 批量审查
   - icon: 🎯
     title: 规范命名
     details: 自动生成带日期的规范分支名，如 feature/20260109-PROJ-123-add-login
@@ -41,9 +44,6 @@ features:
   - icon: ⚙️
     title: 灵活配置
     details: 支持项目级和全局配置，不同项目可使用不同规范
-  - icon: 🔔
-    title: 版本提醒
-    details: 自动检测新版本，一键更新，保持工具始终最新
 ---
 
 ## 🎯 为什么选择 Git Workflow？
@@ -118,6 +118,28 @@ gw c
 # ✨ feat(auth): 添加用户登录功能
 ```
 
+### 🔍 AI 代码审查
+
+使用 AI 对代码变更进行智能审查，生成详细的 Markdown 审查报告：
+
+```bash
+gw review
+# ? 选择要审查的内容 (空格选择，回车确认):
+# ❯ ◯ 📦 暂存区的更改 (staged changes)
+#   ◯ abc1234 feat: 添加用户登录功能 - 张三 (2024-01-20)
+#   ◯ def5678 fix: 修复数据获取失败 - 李四 (2024-01-19)
+#
+# 📊 变更统计:
+#    文件: 3 个
+#    新增: +45 行
+#    删除: -12 行
+# ────────────────────────────────────────
+# ✔ AI 审查完成
+# ✅ 审查报告已生成: .gw-reviews/review-abc1234-2024-01-20T10-30-00.md
+```
+
+审查报告包含：问题严重程度分类（🔴 严重 / 🟡 警告 / 🔵 建议）、具体代码改进建议、安全和性能问题检测。
+
 ### 🎯 规范分支命名
 
 自动生成带日期的规范分支名，支持自定义前缀和 ID 标签：
@@ -193,6 +215,7 @@ gw s
 | 分支命名规范     | ✅ 自动生成   | ❌ 需手动   | ❌ 需手动 |
 | 版本号管理       | ✅ 智能递增   | ❌ 需手动   | ❌ 需手动 |
 | AI Commit        | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
+| AI 代码审查      | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
 | 提交历史查看     | ✅ GitHub风格 | ❌ 不支持   | ⚠️ 原生命令 |
 | Stash 可视化管理 | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
 | 交互式操作       | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zjex/git-workflow",
-	"version": "0.4.7",
+	"version": "0.5.0",
 	"description": "🚀 极简的 Git 工作流 CLI 工具，让分支管理和版本发布变得轻松愉快",
 	"type": "module",
 	"bin": {