@zjex/git-workflow 0.3.2 → 0.3.4

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 边框装饰和智能的时间格式化，让查看代码历史变得更加直观和愉快。

package/docs/index.md

@@ -23,6 +23,9 @@ features:
   - icon: 🎯
     title: 规范命名
     details: 自动生成带日期的规范分支名，如 feature/20260109-PROJ-123-add-login
+  - icon: 📋
+    title: 优雅日志
+    details: GitHub 风格的提交历史查看，时间线分组，交互式浏览，支持搜索和过滤
   - icon: 🏷️
     title: 智能版本
     details: 自动识别当前版本，交互式选择下一版本，支持 semver + 预发布版本
@@ -126,6 +129,32 @@ gw f
 # ✔ 分支创建成功: feature/20260109-PROJ-123-add-user-login
 ```
 
+### 📋 优雅的提交历史
+
+GitHub 风格的提交历史查看，让代码历史一目了然：
+
+```bash
+gw log
+# ┌─────────────────────────────────────────────────────────────────────────────┐
+# │                                Git 提交历史                                │
+# ├─────────────────────────────────────────────────────────────────────────────┤
+# │                                                                             │
+# │ 📅 今天                                                                     │
+# │                                                                             │
+# │ ✅ test: 完善commit message格式化测试用例                                   │
+# │    🔗 #8d74ffa • 2小时前 • zjex                                            │
+# │                                                                             │
+# │ 🔧 chore: 删除重复的测试文件                                               │
+# │    🔗 #746aa87 • 3小时前 • zjex                                            │
+# │                                                                             │
+# │ 📅 昨天                                                                     │
+# │                                                                             │
+# │ ✨ feat(log): 实现GitHub风格的提交历史查看                                  │
+# │    🔗 #a1b2c3d • 1天前 • zjex                                              │
+# │    🔖 v0.3.0                                                               │
+# └─────────────────────────────────────────────────────────────────────────────┘
+```
+
 ### 🏷️ 智能版本管理
 
 自动检测现有 tag 前缀，智能递增版本号：
@@ -164,6 +193,7 @@ gw s
 | 分支命名规范     | ✅ 自动生成   | ❌ 需手动   | ❌ 需手动 |
 | 版本号管理       | ✅ 智能递增   | ❌ 需手动   | ❌ 需手动 |
 | AI Commit        | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
+| 提交历史查看     | ✅ GitHub风格 | ❌ 不支持   | ⚠️ 原生命令 |
 | Stash 可视化管理 | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
 | 交互式操作       | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
 | 配置灵活性       | ✅ 项目级配置 | ⚠️ 有限     | -         |
@@ -187,7 +217,8 @@ Git Workflow 提供优雅的命令行界面，支持键盘快捷操作：
   [2] 🐛 创建 hotfix 分支       gw h
   [3] 🗑️  删除分支               gw d
   [4] 📝 提交代码               gw c
-  [5] 🏷️  创建 tag               gw t
+  [5] 📋 查看提交历史           gw log
+  [6] 🏷️  创建 tag               gw t
   ...
 ```
 

package/package.json

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

package/scripts/format-commit-msg.js

