@zjex/git-workflow 0.3.2 → 0.3.3

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

@@ -1,43 +1,43 @@
 {
-  "hash": "cb9fc065",
+  "hash": "f08de2d7",
   "configHash": "e91271f8",
-  "lockfileHash": "eae41063",
-  "browserHash": "fa434d50",
+  "lockfileHash": "f6311290",
+  "browserHash": "b692a8b2",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "69cff841",
+      "fileHash": "6f2468ef",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "5ad8b965",
+      "fileHash": "1a2fc2f9",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "9696f0e0",
+      "fileHash": "b2503aca",
       "needsInterop": false
     },
     "vitepress > @vueuse/integrations/useFocusTrap": {
       "src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
       "file": "vitepress___@vueuse_integrations_useFocusTrap.js",
-      "fileHash": "6cc36968",
+      "fileHash": "d3937329",
       "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": "08475884",
+      "fileHash": "9d53e58c",
       "needsInterop": false
     },
     "vitepress > minisearch": {
       "src": "../../../../node_modules/minisearch/dist/es/index.js",
       "file": "vitepress___minisearch.js",
-      "fileHash": "1cb3d774",
+      "fileHash": "4ea50106",
       "needsInterop": false
     }
   },

package/docs/.vitepress/config.ts

@@ -61,8 +61,9 @@ export default defineConfig({
             { text: '概览', link: '/commands/' },
             { text: '交互式菜单', link: '/commands/interactive' },
             { text: '分支命令', link: '/commands/branch' },
-            { text: 'Tag 命令', link: '/commands/tag' },
             { text: '提交命令', link: '/commands/commit' },
+            { text: '日志命令', link: '/commands/log' },
+            { text: 'Tag 命令', link: '/commands/tag' },
             { text: 'Stash 命令', link: '/commands/stash' },
             { text: '版本命令', link: '/commands/release' },
             { text: '配置命令', link: '/commands/config' },

package/docs/commands/help.md

@@ -0,0 +1,248 @@
+# gw help - 帮助命令
+
+`gw help` 命令提供了完整的命令帮助信息和使用指南。
+
+## 🎯 功能特性
+
+- 📋 **命令列表** - 显示所有可用命令及其描述
+- 🔍 **详细说明** - 每个命令的具体用法和参数
+- 💡 **使用示例** - 实际的命令使用示例
+- ⌨️ **快捷键** - 交互式界面的键盘操作
+- 🔗 **相关链接** - 文档链接和更多资源
+
+## 📋 命令格式
+
+```bash
+# 显示帮助信息
+gw help
+gw --help
+gw -h
+
+# 显示特定命令的帮助
+gw help <command>
+gw <command> --help
+gw <command> -h
+```
+
+## 🎨 帮助界面
+
+### 主帮助页面
+
+```bash
+gw help
+```
+
+```
+Git Workflow v0.3.2 - 极简的 Git 工作流 CLI 工具
+
+用法:
+  gw [command] [options]
+
+核心命令:
+  gw              显示交互式菜单
+  gw f, feat      创建 feature 分支
+  gw h, hotfix    创建 hotfix 分支
+  gw c, commit    提交代码（支持 AI 生成）
+  gw log, ls, l   查看提交历史（GitHub 风格）
+  gw t, tag       创建版本标签
+  gw d, delete    删除分支
+  gw s, stash     管理 stash
+
+辅助命令:
+  gw r, release   发布版本
+  gw ts, tags     列出标签
+  gw td           删除标签
+  gw tu           修改标签
+  gw init         初始化配置
+  gw upt, update  更新工具
+
+全局选项:
+  -h, --help      显示帮助信息
+  -v, --version   显示版本号
+  --config        指定配置文件路径
+  --no-emoji      禁用 emoji 显示
+
+示例:
+  gw              # 显示交互式菜单
+  gw f            # 创建 feature 分支
+  gw c            # AI 智能提交
+  gw log          # 查看提交历史
+  gw t v          # 创建 v 前缀的标签
+
+更多信息:
+  文档: https://iamzjt-front-end.github.io/git-workflow/
+  问题: https://github.com/iamzjt-front-end/git-workflow/issues
+```
+
+### 特定命令帮助
+
+```bash
+gw help commit
+# 或
+gw c --help
+```
+
+```
+gw commit - 提交代码
+
+用法:
+  gw c [options]
+  gw commit [options]
+
+描述:
+  交互式提交代码，支持 AI 自动生成 commit message
+
+选项:
+  -m, --message <msg>    直接指定 commit message
+  --ai                   强制使用 AI 生成
+  --manual               强制手动输入
+  --no-verify            跳过 pre-commit 钩子
+  --amend                修改上次提交
+  -h, --help             显示帮助信息
+
+示例:
+  gw c                   # 交互式选择提交方式
+  gw c --ai              # 直接使用 AI 生成
+  gw c -m "fix: bug"     # 直接提交指定消息
+  gw c --amend           # 修改上次提交
+
+相关命令:
+  gw log                 # 查看提交历史
+  gw s                   # 管理 stash
+```
+
+## 📚 命令分类帮助
+
+### 分支管理
+
+```bash
+gw help branch
+```
+
+显示所有分支相关命令的帮助：
+- `gw f` - 创建 feature 分支
+- `gw h` - 创建 hotfix 分支
+- `gw d` - 删除分支
+
+### 版本管理
+
+```bash
+gw help tag
+```
+
+显示所有标签相关命令的帮助：
+- `gw t` - 创建标签
+- `gw ts` - 列出标签
+- `gw td` - 删除标签
+- `gw tu` - 修改标签
+
+### 提交管理
+
+```bash
+gw help commit
+```
+
+显示所有提交相关命令的帮助：
+- `gw c` - 提交代码
+- `gw log` - 查看历史
+
+## 🔍 在线帮助
+
+### 快速查找
+
+如果不确定使用哪个命令，可以：
+
+1. **运行交互式菜单**
+   ```bash
+   gw
+   ```
+
+2. **查看完整帮助**
+   ```bash
+   gw help
+   ```
+
+3. **搜索特定功能**
+   ```bash
+   gw help | grep "分支"
+   ```
+
+### 详细文档
+
+每个命令都有详细的在线文档：
+
+- [命令概览](/commands/) - 所有命令的快速参考
+- [分支命令](/commands/branch) - 分支管理详细指南
+- [提交命令](/commands/commit) - 提交和 AI 功能
+- [日志命令](/commands/log) - 提交历史查看
+- [标签命令](/commands/tag) - 版本标签管理
+- [Stash 命令](/commands/stash) - 代码暂存管理
+
+## ⌨️ 交互式帮助
+
+在任何交互式界面中，都可以使用以下快捷键获取帮助：
+
+| 快捷键 | 功能 |
+|--------|------|
+| `h` / `?` | 显示当前界面的帮助 |
+| `Ctrl+H` | 显示全局帮助 |
+| `F1` | 显示详细帮助 |
+| `Esc` | 返回上级菜单 |
+
+## 🛠️ 故障排除
+
+### 常见问题
+
+**Q: 命令不存在或无法识别？**
+```bash
+# 检查安装
+npm list -g @zjex/git-workflow
+
+# 重新安装
+npm install -g @zjex/git-workflow@latest
+```
+
+**Q: 帮助信息显示不完整？**
+```bash
+# 调整终端窗口大小
+# 或使用分页查看
+gw help | less
+```
+
+**Q: 中文显示乱码？**
+```bash
+# 检查终端编码设置
+echo $LANG
+
+# 设置 UTF-8 编码
+export LANG=zh_CN.UTF-8
+```
+
+### 获取支持
+
+如果遇到问题，可以通过以下方式获取帮助：
+
+1. **查看详细日志**
+   ```bash
+   DEBUG=gw:* gw <command>
+   ```
+
+2. **检查配置**
+   ```bash
+   gw init --show-config
+   ```
+
+3. **提交问题**
+   - [GitHub Issues](https://github.com/iamzjt-front-end/git-workflow/issues)
+   - [讨论区](https://github.com/iamzjt-front-end/git-workflow/discussions)
+
+## 📖 更多资源
+
+- 📚 [完整文档](https://iamzjt-front-end.github.io/git-workflow/)
+- 🎥 [视频教程](https://github.com/iamzjt-front-end/git-workflow#videos)
+- 💡 [最佳实践](https://github.com/iamzjt-front-end/git-workflow/wiki)
+- 🔄 [更新日志](https://github.com/iamzjt-front-end/git-workflow/blob/main/CHANGELOG.md)
+
+---
+
+通过 `gw help` 命令，你可以随时获取最新的使用指南和帮助信息。如果有任何疑问，不要犹豫，直接查看帮助或访问在线文档。

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 log`| `ls`, `l`         | 查看提交历史         | `gw log`                |
 | `gw t`  | `tag`             | 创建 tag             | `gw t v`                |
 | `gw d`  | `del`, `delete`   | 删除分支             | `gw d feature/old`      |
 | `gw s`  | `st`, `stash`     | 管理 stash           | `gw s`                  |
@@ -54,13 +55,14 @@ gw
   [2] 🐛 创建 hotfix 分支       gw h
   [3] 🗑️  删除分支               gw d
   [4] 📝 提交代码               gw c
-  [5] 🏷️  创建 tag               gw t
-  [6] 🗑️  删除 tag               gw td
-  [7] ✏️  修改 tag               gw tu
-  [8] 📋 列出 tags              gw ts
-  [9] 📦 发布版本               gw r
-  [a] 💾 管理 stash             gw s
-  [b] ⚙️  初始化配置             gw init
+  [5] 📋 查看提交历史           gw log
+  [6] 🏷️  创建 tag               gw t
+  [7] 🗑️  删除 tag               gw td
+  [8] ✏️  修改 tag               gw tu
+  [9] 📋 列出 tags              gw ts
+  [a] 📦 发布版本               gw r
+  [b] 💾 管理 stash             gw s
+  [c] ⚙️  初始化配置             gw init
   [0] ❓ 帮助
   [q] 退出
 ```
@@ -179,6 +181,7 @@ DEBUG=gw:* gw c
 处理代码提交和提交信息：
 
 - [**gw c**](/commands/commit) - 交互式提交（支持 AI 生成）
+- [**gw log**](/commands/log) - 查看 Git 提交历史（GitHub 风格）
 
 ### 版本管理
 
@@ -268,12 +271,14 @@ gw d
 
 - [**交互式菜单**](/commands/interactive) - 了解主菜单的所有功能
 - [**分支命令**](/commands/branch) - 掌握分支管理的最佳实践
-- [**Tag 命令**](/commands/tag) - 学习版本标签的高级用法
 - [**提交命令**](/commands/commit) - 深入了解 AI 提交和手动提交
+- [**日志命令**](/commands/log) - GitHub 风格的提交历史查看
+- [**Tag 命令**](/commands/tag) - 学习版本标签的高级用法
 - [**Stash 命令**](/commands/stash) - 高效管理代码暂存
 - [**版本命令**](/commands/release) - 自动化版本发布流程
 - [**配置命令**](/commands/config) - 自定义工具行为
 - [**更新命令**](/commands/update) - 保持工具最新状态
+- [**帮助命令**](/commands/help) - 获取详细的使用帮助和故障排除
 
 ## 🔍 命令查找
 
@@ -283,6 +288,7 @@ gw d
 
 - **我想创建分支** → `gw f` (feature) 或 `gw h` (hotfix)
 - **我想提交代码** → `gw c` (commit)
+- **我想查看历史** → `gw log` (log)
 - **我想创建版本** → `gw t` (tag) 或 `gw r` (release)
 - **我想删除分支** → `gw d` (delete)
 - **我想管理 stash** → `gw s` (stash)
@@ -294,6 +300,7 @@ gw d
 - **开始新功能** → `gw f`
 - **修复紧急 Bug** → `gw h`
 - **提交当前更改** → `gw c`
+- **查看项目历史** → `gw log`
 - **发布新版本** → `gw r` + `gw t`
 - **清理旧分支** → `gw d`
 - **暂存当前工作** → `gw s`

package/docs/commands/log.md

@@ -0,0 +1,328 @@
+# gw log - Git 日志查看
+
+`gw log` 命令提供了一个美观、易读的 Git 提交历史查看界面，采用时间线设计和 boxen 边框装饰。
+
+## 🎯 功能特性
+
+- 📅 **按日期分组** - 按提交日期自动分组显示
+- 🎨 **Boxen 边框** - 每个提交都有独立的圆角边框
+- 🔍 **交互式浏览** - 默认使用 `less` 分页器查看
+- 🏷️ **标签和分支** - 清晰展示 Git tags 和分支信息
+- ⚡️ **智能图标** - 根据提交类型自动显示对应图标
+- 🌐 **中文时间** - 本地化的相对时间显示
+
+## 📋 命令格式
+
+```bash
+# 基础用法（交互式分页查看）
+gw log
+
+# 命令别名
+gw ls
+gw l
+```
+
+## 🎨 界面展示
+
+### 实际显示效果
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                    📊 共显示 50 个提交                      │
+└─────────────────────────────────────────────────────────────┘
+
+📅 Commits on 2024-01-12
+
+╭─────────────────────────────────────────────────────────────╮
+│ ✅ test: 完善commit message格式化测试用例                   │
+│                                                             │
+│ 👤 zjex committed 2小时前                                   │
+│ 🔗 #8d74ffa                                                 │
+│ 🌿 HEAD -> main, origin/main                                │
+╰─────────────────────────────────────────────────────────────╯
+
+╭─────────────────────────────────────────────────────────────╮
+│ 🔧 chore: 删除重复的测试文件                               │
+│                                                             │
+│ 👤 zjex committed 3小时前                                   │
+│ 🔗 #746aa87                                                 │
+╰─────────────────────────────────────────────────────────────╯
+
+📅 Commits on 2024-01-11
+
+╭─────────────────────────────────────────────────────────────╮
+│ ✨ feat(log): 实现GitHub风格的提交历史查看                  │
+│                                                             │
+│ 👤 zjex committed 1天前                                     │
+│ 🔗 #a1b2c3d                                                 │
+│ 🔖 tag v0.3.0                                               │
+╰─────────────────────────────────────────────────────────────╯
+```
+
+## 🎯 界面元素说明
+
+### 日期分组
+
+提交历史按日期自动分组：
+- **📅 Commits on YYYY-MM-DD** - 按日期分组的标题
+
+### 提交信息格式
+
+每个提交显示在独立的圆角边框内：
+
+```
+╭─────────────────────────────────────────────────────────────╮
+│ [icon] [commit-subject]                                     │
+│                                                             │
+│ 👤 [author] committed [relative-time]                       │
+│ 🔗 #[short-hash]                                            │
+│ 🌿 [branches]                                               │
+│ 🔖 tag [tags]                                               │
+╰─────────────────────────────────────────────────────────────╯
+```
+
+**字段说明：**
+- **icon** - 根据提交类型自动选择的图标
+- **commit-subject** - 提交主题（支持子任务解析）
+- **author** - 提交作者
+- **relative-time** - 相对时间（中文格式）
+- **short-hash** - 短提交哈希（7位）
+- **branches** - 关联的分支信息
+- **tags** - 关联的 Git 标签
+
+### 提交类型图标
+
+| 关键词 | 图标 | 说明 |
+|--------|------|------|
+| feat, feature | ✨ | 新功能 |
+| fix, bug | 🐛 | Bug修复 |
+| docs, doc | 📚 | 文档更新 |
+| style | 💄 | 代码格式 |
+| refactor | ♻️ | 代码重构 |
+| test | 🧪 | 测试相关 |
+| chore | 🔧 | 杂项任务 |
+| perf | ⚡ | 性能优化 |
+| ci | 👷 | CI配置 |
+| build | 📦 | 构建相关 |
+| revert | ⏪ | 回滚提交 |
+| merge | 🔀 | 合并分支 |
+| release, version | 🔖 | 版本发布 |
+| 其他 | 📝 | 默认图标 |
+
+## ⌨️ 交互式操作
+
+默认使用系统的 `less` 分页器，支持以下操作：
+
+### 导航控制
+
+| 按键 | 功能 |
+|------|------|
+| `↑` / `k` | 向上滚动一行 |
+| `↓` / `j` | 向下滚动一行 |
+| `Page Up` / `b` | 向上翻页 |
+| `Page Down` / `Space` | 向下翻页 |
+| `Home` / `g` | 跳到顶部 |
+| `End` / `G` | 跳到底部 |
+
+### 搜索功能
+
+| 按键 | 功能 |
+|------|------|
+| `/` | 向前搜索 |
+| `?` | 向后搜索 |
+| `n` | 下一个搜索结果 |
+| `N` | 上一个搜索结果 |
+
+### 退出控制
+
+| 按键 | 功能 |
+|------|------|
+| `q` | 退出查看器 |
+| `Ctrl+C` | 强制退出 |
+
+## 🕒 时间格式
+
+时间显示采用中文本地化的相对时间格式：
+
+### 智能时间转换
+
+- **1分钟内** - 显示原始相对时间
+- **60分钟以上** - 自动转换为小时（如：90分钟 → 1小时前）
+- **24小时以上** - 自动转换为天数（如：30小时 → 1天前）
+- **7天以上** - 转换为周数（如：10天 → 1周前）
+- **30天以上** - 转换为月数（如：35天 → 1个月前）
+- **12个月以上** - 转换为年数（如：15个月 → 1年前）
+
+### 格式化规则
+
+原始 Git 输出会被自动转换：
+- `22 minutes ago` → `22分钟前`
+- `3 hours ago` → `3小时前`
+- `2 days ago` → `2天前`
+- `1 week ago` → `1周前`
+
+## 🎨 颜色和样式
+
+### 颜色方案
+
+- **日期标题** - 黄色加粗
+- **提交主题** - 白色加粗
+- **作者名称** - 蓝色
+- **时间信息** - 绿色
+- **哈希值** - 橙色
+- **分支信息** - 浅紫色
+- **标签信息** - 黄色
+- **边框** - 灰色圆角
+
+### 边框样式
+
+使用 `boxen` 库提供的圆角边框：
+- **边框样式** - `round`（圆角）
+- **边框颜色** - `gray`（灰色）
+- **内边距** - 左右各1个字符
+- **外边距** - 底部1行间距
+
+## 🔧 高级功能
+
+### 子任务解析
+
+支持解析包含子任务的提交信息：
+
+```bash
+# 原始提交信息
+feat: 添加用户认证功能 - 实现登录接口 - 添加JWT验证 - 完善错误处理
+
+# 解析后显示
+✨ feat: 添加用户认证功能
+
+  – 实现登录接口
+  – 添加JWT验证
+  – 完善错误处理
+```
+
+### 分支和标签分离显示
+
+智能解析 Git refs 信息：
+
+```bash
+# 分支信息
+🌿 HEAD -> main, origin/main
+
+# 标签信息
+🔖 tag v1.0.0, tag v1.0.0-beta
+```
+
+### 默认显示数量
+
+- **交互式模式** - 默认显示50个提交
+- **非交互式模式** - 默认显示10个提交
+
+## 🛠️ 技术实现
+
+### Git 命令
+
+使用以下 Git 命令获取提交信息：
+
+```bash
+git log --pretty=format:"%H|%h|%s|%an|%ad|%ar|%D" --date=short -50
+```
+
+**格式说明：**
+- `%H` - 完整哈希
+- `%h` - 短哈希
+- `%s` - 提交主题
+- `%an` - 作者名称
+- `%ad` - 作者日期
+- `%ar` - 相对时间
+- `%D` - 引用信息（分支、标签）
+
+### 分页器配置
+
+使用系统 `less` 命令，配置参数：
+- `-R` - 支持ANSI颜色代码
+- `-S` - 不换行长行
+- `-F` - 内容少于一屏时直接退出
+- `-X` - 不清屏
+- `-i` - 忽略大小写搜索
+
+## 🚀 使用场景
+
+### 日常开发
+
+```bash
+# 查看最近的提交历史
+gw log
+
+# 快速浏览（别名）
+gw ls
+gw l
+```
+
+### 代码审查
+
+在分页器中使用搜索功能：
+```bash
+# 启动 gw log 后
+/feat        # 搜索所有新功能提交
+/fix         # 搜索所有修复提交
+/author      # 搜索特定作者
+```
+
+### 版本追踪
+
+查看标签和版本信息：
+```bash
+# 查看包含标签的提交
+gw log
+# 在分页器中搜索: /tag
+```
+
+## 🔍 故障排除
+
+### 常见问题
+
+**Q: 分页器无法启动？**
+```bash
+# 检查 less 是否安装
+which less
+
+# 或设置其他分页器
+export PAGER=more
+gw log
+```
+
+**Q: 颜色显示异常？**
+```bash
+# 强制启用颜色
+FORCE_COLOR=1 gw log
+
+# 或检查终端支持
+echo $TERM
+```
+
+**Q: 中文显示乱码？**
+```bash
+# 设置正确的编码
+export LANG=zh_CN.UTF-8
+export LC_ALL=zh_CN.UTF-8
+```
+
+**Q: 没有提交记录？**
+```bash
+# 检查是否在 Git 仓库中
+git status
+
+# 检查是否有提交
+git log --oneline -1
+```
+
+## 📚 相关命令
+
+- [`gw c`](/commands/commit) - 提交代码
+- [`gw t`](/commands/tag) - 管理标签
+- [`gw r`](/commands/release) - 发布版本
+- [`gw s`](/commands/stash) - 管理 stash
+
+---
+
+`gw log` 提供了一个美观且实用的 Git 提交历史查看体验。通过 boxen 边框装饰和智能的时间格式化，让查看代码历史变得更加直观和愉快。