@zjex/git-workflow 0.3.2 → 0.3.3

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.3",
 	"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();

package/src/ai-service.ts

@@ -60,7 +60,7 @@ function getGitDiff(): string {
 /**
  * 构建 AI prompt
  */
-function buildPrompt(diff: string, language: string, detailedDescription: boolean = false): string {
+function buildPrompt(diff: string, language: string, detailedDescription: boolean = false, useEmoji: boolean = true): string {
   const isZh = language === "zh-CN";
 
   if (detailedDescription) {
@@ -69,7 +69,7 @@ function buildPrompt(diff: string, language: string, detailedDescription: boolea
       ? `你是一个专业的 Git commit message 生成助手。请根据提供的 git diff 生成符合 Conventional Commits 规范的详细 commit message。
 
 格式要求：
-1. 第一行：<type>(<scope>): <subject>
+1. 第一行：${useEmoji ? '<emoji> ' : ''}<type>(<scope>): <subject>
 2. 空行
 3. 详细描述：列出主要修改点，每个修改点一行，以 "- " 开头
 
@@ -80,9 +80,22 @@ function buildPrompt(diff: string, language: string, detailedDescription: boolea
 - 详细描述要列出 3-6 个主要修改点，每个修改点简洁明了
 - 如果修改较少，可以只列出 2-3 个修改点
 - 不要有其他解释或多余内容
+${useEmoji ? `
+Emoji 映射规则：
+- feat: ✨ (新功能)
+- fix: 🐛 (修复Bug)
+- docs: 📝 (文档)
+- style: 💄 (代码格式)
+- refactor: ♻️ (重构)
+- perf: ⚡️ (性能优化)
+- test: ✅ (测试)
+- build: 📦 (构建)
+- ci: 👷 (CI/CD)
+- chore: 🔧 (其他杂项)
+- revert: ⏪ (回滚)` : ''}
 
 示例：
-feat(auth): 添加用户登录功能
+${useEmoji ? '✨ ' : ''}feat(auth): 添加用户登录功能
 
 - 实现用户名密码登录接口
 - 添加登录状态验证中间件
@@ -91,7 +104,7 @@ feat(auth): 添加用户登录功能
       : `You are a professional Git commit message generator. Generate a detailed commit message following Conventional Commits specification based on the provided git diff.
 
 Format requirements:
-1. First line: <type>(<scope>): <subject>
+1. First line: ${useEmoji ? '<emoji> ' : ''}<type>(<scope>): <subject>
 2. Empty line
 3. Detailed description: List main changes, one per line, starting with "- "
 
@@ -102,9 +115,22 @@ Rules:
 - Detailed description should list 3-6 main changes, each change should be concise
 - If changes are minimal, list 2-3 changes
 - No explanations or extra content
+${useEmoji ? `
+Emoji mapping rules:
+- feat: ✨ (new feature)
+- fix: 🐛 (bug fix)
+- docs: 📝 (documentation)
+- style: 💄 (code style)
+- refactor: ♻️ (refactoring)
+- perf: ⚡️ (performance)
+- test: ✅ (testing)
+- build: 📦 (build)
+- ci: 👷 (CI/CD)
+- chore: 🔧 (chore)
+- revert: ⏪ (revert)` : ''}
 
 Example:
-feat(auth): add user login functionality
+${useEmoji ? '✨ ' : ''}feat(auth): add user login functionality
 
 - Implement username/password login API
 - Add login status validation middleware
@@ -122,31 +148,57 @@ feat(auth): add user login functionality
       ? `你是一个专业的 Git commit message 生成助手。请根据提供的 git diff 生成符合 Conventional Commits 规范的 commit message。
 
 规则：
-1. 格式：<type>(<scope>): <subject>
+1. 格式：${useEmoji ? '<emoji> ' : ''}<type>(<scope>): <subject>
 2. type 必须是以下之一：feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
 3. scope 是可选的，表示影响范围
 4. subject 用中文描述，简洁明了，不超过 50 字
 5. 只返回一条 commit message，即使有多个文件改动也要总结成一条
 6. 不要有其他解释或多余内容
+${useEmoji ? `
+Emoji 映射规则：
+- feat: ✨ (新功能)
+- fix: 🐛 (修复Bug)
+- docs: 📝 (文档)
+- style: 💄 (代码格式)
+- refactor: ♻️ (重构)
+- perf: ⚡️ (性能优化)
+- test: ✅ (测试)
+- build: 📦 (构建)
+- ci: 👷 (CI/CD)
+- chore: 🔧 (其他杂项)
+- revert: ⏪ (回滚)` : ''}
 
 示例：
-- feat(auth): 添加用户登录功能
-- fix(api): 修复数据获取失败的问题
-- docs(readme): 更新安装说明`
+- ${useEmoji ? '✨ ' : ''}feat(auth): 添加用户登录功能
+- ${useEmoji ? '🐛 ' : ''}fix(api): 修复数据获取失败的问题
+- ${useEmoji ? '📝 ' : ''}docs(readme): 更新安装说明`
       : `You are a professional Git commit message generator. Generate a commit message following Conventional Commits specification based on the provided git diff.
 
 Rules:
-1. Format: <type>(<scope>): <subject>
+1. Format: ${useEmoji ? '<emoji> ' : ''}<type>(<scope>): <subject>
 2. type must be one of: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
 3. scope is optional, indicates the affected area
 4. subject should be concise, no more than 50 characters
 5. Return only ONE commit message, even if multiple files are changed, summarize into one message
 6. No explanations or extra content
+${useEmoji ? `
+Emoji mapping rules:
+- feat: ✨ (new feature)
+- fix: 🐛 (bug fix)
+- docs: 📝 (documentation)
+- style: 💄 (code style)
+- refactor: ♻️ (refactoring)
+- perf: ⚡️ (performance)
+- test: ✅ (testing)
+- build: 📦 (build)
+- ci: 👷 (CI/CD)
+- chore: 🔧 (chore)
+- revert: ⏪ (revert)` : ''}
 
 Examples:
-- feat(auth): add user login functionality
-- fix(api): resolve data fetching failure
-- docs(readme): update installation guide`;
+- ${useEmoji ? '✨ ' : ''}feat(auth): add user login functionality
+- ${useEmoji ? '🐛 ' : ''}fix(api): resolve data fetching failure
+- ${useEmoji ? '📝 ' : ''}docs(readme): update installation guide`;
 
     const userPrompt = isZh
       ? `请根据以下 git diff 生成 commit message：\n\n${diff}`
@@ -327,6 +379,9 @@ export async function generateAICommitMessage(
   const language = aiConfig.language || "zh-CN";
   const detailedDescription = aiConfig.detailedDescription !== false; // 默认启用详细描述
   const maxTokens = aiConfig.maxTokens || (detailedDescription ? 400 : 200);
+  
+  // AI emoji配置：优先使用aiCommit.useEmoji，如果未设置则使用全局useEmoji，默认true
+  const useEmoji = aiConfig.useEmoji !== undefined ? aiConfig.useEmoji : (config.useEmoji !== false);
 
   // 获取 git diff
   const diff = getGitDiff();
@@ -340,7 +395,7 @@ export async function generateAICommitMessage(
     diff.length > maxDiffLength ? diff.slice(0, maxDiffLength) + "\n..." : diff;
 
   // 构建 prompt
-  const prompt = buildPrompt(truncatedDiff, language, detailedDescription);
+  const prompt = buildPrompt(truncatedDiff, language, detailedDescription, useEmoji);
 
   // 根据提供商调用对应的 API
   const providerInfo = AI_PROVIDERS[provider];

package/src/commands/commit.ts

@@ -277,9 +277,11 @@ export async function commit(): Promise<void> {
       return;
     }
 
-    // 使用 -m 参数，需要转义引号
-    const escapedMessage = message.replace(/"/g, '\\"');
-    execSync(`git commit -m "${escapedMessage}"`, { stdio: "pipe" });
+    // 处理多行消息：使用 git commit -F - 通过 stdin 传递
+    // 这样可以正确处理包含换行符的 commit message
+    execSync(`git commit -F -`, {
+      input: message,
+    });
     spinner.succeed("提交成功");
 
     // 显示提交信息
@@ -300,7 +302,7 @@ export async function commit(): Promise<void> {
     console.log(colors.yellow("你可以手动执行以下命令:"));
     console.log(colors.cyan(`  git commit -m "${message}"`));
     console.log("");
-    
+
     // 重新抛出错误，让调用者知道提交失败了
     throw error;
   }

package/src/commands/init.ts

@@ -283,12 +283,35 @@ export async function init(): Promise<void> {
       theme,
     });
 
+    const aiUseEmoji = await select({
+      message: "AI 生成的 commit message 是否包含 emoji?",
+      choices: [
+        { 
+          name: "是（推荐）", 
+          value: true,
+          description: "如：✨ feat(auth): 添加用户登录功能"
+        },
+        { 
+          name: "否", 
+          value: false,
+          description: "如：feat(auth): 添加用户登录功能"
+        },
+        { 
+          name: "跟随全局设置", 
+          value: undefined,
+          description: `当前全局设置：${useEmoji ? '启用' : '禁用'} emoji`
+        },
+      ],
+      theme,
+    });
+
     config.aiCommit = {
       enabled: true,
       provider: aiProvider as "github" | "openai" | "claude" | "ollama",
       apiKey: apiKey || undefined,
       language: language as "zh-CN" | "en-US",
       detailedDescription,
+      useEmoji: aiUseEmoji,
     };
 
     // 根据提供商设置默认模型

package/src/commands/tag.ts

@@ -16,11 +16,15 @@ export async function listTags(prefix?: string): Promise<void> {
 
   // 2. 获取 tags 列表（按版本号升序排序，最新的在最后）
   const pattern = prefix ? `${prefix}*` : "";
-  const tags = execOutput(`git tag -l ${pattern} --sort=v:refname`)
+  const allTags = execOutput(`git tag -l ${pattern} --sort=v:refname`)
     .split("\n")
     .filter(Boolean);
 
-  // 3. 如果没有 tags，提示并返回
+  // 3. 过滤无效 tag（如 vnull、vundefined 等误操作产生的 tag）
+  // 有效 tag 必须包含数字（版本号）
+  const tags = allTags.filter((tag) => /\d/.test(tag));
+
+  // 4. 如果没有 tags，提示并返回
   if (tags.length === 0) {
     console.log(
       colors.yellow(prefix ? `没有 '${prefix}' 开头的 tag` : "没有 tag")
@@ -39,11 +43,12 @@ export async function listTags(prefix?: string): Promise<void> {
     return;
   }
 
-  // 5. 按前缀分组（提取 tag 名称中数字前的部分作为前缀）
+  // 6. 按前缀分组（提取 tag 名称中数字前的部分作为前缀）
+  // 由于已过滤无效 tag，所有 tag 都包含数字
   const grouped = new Map<string, string[]>();
   tags.forEach((tag) => {
-    // 提取前缀：去掉数字及之后的部分，如 "v0.1.0" -> "v"
-    const prefix = tag.replace(/[0-9].*/, "") || "(无前缀)";
+    // 提取数字之前的字母部分作为前缀（如 "v0.1.0" -> "v"）
+    const prefix = tag.replace(/\d.*/, "") || "(无前缀)";
     if (!grouped.has(prefix)) {
       grouped.set(prefix, []);
     }
@@ -131,11 +136,11 @@ interface TagChoice {
   value: string;
 }
 
-// 获取指定前缀的最新 tag（不依赖 shell 管道）
+// 获取指定前缀的最新有效 tag（必须包含数字）
 function getLatestTag(prefix: string): string {
   const tags = execOutput(`git tag -l "${prefix}*" --sort=-v:refname`)
     .split("\n")
-    .filter(Boolean);
+    .filter((tag) => tag && /\d/.test(tag)); // 过滤无效 tag
   return tags[0] || "";
 }
 
@@ -156,7 +161,10 @@ export async function createTag(inputPrefix?: string): Promise<void> {
   }
 
   if (!prefix) {
-    const allTags = execOutput("git tag -l").split("\n").filter(Boolean);
+    // 过滤无效 tag（如 vnull、vundefined 等误操作产生的 tag）
+    const allTags = execOutput("git tag -l")
+      .split("\n")
+      .filter((tag) => tag && /\d/.test(tag));
 
     // 仓库没有任何 tag 的情况
     if (allTags.length === 0) {
@@ -209,9 +217,9 @@ export async function createTag(inputPrefix?: string): Promise<void> {
       return;
     }
 
-    // 从现有 tag 中提取前缀
+    // 从现有 tag 中提取前缀（数字之前的字母部分）
     const prefixes = [
-      ...new Set(allTags.map((t) => t.replace(/[0-9].*/, "")).filter(Boolean)),
+      ...new Set(allTags.map((t) => t.replace(/\d.*/, "")).filter(Boolean)),
     ];
 
     if (prefixes.length === 0) {

package/src/config.ts

@@ -46,6 +46,7 @@ export interface GwConfig {
     language?: "zh-CN" | "en-US"; // 生成语言，默认 zh-CN
     maxTokens?: number; // 最大 token 数，默认 200
     detailedDescription?: boolean; // 是否生成详细的修改点描述，默认 false
+    useEmoji?: boolean; // AI生成的commit message是否包含emoji，默认继承全局useEmoji设置
   };
 }