@@ -0,0 +1,258 @@
+#!/usr/bin/env node
+
+/**
+ * Commit Message Emoji 格式化工具
+ * 
+ * 功能：
+ * 1. 检测 commit message 是否包含 emoji
+ * 2. 如果没有 emoji，根据 type 自动添加
+ * 3. 如果有 emoji 但与 type 不匹配，自动替换
+ * 4. 支持 Conventional Commits 规范
+ */
+
+import { readFileSync, writeFileSync, existsSync } from 'fs';
+import { homedir } from 'os';
+import path from 'path';
+
+// Emoji 映射表
+const EMOJI_MAP = {
+  feat: '✨',
+  fix: '🐛', 
+  docs: '📝',
+  style: '💄',
+  refactor: '♻️',
+  perf: '⚡️',
+  test: '✅',
+  build: '📦',
+  ci: '👷',
+  chore: '🔧',
+  revert: '⏪',
+  merge: '🔀',
+  release: '🔖',
+  hotfix: '🚑',
+  security: '🔒',
+  breaking: '💥'
+};
+
+/**
+ * 解析 commit message
+ * @param {string} message - commit message
+ * @returns {object} 解析结果
+ */
+function parseCommitMessage(message) {
+  // 移除开头和结尾的空白字符
+  const cleanMessage = message.trim();
+  
+  // 检测是否以已知的emoji开头
+  const allEmojis = Object.values(EMOJI_MAP);
+  let hasEmoji = false;
+  let currentEmoji = null;
+  let messageWithoutEmoji = cleanMessage;
+  
+  for (const emoji of allEmojis) {
+    if (cleanMessage.startsWith(emoji)) {
+      hasEmoji = true;
+      currentEmoji = emoji;
+      messageWithoutEmoji = cleanMessage.substring(emoji.length).trim();
+      break;
+    }
+  }
+  
+  // 如果没有找到已知emoji，检查是否以其他emoji开头
+  if (!hasEmoji) {
+    const emojiMatch = cleanMessage.match(/^(\p{Emoji})\s*/u);
+    if (emojiMatch) {
+      hasEmoji = true;
+      currentEmoji = emojiMatch[1];
+      messageWithoutEmoji = cleanMessage.replace(/^(\p{Emoji})\s*/u, '').trim();
+    }
+  }
+  
+  // 解析 Conventional Commits 格式: type(scope): subject
+  const conventionalMatch = messageWithoutEmoji.match(/^(\w+)(\([^)]+\))?(!)?:\s*(.+)/);
+  
+  if (!conventionalMatch) {
+    return {
+      isConventional: false,
+      hasEmoji,
+      currentEmoji,
+      originalMessage: message,
+      cleanMessage: messageWithoutEmoji
+    };
+  }
+  
+  const [, type, scope, breaking, subject] = conventionalMatch;
+  
+  return {
+    isConventional: true,
+    hasEmoji,
+    currentEmoji,
+    type: type.toLowerCase(),
+    scope: scope || '',
+    breaking: breaking === '!',
+    subject,
+    originalMessage: message,
+    cleanMessage: messageWithoutEmoji,
+    messageWithoutEmoji
+  };
+}
+
+/**
+ * 获取正确的 emoji
+ * @param {string} type - commit type
+ * @returns {string} emoji
+ */
+function getCorrectEmoji(type) {
+  return EMOJI_MAP[type] || EMOJI_MAP.chore;
+}
+
+/**
+ * 检查 emoji 是否匹配 type
+ * @param {string} emoji - 当前 emoji
+ * @param {string} type - commit type
+ * @returns {boolean} 是否匹配
+ */
+function isEmojiCorrect(emoji, type) {
+  return emoji === getCorrectEmoji(type);
+}
+
+/**
+ * 格式化 commit message
+ * @param {string} message - 原始 commit message
+ * @returns {object} 格式化结果
+ */
+function formatCommitMessage(message) {
+  const parsed = parseCommitMessage(message);
+  
+  // 如果不是 Conventional Commits 格式，不处理
+  if (!parsed.isConventional) {
+    return {
+      needsUpdate: false,
+      originalMessage: message,
+      formattedMessage: message,
+      reason: 'Not a conventional commit format'
+    };
+  }
+  
+  const correctEmoji = getCorrectEmoji(parsed.type);
+  let needsUpdate = false;
+  let reason = '';
+  
+  // 检查是否需要更新
+  if (!parsed.hasEmoji) {
+    needsUpdate = true;
+    reason = `Added missing emoji for type '${parsed.type}'`;
+  } else if (!isEmojiCorrect(parsed.currentEmoji, parsed.type)) {
+    needsUpdate = true;
+    reason = `Replaced incorrect emoji '${parsed.currentEmoji}' with '${correctEmoji}' for type '${parsed.type}'`;
+  }
+  
+  // 构建格式化后的消息
+  const formattedMessage = needsUpdate 
+    ? `${correctEmoji} ${parsed.messageWithoutEmoji}`
+    : message;
+  
+  return {
+    needsUpdate,
+    originalMessage: message,
+    formattedMessage,
+    reason,
+    type: parsed.type,
+    currentEmoji: parsed.currentEmoji,
+    correctEmoji
+  };
+}
+
+/**
+ * 检查用户配置是否启用 emoji
+ * @returns {boolean} 是否启用 emoji
+ */
+function isEmojiEnabled() {
+  try {
+    // 尝试读取配置文件
+    const configPaths = ['.gwrc.json', '.gwrc', 'gw.config.json'];
+    
+    for (const configPath of configPaths) {
+      try {
+        if (existsSync(configPath)) {
+          const config = JSON.parse(readFileSync(configPath, 'utf-8'));
+          if (config.useEmoji !== undefined) {
+            return config.useEmoji;
+          }
+        }
+      } catch {
+        // 继续尝试下一个配置文件
+      }
+    }
+    
+    // 尝试读取全局配置
+    try {
+      const globalConfigPath = path.join(homedir(), '.gwrc.json');
+      if (existsSync(globalConfigPath)) {
+        const globalConfig = JSON.parse(readFileSync(globalConfigPath, 'utf-8'));
+        if (globalConfig.useEmoji !== undefined) {
+          return globalConfig.useEmoji;
+        }
+      }
+    } catch {
+      // 忽略全局配置错误
+    }
+    
+    // 默认启用 emoji
+    return true;
+  } catch {
+    return true;
+  }
+}
+
+/**
+ * 主函数
+ */
+function main() {
+  // 获取 commit message 文件路径
+  const commitMsgFile = process.argv[2];
+  
+  if (!commitMsgFile) {
+    console.error('Error: No commit message file provided');
+    process.exit(1);
+  }
+  
+  try {
+    // 检查是否启用 emoji
+    if (!isEmojiEnabled()) {
+      // 如果禁用了 emoji，直接退出
+      process.exit(0);
+    }
+    
+    // 读取 commit message
+    const originalMessage = readFileSync(commitMsgFile, 'utf-8').trim();
+    
+    // 跳过空消息或合并消息
+    if (!originalMessage || originalMessage.startsWith('Merge ')) {
+      process.exit(0);
+    }
+    
+    // 格式化消息
+    const result = formatCommitMessage(originalMessage);
+    
+    // 如果需要更新
+    if (result.needsUpdate) {
+      // 写入格式化后的消息
+      writeFileSync(commitMsgFile, result.formattedMessage + '\n');
+      
+      // 输出提示信息
+      console.log(`\n🎨 Commit message formatted:`);
+      console.log(`   ${result.reason}`);
+      console.log(`   Before: ${result.originalMessage}`);
+      console.log(`   After:  ${result.formattedMessage}\n`);
+    }
+    
+    process.exit(0);
+  } catch (error) {
+    console.error('Error formatting commit message:', error.message);
+    process.exit(0); // 不阻止提交，只是跳过格式化
+  }
+}
+
+// 运行主函数
+main();