@zjex/git-workflow 0.2.24 → 0.3.0

package/src/ai-service.ts

@@ -60,11 +60,66 @@ function getGitDiff(): string {
 /**
  * 构建 AI prompt
  */
-function buildPrompt(diff: string, language: string): string {
+function buildPrompt(diff: string, language: string, detailedDescription: boolean = false): string {
   const isZh = language === "zh-CN";
 
-  const systemPrompt = isZh
-    ? `你是一个专业的 Git commit message 生成助手。请根据提供的 git diff 生成符合 Conventional Commits 规范的 commit message。
+  if (detailedDescription) {
+    // 详细模式：生成包含修改点的完整 commit message
+    const systemPrompt = isZh
+      ? `你是一个专业的 Git commit message 生成助手。请根据提供的 git diff 生成符合 Conventional Commits 规范的详细 commit message。
+
+格式要求：
+1. 第一行：<type>(<scope>): <subject>
+2. 空行
+3. 详细描述：列出主要修改点，每个修改点一行，以 "- " 开头
+
+规则：
+- type 必须是以下之一：feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
+- scope 是可选的，表示影响范围
+- subject 用中文描述，简洁明了，不超过 50 字
+- 详细描述要列出 3-6 个主要修改点，每个修改点简洁明了
+- 如果修改较少，可以只列出 2-3 个修改点
+- 不要有其他解释或多余内容
+
+示例：
+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>
+2. Empty line
+3. Detailed description: List main changes, one per line, starting with "- "
+
+Rules:
+- type must be one of: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
+- scope is optional, indicates the affected area
+- subject should be concise, no more than 50 characters
+- 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
+
+Example:
+feat(auth): add user login functionality
+
+- Implement username/password login API
+- Add login status validation middleware
+- Improve login error handling logic
+- Update user authentication documentation`;
+
+    const userPrompt = isZh
+      ? `请根据以下 git diff 生成详细的 commit message（包含修改点列表）：\n\n${diff}`
+      : `Generate a detailed commit message (including change list) based on the following git diff:\n\n${diff}`;
+
+    return `${systemPrompt}\n\n${userPrompt}`;
+  } else {
+    // 简洁模式：只生成标题
+    const systemPrompt = isZh
+      ? `你是一个专业的 Git commit message 生成助手。请根据提供的 git diff 生成符合 Conventional Commits 规范的 commit message。
 
 规则：
 1. 格式：<type>(<scope>): <subject>
@@ -78,7 +133,7 @@ function buildPrompt(diff: string, language: string): string {
 - feat(auth): 添加用户登录功能
 - fix(api): 修复数据获取失败的问题
 - docs(readme): 更新安装说明`
-    : `You are a professional Git commit message generator. Generate a commit message following Conventional Commits specification based on the provided git diff.
+      : `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>
@@ -93,11 +148,12 @@ Examples:
 - fix(api): resolve data fetching failure
 - docs(readme): update installation guide`;
 
-  const userPrompt = isZh
-    ? `请根据以下 git diff 生成 commit message：\n\n${diff}`
-    : `Generate a commit message based on the following git diff:\n\n${diff}`;
+    const userPrompt = isZh
+      ? `请根据以下 git diff 生成 commit message：\n\n${diff}`
+      : `Generate a commit message based on the following git diff:\n\n${diff}`;
 
-  return `${systemPrompt}\n\n${userPrompt}`;
+    return `${systemPrompt}\n\n${userPrompt}`;
+  }
 }
 
 /**
@@ -233,6 +289,27 @@ async function callOllamaAPI(
   }
 }
 
+/**
+ * 清理AI生成的commit message
+ * 移除重复行和多余的空行
+ */
+function cleanAIResponse(response: string): string {
+  const lines = response.split('\n').map(line => line.trim()).filter(line => line);
+  
+  // 移除重复的行
+  const uniqueLines = [];
+  const seen = new Set();
+  
+  for (const line of lines) {
+    if (!seen.has(line)) {
+      seen.add(line);
+      uniqueLines.push(line);
+    }
+  }
+  
+  return uniqueLines.join('\n');
+}
+
 /**
  * 生成 AI commit message
  */
@@ -242,7 +319,8 @@ export async function generateAICommitMessage(
   const aiConfig = config.aiCommit || {};
   const provider = aiConfig.provider || "github";
   const language = aiConfig.language || "zh-CN";
-  const maxTokens = aiConfig.maxTokens || 200;
+  const detailedDescription = aiConfig.detailedDescription !== false; // 默认启用详细描述
+  const maxTokens = aiConfig.maxTokens || (detailedDescription ? 400 : 200);
 
   // 获取 git diff
   const diff = getGitDiff();
@@ -251,12 +329,12 @@ export async function generateAICommitMessage(
   }
 
   // 限制 diff 长度，避免超过 token 限制
-  const maxDiffLength = 4000;
+  const maxDiffLength = detailedDescription ? 6000 : 4000;
   const truncatedDiff =
     diff.length > maxDiffLength ? diff.slice(0, maxDiffLength) + "\n..." : diff;
 
   // 构建 prompt
-  const prompt = buildPrompt(truncatedDiff, language);
+  const prompt = buildPrompt(truncatedDiff, language, detailedDescription);
 
   // 根据提供商调用对应的 API
   const providerInfo = AI_PROVIDERS[provider];
@@ -276,18 +354,26 @@ export async function generateAICommitMessage(
   }
 
   // 调用 API
+  let response: string;
   switch (provider) {
     case "github":
-      return await callGitHubAPI(prompt, apiKey, model, maxTokens);
+      response = await callGitHubAPI(prompt, apiKey, model, maxTokens);
+      break;
     case "openai":
-      return await callOpenAIAPI(prompt, apiKey, model, maxTokens);
+      response = await callOpenAIAPI(prompt, apiKey, model, maxTokens);
+      break;
     case "claude":
-      return await callClaudeAPI(prompt, apiKey, model, maxTokens);
+      response = await callClaudeAPI(prompt, apiKey, model, maxTokens);
+      break;
     case "ollama":
-      return await callOllamaAPI(prompt, model, maxTokens);
+      response = await callOllamaAPI(prompt, model, maxTokens);
+      break;
     default:
       throw new Error(`不支持的 AI 提供商: ${provider}`);
   }
+
+  // 清理AI响应，移除重复内容
+  return cleanAIResponse(response);
 }
 
 /**

package/src/commands/init.ts

@@ -266,11 +266,29 @@ export async function init(): Promise<void> {
       theme,
     });
 
+    const detailedDescription = await select({
+      message: "是否生成详细的修改点描述?",
+      choices: [
+        { 
+          name: "是（包含修改点列表，推荐）", 
+          value: true,
+          description: "如：feat(auth): 添加用户登录功能\n\n- 实现用户名密码登录接口\n- 添加登录状态验证中间件"
+        },
+        { 
+          name: "否（仅生成标题）", 
+          value: false,
+          description: "如：feat(auth): 添加用户登录功能"
+        },
+      ],
+      theme,
+    });
+
     config.aiCommit = {
       enabled: true,
       provider: aiProvider as "github" | "openai" | "claude" | "ollama",
       apiKey: apiKey || undefined,
       language: language as "zh-CN" | "en-US",
+      detailedDescription,
     };
 
     // 根据提供商设置默认模型

package/src/config.ts

@@ -45,6 +45,7 @@ export interface GwConfig {
     model?: string; // 模型名称
     language?: "zh-CN" | "en-US"; // 生成语言，默认 zh-CN
     maxTokens?: number; // 最大 token 数，默认 200
+    detailedDescription?: boolean; // 是否生成详细的修改点描述，默认 false
   };
 }
 

package/tests/ai-service.test.ts

@@ -121,7 +121,7 @@ describe("AI Service 模块测试", () => {
         provider: "github",
         apiKey: "test-key",
         language: "zh-CN",
-        maxTokens: 200,
+        // 不设置 maxTokens，让它自动计算
       },
     };
 
@@ -310,7 +310,7 @@ describe("AI Service 模块测试", () => {
     });
 
     it("应该截断过长的 diff", async () => {
-      const longDiff = "a".repeat(5000);
+      const longDiff = "a".repeat(7000); // 超过详细模式的 6000 限制
       vi.mocked(execOutput).mockReturnValue(longDiff);
 
       const mockFetch = vi.mocked(fetch);
@@ -343,6 +343,7 @@ describe("AI Service 模块测试", () => {
         aiCommit: {
           ...mockConfig.aiCommit!,
           language: "en-US" as const,
+          detailedDescription: false, // 使用简洁模式测试语言
         },
       };
 
@@ -437,6 +438,240 @@ describe("AI Service 模块测试", () => {
 
       expect(body.max_tokens).toBe(500);
     });
+
+    it("默认应该启用详细描述模式", async () => {
+      const defaultConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          // 不设置 detailedDescription 和 maxTokens，测试默认行为
+        },
+      };
+      // 移除 maxTokens 设置
+      delete defaultConfig.aiCommit!.maxTokens;
+
+      vi.mocked(execOutput).mockReturnValue("diff --git a/file.ts b/file.ts");
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat(auth): 添加用户登录功能\n\n- 实现用户名密码登录接口\n- 添加登录状态验证中间件",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      const result = await generateAICommitMessage(defaultConfig);
+
+      expect(result).toContain("feat(auth): 添加用户登录功能");
+      expect(result).toContain("- 实现用户名密码登录接口");
+
+      // 验证使用了详细描述的 prompt
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+      const prompt = body.messages[0].content;
+
+      expect(prompt).toContain("详细描述：列出主要修改点");
+      expect(body.max_tokens).toBe(400); // 详细模式的 token 数
+    });
+
+    it("详细描述模式应该生成包含修改点的 commit message", async () => {
+      const detailedConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          detailedDescription: true,
+        },
+      };
+
+      vi.mocked(execOutput).mockReturnValue("diff --git a/file.ts b/file.ts");
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat(auth): 添加用户登录功能\n\n- 实现用户名密码登录接口\n- 添加登录状态验证中间件\n- 完善登录错误处理逻辑",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      const result = await generateAICommitMessage(detailedConfig);
+
+      expect(result).toContain("feat(auth): 添加用户登录功能");
+      expect(result).toContain("- 实现用户名密码登录接口");
+      expect(result).toContain("- 添加登录状态验证中间件");
+      expect(result).toContain("- 完善登录错误处理逻辑");
+
+      // 验证 prompt 包含详细描述的指令
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+      const prompt = body.messages[0].content;
+
+      expect(prompt).toContain("详细描述：列出主要修改点");
+      expect(prompt).toContain("以 \"- \" 开头");
+    });
+
+    it("详细描述模式应该使用更大的 maxTokens", async () => {
+      const detailedConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          // 不设置 detailedDescription 和 maxTokens，使用默认值
+        },
+      };
+      // 移除 maxTokens 设置
+      delete detailedConfig.aiCommit!.maxTokens;
+
+      vi.mocked(execOutput).mockReturnValue("diff --git a/file.ts b/file.ts");
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat: add feature\n\n- change 1\n- change 2",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      await generateAICommitMessage(detailedConfig);
+
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+
+      // 默认启用详细描述模式，应该使用 400 tokens
+      expect(body.max_tokens).toBe(400);
+    });
+
+    it("详细描述模式应该允许更长的 diff", async () => {
+      const detailedConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          // 不设置 detailedDescription，使用默认值 true
+        },
+      };
+
+      const longDiff = "a".repeat(5500); // 超过简洁模式的 4000 限制，但在详细模式的 6000 限制内
+      vi.mocked(execOutput).mockReturnValue(longDiff);
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat: update",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      await generateAICommitMessage(detailedConfig);
+
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+      const prompt = body.messages[0].content;
+
+      // 在详细模式下，5500 字符的 diff 不应该被截断
+      expect(prompt).toContain(longDiff);
+      expect(prompt).not.toContain("...");
+    });
+
+    it("简洁模式应该生成简短的 commit message", async () => {
+      const simpleConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          detailedDescription: false,
+        },
+      };
+
+      vi.mocked(execOutput).mockReturnValue("diff --git a/file.ts b/file.ts");
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat(auth): 添加用户登录功能",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      const result = await generateAICommitMessage(simpleConfig);
+
+      expect(result).toBe("feat(auth): 添加用户登录功能");
+
+      // 验证 prompt 不包含详细描述的指令
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+      const prompt = body.messages[0].content;
+
+      expect(prompt).not.toContain("详细描述：列出主要修改点");
+      expect(prompt).toContain("只返回一条 commit message");
+    });
+
+    it("英文详细描述模式应该使用英文指令", async () => {
+      const enDetailedConfig = {
+        ...mockConfig,
+        aiCommit: {
+          ...mockConfig.aiCommit!,
+          language: "en-US" as const,
+          detailedDescription: true,
+        },
+      };
+
+      vi.mocked(execOutput).mockReturnValue("diff --git a/file.ts b/file.ts");
+
+      const mockFetch = vi.mocked(fetch);
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: async () => ({
+          choices: [
+            {
+              message: {
+                content: "feat(auth): add user login functionality\n\n- Implement username/password login API\n- Add login status validation middleware",
+              },
+            },
+          ],
+        }),
+      } as Response);
+
+      const result = await generateAICommitMessage(enDetailedConfig);
+
+      expect(result).toContain("feat(auth): add user login functionality");
+      expect(result).toContain("- Implement username/password login API");
+
+      // 验证 prompt 使用英文指令
+      const callArgs = mockFetch.mock.calls[0][1] as RequestInit;
+      const body = JSON.parse(callArgs.body as string);
+      const prompt = body.messages[0].content;
+
+      expect(prompt).toContain("Detailed description: List main changes");
+      expect(prompt).toContain("starting with \"- \"");
+      expect(prompt).not.toContain("详细描述");
+    });
   });
 
   describe("Ollama 特殊情况", () => {

package/tests/help.test.ts

@@ -0,0 +1,134 @@
+import { describe, it, expect } from "vitest";
+import { showHelp } from "../src/commands/help.js";
+import { TODAY } from "../src/utils.js";
+
+describe("Help 模块测试", () => {
+  describe("showHelp 函数", () => {
+    it("应该返回完整的帮助信息", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("分支命令:");
+      expect(helpText).toContain("Tag 命令:");
+      expect(helpText).toContain("发布命令:");
+      expect(helpText).toContain("配置命令:");
+      expect(helpText).toContain("更新命令:");
+      expect(helpText).toContain("清理命令:");
+      expect(helpText).toContain("Stash 命令:");
+      expect(helpText).toContain("Commit 命令:");
+      expect(helpText).toContain("示例:");
+      expect(helpText).toContain("分支命名格式:");
+    });
+
+    it("应该包含所有主要命令", () => {
+      const helpText = showHelp();
+      
+      // 分支命令
+      expect(helpText).toContain("gw feature");
+      expect(helpText).toContain("gw feat");
+      expect(helpText).toContain("gw f");
+      expect(helpText).toContain("gw hotfix");
+      expect(helpText).toContain("gw fix");
+      expect(helpText).toContain("gw h");
+      expect(helpText).toContain("gw delete");
+      expect(helpText).toContain("gw del");
+      expect(helpText).toContain("gw d");
+      
+      // Tag 命令
+      expect(helpText).toContain("gw tags");
+      expect(helpText).toContain("gw ts");
+      expect(helpText).toContain("gw tag");
+      expect(helpText).toContain("gw t");
+      expect(helpText).toContain("gw tag:delete");
+      expect(helpText).toContain("gw td");
+      expect(helpText).toContain("gw tag:update");
+      expect(helpText).toContain("gw tu");
+      
+      // 其他命令
+      expect(helpText).toContain("gw release");
+      expect(helpText).toContain("gw r");
+      expect(helpText).toContain("gw init");
+      expect(helpText).toContain("gw update");
+      expect(helpText).toContain("gw upt");
+      expect(helpText).toContain("gw clean");
+      expect(helpText).toContain("gw stash");
+      expect(helpText).toContain("gw s");
+      expect(helpText).toContain("gw st");
+      expect(helpText).toContain("gw commit");
+      expect(helpText).toContain("gw c");
+      expect(helpText).toContain("gw cm");
+    });
+
+    it("应该包含命令描述", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("创建 feature 分支");
+      expect(helpText).toContain("创建 hotfix 分支");
+      expect(helpText).toContain("删除本地/远程分支");
+      expect(helpText).toContain("列出所有 tag");
+      expect(helpText).toContain("交互式选择版本类型并创建 tag");
+      expect(helpText).toContain("删除 tag");
+      expect(helpText).toContain("重命名 tag");
+      expect(helpText).toContain("交互式选择版本号并更新 package.json");
+      expect(helpText).toContain("初始化配置文件");
+      expect(helpText).toContain("检查并更新到最新版本");
+      expect(helpText).toContain("清理缓存文件");
+      expect(helpText).toContain("交互式管理 stash");
+      expect(helpText).toContain("交互式提交");
+    });
+
+    it("应该包含使用示例", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("gw f --base develop");
+      expect(helpText).toContain("gw h --base release");
+      expect(helpText).toContain("gw d feature/xxx");
+      expect(helpText).toContain("gw ts v");
+    });
+
+    it("应该包含分支命名格式说明", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("feature/20260111-<Story ID>-<描述>");
+      expect(helpText).toContain("hotfix/20260111-<Issue ID>-<描述>");
+    });
+
+    it("应该包含配置文件说明", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("全局配置: ~/.gwrc.json");
+      expect(helpText).toContain("项目配置: .gwrc.json");
+      expect(helpText).toContain("所有项目生效");
+      expect(helpText).toContain("仅当前项目");
+    });
+
+    it("应该包含别名说明", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("同上 (别名)");
+    });
+
+    it("应该包含参数说明", () => {
+      const helpText = showHelp();
+      
+      expect(helpText).toContain("[--base <branch>]");
+      expect(helpText).toContain("[branch]");
+      expect(helpText).toContain("[prefix]");
+    });
+
+    it("应该是非空字符串", () => {
+      const helpText = showHelp();
+      
+      expect(typeof helpText).toBe("string");
+      expect(helpText.length).toBeGreaterThan(0);
+      expect(helpText.trim().length).toBeGreaterThan(0);
+    });
+
+    it("应该包含实际的日期格式", () => {
+      const helpText = showHelp();
+      
+      // 检查是否包含实际的日期格式（YYYYMMDD）
+      expect(helpText).toMatch(/feature\/\d{8}-<Story ID>-<描述>/);
+      expect(helpText).toMatch(/hotfix\/\d{8}-<Issue ID>-<描述>/);
+    });
+  });
+});