Merge pull request #28 from littleCareless/docs/pr-summary-auto-generation-spec

Docs/pr summary auto generation spec

Author: littleCareless

CHANGELOG.md

@@ -6,6 +6,36 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)。
 
+## 0.21.1 (2025-06-13)
+
+### ♻ Code Refactoring
+
+- **ai-provider**: Refactor AI provider streaming request parameter processing ([1544c46](https://github.com/littleCareless/dish-ai-commit/commit/1544c46))
+
+- **progress**: Optimize command progress display and user feedback ([1c098fa](https://github.com/littleCareless/dish-ai-commit/commit/1c098fa))
+
+### 🎫 Chores
+
+- **i18n**: Added internationalized text related to PR summary generation progress ([e437a0c](https://github.com/littleCareless/dish-ai-commit/commit/e437a0c))
+
+- **release**: Release 0.21.0 Version ([f79a70c](https://github.com/littleCareless/dish-ai-commit/commit/f79a70c))
+
+# 0.21.0 (2025-06-13)
+
+### ✨ Features
+
+- **ai-provider**: Implement PR summary generation for AI provider ([c0c9d48](https://github.com/littleCareless/dish-ai-commit/commit/c0c9d48))
+- **config**: Add PR summary config option ([d933c69](https://github.com/littleCareless/dish-ai-commit/commit/d933c69))
+- **extension**: Add PR summary generation ([d9b1d21](https://github.com/littleCareless/dish-ai-commit/commit/d9b1d21))
+- **pr-summary**: Add PR summary generation ([5867855](https://github.com/littleCareless/dish-ai-commit/commit/5867855))
+- **pr-summary**: Added the function of generating PR summary ([78c92c1](https://github.com/littleCareless/dish-ai-commit/commit/78c92c1))
+- **scm**: Added the function of obtaining commit log and branch list ([be86233](https://github.com/littleCareless/dish-ai-commit/commit/be86233))
+
+### 🎫 Chores
+
+- **i18n**: Updated internationalization files to support new features such as PR summary ([9a29abb](https://github.com/littleCareless/dish-ai-commit/commit/9a29abb))
+- **release**: Release 0.20.2 version ([08a3d09](https://github.com/littleCareless/dish-ai-commit/commit/08a3d09))
+
 ## 0.20.2 (2025-06-12)
 
 ### 🎫 Chores

CHANGELOG.zh-CN.md

@@ -6,6 +6,34 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)。
 
+## 0.21.1 (2025-06-13)
+
+### ♻ Code Refactoring
+
+- **ai-provider**: 重构 AI 提供程序流式请求参数处理 ([1544c46](https://github.com/littleCareless/dish-ai-commit/commit/1544c46))
+- **progress**: 优化命令进度显示与用户反馈 ([1c098fa](https://github.com/littleCareless/dish-ai-commit/commit/1c098fa))
+
+### 🎫 Chores
+
+- **i18n**: 新增 PR 摘要生成进度相关的国际化文案 ([e437a0c](https://github.com/littleCareless/dish-ai-commit/commit/e437a0c))
+- **release**: 发布 0.21.0 版本 ([f79a70c](https://github.com/littleCareless/dish-ai-commit/commit/f79a70c))
+
+# 0.21.0 (2025-06-13)
+
+### ✨ Features
+
+- **ai-provider**: 为 AI 提供程序实现 PR 摘要生成功能 ([c0c9d48](https://github.com/littleCareless/dish-ai-commit/commit/c0c9d48))
+- **config**: 添加 PR 摘要配置选项 ([d933c69](https://github.com/littleCareless/dish-ai-commit/commit/d933c69))
+- **extension**: 添加生成 PR 摘要功能 ([d9b1d21](https://github.com/littleCareless/dish-ai-commit/commit/d9b1d21))
+- **pr-summary**: 添加生成 PR 摘要功能 ([5867855](https://github.com/littleCareless/dish-ai-commit/commit/5867855))
+- **pr-summary**: 添加生成 PR 摘要功能 ([78c92c1](https://github.com/littleCareless/dish-ai-commit/commit/78c92c1))
+- **scm**: 新增获取提交日志与分支列表功能 ([be86233](https://github.com/littleCareless/dish-ai-commit/commit/be86233))
+
+### 🎫 Chores
+
+- **i18n**: 更新国际化文件，支持 PR 摘要等新功能 ([9a29abb](https://github.com/littleCareless/dish-ai-commit/commit/9a29abb))
+- **release**: 发布 0.20.2 版本 ([08a3d09](https://github.com/littleCareless/dish-ai-commit/commit/08a3d09))
+
 ## 0.20.2 (2025-06-12)
 
 ### 🎫 Chores

i18n/en.json

@@ -104,7 +104,6 @@
   "no.changes.selected": "No changes selected! Please select files to analyze",
   "no.changes.found": "No changes found in selected files",
   "please.select.valid.files": "Some selected files are invalid, please reselect files for review",
-  "no.changes.found": "No changes found for review",
   "review.file.failed": "Failed to review file: {0}",
   "code.review.failed": "Code review failed: {0}",
   "svn.no.files.selected": "No files selected to commit",
@@ -157,5 +156,25 @@
   "confirm.ai.provider.tos.cancel": "Cancel",
   "confirm.ai.provider.tos.message": "Dish AI features can send code snippets, diffs, and other context to your selected AI provider for analysis.",
   "user.cancelled.operation.log": "User cancelled the operation",
-  "user.cancelled.operation.error": "Operation cancelled by user"
+  "user.cancelled.operation.error": "Operation cancelled by user",
+  "pr.summary.git.only": "PR Summary generation is only available for Git repositories",
+  "pr.summary.no.commits": "No commits found to generate PR summary",
+  "progress.generating.pr.summary": "Generating PR summary...",
+  "detecting.scm.provider": "Detecting SCM provider...",
+  "fetching.branches": "Fetching branches...",
+  "fetching.commit.log": "Fetching commit log...",
+  "validating.model": "Validating model...",
+  "analyzing.commits": "Analyzing commits...",
+  "pr.summary.title": "PR Summary",
+  "pr.summary.generated": "PR Summary generated successfully and opened in a new tab",
+  "pr.summary.generation.failed": "Failed to generate PR summary",
+  "pr.summary.generation.failed.error": "Failed to generate PR summary: {0}",
+  "command.pr.summary.failed": "PR Summary generation command failed: {0}",
+  "provider.does.not.support.feature": "Provider {0} does not support {1}.",
+  "svn.log.failed": "Failed to get SVN commit log: {0}",
+  "git.branch.list.failed": "Failed to get Git branch list: {0}",
+  "pr.summary.select.base.branch.placeholder": "Select base branch to compare with (current: {0})",
+  "pr.summary.select.base.branch.title": "Select Base Branch for PR Summary",
+  "pr.summary.base.branch.selection.cancelled": "Base branch selection cancelled. PR summary generation aborted.",
+  "pr.summary.no.branches.found": "No branches found in the repository. Using default base branch."
 }

i18n/zh-cn.json

@@ -91,10 +91,8 @@
   "dashscope.apiKey.missing": "DashScope API Key 未配置。是否现在配置？",
   "doubao.apiKey.missing": "豆包 API Key 未配置。是否现在配置？",
   "reviewing.code": "正在进行代码评审",
-  "getting.file.changes": "正在获取文件变更...",
   "no.valid.changes.selected": "未选择有效的待评审变更",
   "reviewing.file": "评审文件：{0}",
-  "preparing.results": "正在准备评审结果...",
   "review.all.failed": "所有文件评审失败",
   "review.complete.count": "已完成 {0} 个文件的代码评审",
   "review.results.title": "代码评审结果",
@@ -121,7 +119,6 @@
   "branch.name.git.only": "分支名称生成功能仅适用于Git仓库",
   "command.branch.name.failed": "分支名称生成命令执行失败：{0}",
   "please.select.valid.files": "选择的文件中包含无效项，请重新选择要评审的文件",
-  "no.changes.found": "未找到需要评审的变更",
   "review.file.failed": "评审文件失败: {0}",
   "code.review.failed": "代码评审失败: {0}",
   "svn.no.files.selected": "未选择要提交的文件",
@@ -161,5 +158,25 @@
   "confirm.ai.provider.tos.cancel": "取消",
   "confirm.ai.provider.tos.message": "Dish AI 功能可以将代码片段、差异和其他上下文发送到您选择的 AI 提供商进行分析。",
   "user.cancelled.operation.log": "用户取消了操作",
-  "user.cancelled.operation.error": "操作已被用户取消"
+  "user.cancelled.operation.error": "操作已被用户取消",
+  "pr.summary.git.only": "PR摘要生成功能仅适用于Git仓库",
+  "pr.summary.no.commits": "未找到可用于生成PR摘要的提交记录",
+  "progress.generating.pr.summary": "正在生成PR摘要...",
+  "detecting.scm.provider": "正在检测SCM提供商...",
+  "fetching.branches": "正在获取分支列表...",
+  "fetching.commit.log": "正在获取提交日志...",
+  "validating.model": "正在验证模型...",
+  "analyzing.commits": "正在分析提交记录...",
+  "pr.summary.title": "PR摘要",
+  "pr.summary.generated": "PR摘要已成功生成并在新标签页中打开",
+  "pr.summary.generation.failed": "生成PR摘要失败",
+  "pr.summary.generation.failed.error": "生成PR摘要失败: {0}",
+  "command.pr.summary.failed": "PR摘要生成命令执行失败: {0}",
+  "provider.does.not.support.feature": "提供商 {0} 不支持 {1} 功能。",
+  "svn.log.failed": "获取 SVN 提交日志失败: {0}",
+  "git.branch.list.failed": "获取 Git 分支列表失败: {0}",
+  "pr.summary.select.base.branch.placeholder": "选择要对比的基础分支 (当前: {0})",
+  "pr.summary.select.base.branch.title": "选择PR摘要的基础分支",
+  "pr.summary.base.branch.selection.cancelled": "已取消选择基础分支。PR摘要生成已中止。",
+  "pr.summary.no.branches.found": "仓库中未找到分支。将使用默认基础分支。"
 }

package-lock.json

@@ -2,7 +2,7 @@
   "name": "dish-ai-commit",
   "displayName": "Dish AI Commit Message Gen",
   "description": "🤖 由 AI 提供支持的 VSCode 扩展，用于生成标准化的 Git/SVN 提交消息 - 🤖 AI-Powered VSCode extension for generating standardized Git/SVN commit messages. ✨ Supports multiple AI services: OpenAI, ChatGPT, Ollama, Zhipu, DashScope, Doubao, Gemini and VS Code built-in AI. 🌍 Multi-language support (EN/CN/JP/KR/Other). 📊 Auto-generate weekly reports.",
-  "version": "0.20.2",
+  "version": "0.21.1",
   "engines": {
     "node": ">= 18.20.8",
     "pnpm": ">= 10.0.0",
@@ -88,6 +88,13 @@
         "category": "[Dish AI Commit]",
         "icon": "/images/icon.svg",
         "description": "使用 AI 生成Git分支名称"
+      },
+      {
+        "command": "dish-ai-commit.generatePRSummary",
+        "title": "[Dish] Generate PR Summary with AI",
+        "category": "[Dish AI Commit]",
+        "icon": "/images/icon.svg",
+        "description": "使用 AI 生成 PR 摘要"
       }
     ],
     "configuration": {
@@ -257,6 +264,26 @@
           "type": "string",
           "default": "",
           "description": "Custom system prompt for branch name generation / 分支名称生成的自定义系统提示语"
+        },
+        "dish-ai-commit.features.prSummary.baseBranch": {
+          "type": "string",
+          "default": "origin/main",
+          "description": "Base branch for comparing commits to generate PR summary / 用于比较提交以生成PR摘要的基础分支"
+        },
+        "dish-ai-commit.features.prSummary.headBranch": {
+          "type": "string",
+          "default": "HEAD",
+          "description": "Head branch for comparing commits to generate PR summary / 用于比较提交以生成PR摘要的头部分支"
+        },
+        "dish-ai-commit.features.prSummary.systemPrompt": {
+          "type": "string",
+          "default": "",
+          "description": "Custom system prompt for PR summary generation / PR摘要生成的自定义系统提示语"
+        },
+        "svn-commit-gen.commitLogLimit": {
+          "type": "number",
+          "default": 20,
+          "description": "The maximum number of commit logs to fetch for SVN when no specific range is provided. / 当未提供特定范围时，为 SVN 获取提交日志的最大数量。"
         }
       }
     },
@@ -291,6 +318,11 @@
           "command": "dish-ai-commit.selectModel",
           "when": "scmProvider =~ /(git|svn)/",
           "group": "2_z_dish@5"
+        },
+        {
+          "command": "dish-ai-commit.generatePRSummary",
+          "when": "scmProvider == git",
+          "group": "2_z_dish@6"
         }
       ],
       "scm/resourceState/context": [
@@ -318,6 +350,11 @@
           "command": "dish-ai-commit.selectModel",
           "when": "((config.svn.enabled && scmProvider == svn) || (config.git.enabled && scmProvider == git)) && scmResourceGroup != unversioned && scmResourceGroup != external && scmResourceGroup != conflicts && scmResourceGroup != remotechanges",
           "group": "2_z_dish@5"
+        },
+        {
+          "command": "dish-ai-commit.generatePRSummary",
+          "when": "config.git.enabled && scmProvider == git && scmResourceGroup != unversioned && scmResourceGroup != external && scmResourceGroup != conflicts && scmResourceGroup != remotechanges",
+          "group": "2_z_dish@6"
         }
       ],
       "scm/resourceFolder/context": [
@@ -345,6 +382,11 @@
           "command": "dish-ai-commit.selectModel",
           "when": "((config.svn.enabled && scmProvider == svn) || (config.git.enabled && scmProvider == git)) && scmResourceGroup != unversioned && scmResourceGroup != external && scmResourceGroup != conflicts && scmResourceGroup != remotechanges",
           "group": "inline"
+        },
+        {
+          "command": "dish-ai-commit.generatePRSummary",
+          "when": "config.git.enabled && scmProvider == git && scmResourceGroup != unversioned && scmResourceGroup != external && scmResourceGroup != conflicts && scmResourceGroup != remotechanges",
+          "group": "inline"
         }
       ],
       "commandPalette": [
@@ -362,6 +404,9 @@
         },
         {
           "command": "dish-ai-commit.reviewCode"
+        },
+        {
+          "command": "dish-ai-commit.generatePRSummary"
         }
       ]
     }

package.json

@@ -52,34 +52,31 @@ export abstract class AbstractAIProvider implements AIProvider {
       );
     }
   }
-/**
+  /**
    * 生成提交信息 (流式)
    * @param params - AI请求参数
    * @returns 一个Promise，解析为一个异步迭代器，用于逐块生成提交信息
    * @remarks 此方法为新增，AIProvider接口也需要相应更新
    */
-  async generateCommitStream(params: AIRequestParams): Promise<AsyncIterable<string>> {
+  async generateCommitStream(
+    params: AIRequestParams
+  ): Promise<AsyncIterable<string>> {
     try {
-      console.log("params for stream", params);
-      const systemPrompt = getSystemPrompt(params);
       // 注意：流式请求的重试逻辑可能与非流式请求不同。
       // 这里直接调用 executeAIStreamRequest，具体的重试和错误处理
       // 应该在 executeAIStreamRequest 的实现中或专门的流式重试辅助函数中处理。
-      return this.executeAIStreamRequest(
-        systemPrompt,
-        "", // userPrompt
-        params.diff, // userContent
-        params,
-        {
-          temperature: 0.3, // 提交信息推荐温度值 0.3
-          // maxTokens 可以在这里设置，如果需要的话
-        }
-      );
+      // systemPrompt, userPrompt, userContent 将由 executeAIStreamRequest 的实现
+      // 从 params 中获取或计算。
+      return this.executeAIStreamRequest(params, {
+        temperature: 0.3, // 提交信息推荐温度值 0.3
+        // maxTokens 可以在这里设置，如果需要的话
+      });
     } catch (error) {
       // 流的错误可能在迭代过程中发生，这里的 catch 可能只捕获初始设置错误
       // 需要在调用方迭代流时也处理错误
       throw new Error(
-        formatMessage("generation.failed", [ // 或者一个新的i18n key如 "streamGeneration.failed"
+        formatMessage("generation.failed", [
+          // 或者一个新的i18n key如 "streamGeneration.failed"
           error instanceof Error ? error.message : String(error),
         ])
       );
@@ -331,20 +328,18 @@ export abstract class AbstractAIProvider implements AIProvider {
   ): Promise<{ content: string; usage?: any; jsonContent?: any }>;
 
   /**
-   * 需要由具体提供者实现的核心流式方法
-   * 执行AI流式请求并返回一个异步迭代器
+   * 需要由具体提供者实现的核心流式方法。
+   * 执行AI流式请求并返回一个异步迭代器。
+   * 实现类应从此方法内部的 `params` 对象中获取或生成 `systemPrompt`, `userPrompt`, 和 `userContent`。
+   * - `systemPrompt` 通常通过调用 `getSystemPrompt(params)` 生成。
+   * - `userPrompt` 通常取自 `params.additionalContext` (如果存在)，否则为空字符串。
+   * - `userContent` 通常取自 `params.diff`。
    *
-   * @param systemPrompt - 系统提示内容
-   * @param userPrompt - 用户提示内容
-   * @param userContent - 用户内容
-   * @param params - 请求参数
-   * @param options - 额外选项
-   * @returns Promise<AsyncIterable<string>>
+   * @param params - AI请求参数，包含构建提示所需的所有信息及模型配置。
+   * @param options - 额外选项，如 `temperature` 和 `maxTokens`。
+   * @returns 一个Promise，解析为一个异步迭代器，用于逐块生成内容。
    */
   protected abstract executeAIStreamRequest(
-    systemPrompt: string,
-    userPrompt: string,
-    userContent: string,
     params: AIRequestParams,
     options?: {
       temperature?: number;