gitlab-ai-review 1.1.0 → 1.2.0

package/index.js

@@ -6,6 +6,7 @@
 import { getConfig, validateConfig } from './lib/config.js';
 import { GitLabClient } from './lib/gitlab-client.js';
 import { AIClient } from './lib/ai-client.js';
+import * as PromptTools from './lib/prompt-tools.js';
 
 /**
  * GitLab AI Review SDK 主类
@@ -13,7 +14,7 @@ import { AIClient } from './lib/ai-client.js';
 export class GitLabAIReview {
   constructor(options = {}) {
     this.name = 'GitLab AI Review SDK';
-    this.version = '1.0.3';
+    this.version = '1.2.0';
 
     // 如果传入了配置，使用手动配置；否则使用自动检测
     if (options.token || options.gitlab) {
@@ -137,27 +138,62 @@ export class GitLabAIReview {
 
   /**
    * AI 审查单个文件的代码变更
+   * @param {Object} change - 代码变更对象
+   * @returns {Promise<Object>} 审查结果
    */
   async reviewCodeChange(change) {
     const aiClient = this.getAIClient();
     const guardConfig = this.config.ai?.guardConfig?.content || '';
 
-    return aiClient.reviewCode({
+    // 使用 PromptTools 构建消息
+    const messages = PromptTools.buildReviewMessages({
       diff: change.diff,
       fileName: change.new_path || change.old_path,
       guardConfig,
     });
+
+    // 调用 AI
+    return aiClient.sendMessage(messages);
   }
 
   /**
    * AI 审查 MR 的所有代码变更
+   * @returns {Promise<Array>} 审查结果数组
    */
   async reviewMergeRequest() {
     const changes = await this.getMergeRequestChanges();
     const aiClient = this.getAIClient();
     const guardConfig = this.config.ai?.guardConfig?.content || '';
 
-    return aiClient.reviewMultipleFiles(changes, guardConfig);
+    const reviews = [];
+
+    for (const change of changes) {
+      try {
+        // 使用 PromptTools 构建消息
+        const messages = PromptTools.buildReviewMessages({
+          diff: change.diff,
+          fileName: change.new_path || change.old_path,
+          guardConfig,
+        });
+
+        // 调用 AI
+        const result = await aiClient.sendMessage(messages);
+
+        reviews.push({
+          fileName: change.new_path || change.old_path,
+          status: 'success',
+          ...result,
+        });
+      } catch (error) {
+        reviews.push({
+          fileName: change.new_path || change.old_path,
+          status: 'error',
+          error: error.message,
+        });
+      }
+    }
+
+    return reviews;
   }
 
   /**
@@ -198,10 +234,11 @@ export class GitLabAIReview {
   }
 }
 
-// 导出工具函数
+// 导出工具函数和类
 export { getConfig, validateConfig } from './lib/config.js';
 export { GitLabClient } from './lib/gitlab-client.js';
 export { AIClient } from './lib/ai-client.js';
+export { PromptTools };
 
 // 默认导出
 export default GitLabAIReview;

package/lib/ai-client.js

@@ -1,11 +1,12 @@
 /**
  * AI 客户端 - 基于 ARK API (豆包大模型)
+ * 只负责调用 AI API，不处理业务逻辑
  */
 
 import OpenAI from 'openai';
 
 /**
- * AI 客户端类
+ * AI 客户端类 - 纯粹的 API 调用封装
  */
 export class AIClient {
   constructor(config = {}) {
@@ -27,54 +28,51 @@ export class AIClient {
   }
 
   /**
-   * 代码审查 - 非流式响应
-   * @param {Object} params - 审查参数
-   * @param {string} params.diff - 代码差异
-   * @param {string} params.fileName - 文件名
-   * @param {string} params.guardConfig - AI Review Guard 配置内容
-   * @returns {Promise<string>} 审查结果
+   * 发送消息到 AI（非流式）
+   * @param {Array|string} prompt - 消息数组或单个提示词
+   * @param {Object} options - 可选参数
+   * @returns {Promise<Object>} AI 响应
    */
-  async reviewCode({ diff, fileName, guardConfig = '' }) {
-    const systemPrompt = this._buildSystemPrompt(guardConfig);
-    const userPrompt = this._buildReviewPrompt(diff, fileName);
+  async sendMessage(prompt, options = {}) {
+    // 如果传入的是字符串，转换为消息数组
+    const messages = typeof prompt === 'string' 
+      ? [{ role: 'user', content: prompt }]
+      : prompt;
 
     const completion = await this.openai.chat.completions.create({
-      messages: [
-        { role: 'system', content: systemPrompt },
-        { role: 'user', content: userPrompt },
-      ],
-      model: this.model,
-      reasoning_effort: this.config.reasoningEffort || 'medium',
+      messages,
+      model: options.model || this.model,
+      reasoning_effort: options.reasoningEffort || this.config.reasoningEffort || 'medium',
+      ...options,
     });
 
     return {
       reasoning: completion.choices[0]?.message?.reasoning_content || '',
       content: completion.choices[0]?.message?.content || '',
       usage: completion.usage,
+      raw: completion,
     };
   }
 
   /**
-   * 代码审查 - 流式响应
-   * @param {Object} params - 审查参数
-   * @param {string} params.diff - 代码差异
-   * @param {string} params.fileName - 文件名
-   * @param {string} params.guardConfig - AI Review Guard 配置内容
+   * 发送消息到 AI（流式）
+   * @param {Array|string} prompt - 消息数组或单个提示词
    * @param {Function} onChunk - 流式回调函数
-   * @returns {Promise<string>} 完整审查结果
+   * @param {Object} options - 可选参数
+   * @returns {Promise<Object>} 完整 AI 响应
    */
-  async reviewCodeStream({ diff, fileName, guardConfig = '' }, onChunk) {
-    const systemPrompt = this._buildSystemPrompt(guardConfig);
-    const userPrompt = this._buildReviewPrompt(diff, fileName);
+  async sendMessageStream(prompt, onChunk, options = {}) {
+    // 如果传入的是字符串，转换为消息数组
+    const messages = typeof prompt === 'string' 
+      ? [{ role: 'user', content: prompt }]
+      : prompt;
 
     const stream = await this.openai.chat.completions.create({
-      messages: [
-        { role: 'system', content: systemPrompt },
-        { role: 'user', content: userPrompt },
-      ],
-      model: this.model,
-      reasoning_effort: this.config.reasoningEffort || 'medium',
+      messages,
+      model: options.model || this.model,
+      reasoning_effort: options.reasoningEffort || this.config.reasoningEffort || 'medium',
       stream: true,
+      ...options,
     });
 
     let fullReasoning = '';
@@ -99,107 +97,22 @@ export class AIClient {
   }
 
   /**
-   * 通用聊天接口
-   * @param {Array} messages - 消息数组
-   * @param {Object} options - 可选参数
-   * @returns {Promise<Object>} AI 响应
+   * 获取原始 OpenAI 客户端（高级用法）
+   * @returns {OpenAI} OpenAI 客户端实例
    */
-  async chat(messages, options = {}) {
-    const completion = await this.openai.chat.completions.create({
-      messages,
-      model: options.model || this.model,
-      reasoning_effort: options.reasoningEffort || 'medium',
-      stream: options.stream || false,
-      ...options,
-    });
-
-    if (options.stream) {
-      return completion;
-    }
-
-    return {
-      reasoning: completion.choices[0]?.message?.reasoning_content || '',
-      content: completion.choices[0]?.message?.content || '',
-      usage: completion.usage,
-    };
-  }
-
-  /**
-   * 构建系统提示词
-   * @private
-   */
-  _buildSystemPrompt(guardConfig) {
-    let prompt = `你是一个专业的代码审查助手，负责审查 GitLab Merge Request 的代码变更。
-
-你的职责是：
-1. 识别代码中的潜在问题（安全漏洞、性能问题、逻辑错误等）
-2. 提供具体的改进建议
-3. 指出不符合最佳实践的代码
-4. 评估代码的可维护性和可读性
-
-请以专业、建设性的语气提供审查意见。`;
-
-    if (guardConfig) {
-      prompt += `\n\n项目特定的审查规则：\n${guardConfig}`;
-    }
-
-    return prompt;
-  }
-
-  /**
-   * 构建代码审查提示词
-   * @private
-   */
-  _buildReviewPrompt(diff, fileName) {
-    return `请审查以下代码变更：
-
-**文件名**: ${fileName}
-
-**代码差异**:
-\`\`\`diff
-${diff}
-\`\`\`
-
-请提供：
-1. 主要问题（如果有）
-2. 改进建议
-3. 优点（如果有）
-
-如果代码没有问题，请简要说明代码质量良好。`;
+  getClient() {
+    return this.openai;
   }
 
   /**
-   * 批量审查多个文件的变更
-   * @param {Array} changes - 变更数组
-   * @param {string} guardConfig - AI Review Guard 配置
-   * @returns {Promise<Array>} 审查结果数组
+   * 获取当前配置
+   * @returns {Object} 配置对象
    */
-  async reviewMultipleFiles(changes, guardConfig = '') {
-    const reviews = [];
-
-    for (const change of changes) {
-      try {
-        const result = await this.reviewCode({
-          diff: change.diff,
-          fileName: change.new_path || change.old_path,
-          guardConfig,
-        });
-
-        reviews.push({
-          fileName: change.new_path || change.old_path,
-          status: 'success',
-          ...result,
-        });
-      } catch (error) {
-        reviews.push({
-          fileName: change.new_path || change.old_path,
-          status: 'error',
-          error: error.message,
-        });
-      }
-    }
-
-    return reviews;
+  getConfig() {
+    return {
+      model: this.model,
+      ...this.config,
+    };
   }
 }
 

package/lib/prompt-tools.js

@@ -0,0 +1,142 @@
+/**
+ * Prompt 工具 - 用于拼接代码审查的提示词
+ */
+
+/**
+ * 构建系统提示词
+ * @param {string} guardConfig - AI Review Guard 配置内容
+ * @returns {string} 系统提示词
+ */
+export function buildSystemPrompt(guardConfig = '') {
+  let prompt = `你是一个专业的代码审查助手，负责审查 GitLab Merge Request 的代码变更。
+
+你的职责是：
+1. 识别代码中的潜在问题（安全漏洞、性能问题、逻辑错误等）
+2. 提供具体的改进建议
+3. 指出不符合最佳实践的代码
+4. 评估代码的可维护性和可读性
+
+请以专业、建设性的语气提供审查意见。`;
+
+  if (guardConfig) {
+    prompt += `\n\n项目特定的审查规则：\n${guardConfig}`;
+  }
+
+  return prompt;
+}
+
+/**
+ * 构建代码审查的用户提示词
+ * @param {string} diff - 代码差异
+ * @param {string} fileName - 文件名
+ * @returns {string} 用户提示词
+ */
+export function buildReviewPrompt(diff, fileName) {
+  return `请审查以下代码变更：
+
+**文件名**: ${fileName}
+
+**代码差异**:
+\`\`\`diff
+${diff}
+\`\`\`
+
+请提供：
+1. 主要问题（如果有）
+2. 改进建议
+3. 优点（如果有）
+
+如果代码没有问题，请简要说明代码质量良好。`;
+}
+
+/**
+ * 构建完整的审查消息数组
+ * @param {Object} params - 参数
+ * @param {string} params.diff - 代码差异
+ * @param {string} params.fileName - 文件名
+ * @param {string} params.guardConfig - AI Review Guard 配置
+ * @returns {Array} 消息数组
+ */
+export function buildReviewMessages({ diff, fileName, guardConfig = '' }) {
+  return [
+    { role: 'system', content: buildSystemPrompt(guardConfig) },
+    { role: 'user', content: buildReviewPrompt(diff, fileName) },
+  ];
+}
+
+/**
+ * 构建批量审查的提示词
+ * @param {Array} changes - 代码变更数组
+ * @param {string} guardConfig - AI Review Guard 配置
+ * @returns {string} 批量审查提示词
+ */
+export function buildBatchReviewPrompt(changes, guardConfig = '') {
+  let prompt = buildSystemPrompt(guardConfig);
+  
+  prompt += '\n\n请审查以下 ' + changes.length + ' 个文件的代码变更：\n\n';
+  
+  changes.forEach((change, index) => {
+    const fileName = change.new_path || change.old_path;
+    const status = change.new_file ? '新增' : change.deleted_file ? '删除' : '修改';
+    
+    prompt += `## ${index + 1}. ${fileName} (${status})\n\n`;
+    prompt += '```diff\n';
+    prompt += change.diff || '(无差异内容)';
+    prompt += '\n```\n\n';
+  });
+  
+  prompt += '\n请为每个文件提供审查意见，并在最后给出整体评价。';
+  
+  return prompt;
+}
+
+/**
+ * 格式化 diff 内容（可选的预处理）
+ * @param {string} diff - 原始 diff
+ * @returns {string} 格式化后的 diff
+ */
+export function formatDiff(diff) {
+  if (!diff) return '(无变更内容)';
+  
+  // 移除过长的 diff（可选）
+  const maxLines = 500;
+  const lines = diff.split('\n');
+  
+  if (lines.length > maxLines) {
+    return lines.slice(0, maxLines).join('\n') + 
+           `\n... (省略 ${lines.length - maxLines} 行)`;
+  }
+  
+  return diff;
+}
+
+/**
+ * 从 change 对象中提取关键信息
+ * @param {Object} change - GitLab change 对象
+ * @returns {Object} 提取的信息
+ */
+export function extractChangeInfo(change) {
+  return {
+    fileName: change.new_path || change.old_path,
+    oldPath: change.old_path,
+    newPath: change.new_path,
+    status: change.new_file ? 'added' : 
+            change.deleted_file ? 'deleted' : 
+            change.renamed_file ? 'renamed' : 
+            'modified',
+    diff: change.diff || '',
+    isNewFile: change.new_file,
+    isDeleted: change.deleted_file,
+    isRenamed: change.renamed_file,
+  };
+}
+
+export default {
+  buildSystemPrompt,
+  buildReviewPrompt,
+  buildReviewMessages,
+  buildBatchReviewPrompt,
+  formatDiff,
+  extractChangeInfo,
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-ai-review",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "GitLab AI Review SDK - 支持 CI/CD 自动配置和 ARK API",
   "main": "index.js",
   "type": "module",