@zjex/git-workflow 0.2.24 → 0.3.2

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,33 @@ async function callOllamaAPI(
   }
 }
 
+/**
+ * 清理AI生成的commit message
+ * 移除重复行、多余的空行和开头的特殊字符
+ */
+function cleanAIResponse(response: string): string {
+  // 移除开头的特殊字符（如 ...、```、等）
+  let cleaned = response.replace(/^[.\s`~-]+/, '').trim();
+  
+  // 移除结尾的特殊字符
+  cleaned = cleaned.replace(/[.\s`~-]+$/, '').trim();
+  
+  const lines = cleaned.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 +325,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 +335,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 +360,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/commit.ts

@@ -285,6 +285,7 @@ export async function commit(): Promise<void> {
     // 显示提交信息
     const commitHash = execOutput("git rev-parse --short HEAD");
     console.log(colors.dim(`commit: ${commitHash}`));
+    console.log("");
   } catch (error) {
     spinner.fail("提交失败");
     console.log("");
@@ -299,6 +300,9 @@ 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

@@ -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,
     };
 
     // 根据提供商设置默认模型