gitlab-ai-review 1.1.0 → 2.0.0

package/index.js

@@ -6,6 +6,8 @@
 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';
+import * as DiffParser from './lib/diff-parser.js';
 
 /**
  * GitLab AI Review SDK 主类
@@ -13,7 +15,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 = '2.0.0';
 
     // 如果传入了配置，使用手动配置；否则使用自动检测
     if (options.token || options.gitlab) {
@@ -136,58 +138,89 @@ export class GitLabAIReview {
   }
 
   /**
-   * AI 审查单个文件的代码变更
+   * AI 审查特定行的变更并在该行添加评论（附带项目 prompt）
+   * @param {Object} change - 代码变更对象
+   * @param {Object} changeInfo - 具体的行变更信息
+   * @returns {Promise<Object>} 评论结果
    */
-  async reviewCodeChange(change) {
+  async reviewAndCommentOnLine(change, changeInfo) {
     const aiClient = this.getAIClient();
-    const guardConfig = this.config.ai?.guardConfig?.content || '';
+    
+    // 获取项目配置的 prompt（来自 reviewguard.md）
+    const projectPrompt = this.config.ai?.guardConfig?.content || '';
 
-    return aiClient.reviewCode({
-      diff: change.diff,
+    // 构建针对特定行的审查消息（附带项目 prompt）
+    const messages = PromptTools.buildLineReviewMessages({
+      ...changeInfo,
       fileName: change.new_path || change.old_path,
-      guardConfig,
-    });
-  }
+    }, projectPrompt);
 
-  /**
-   * AI 审查 MR 的所有代码变更
-   */
-  async reviewMergeRequest() {
-    const changes = await this.getMergeRequestChanges();
-    const aiClient = this.getAIClient();
-    const guardConfig = this.config.ai?.guardConfig?.content || '';
+    // 调用 AI 审查
+    const review = await aiClient.sendMessage(messages);
+
+    // 在该行添加评论
+    const lineInfo = {
+      filePath: change.new_path || change.old_path,
+      oldPath: change.old_path,
+      newLine: changeInfo.lineNumber,
+    };
 
-    return aiClient.reviewMultipleFiles(changes, guardConfig);
+    const commentResult = await this.gitlabClient.createLineComment(
+      this.config.project.projectId,
+      this.config.project.mergeRequestIid,
+      `🤖 **AI 代码审查**\n\n${review.content}`,
+      lineInfo
+    );
+
+    return {
+      review,
+      comment: commentResult,
+    };
   }
 
   /**
-   * AI 审查 MR 并自动添加评论
+   * AI 审查 MR 的所有有意义的变更并自动添加行级评论
+   * @param {Object} options - 选项
+   * @param {number} options.maxComments - 最大评论数量（避免过多评论）
+   * @returns {Promise<Array>} 评论结果数组
    */
-  async reviewAndComment() {
-    const reviews = await this.reviewMergeRequest();
-    
-    // 构建评论内容
-    let comment = '## 🤖 AI 代码审查报告\n\n';
-    
-    for (const review of reviews) {
-      if (review.status === 'error') {
-        comment += `### ❌ ${review.fileName}\n`;
-        comment += `审查失败: ${review.error}\n\n`;
-        continue;
+  async reviewAndCommentOnLines(options = {}) {
+    const { maxComments = 10 } = options;
+    const changes = await this.getMergeRequestChanges();
+    const results = [];
+
+    for (const change of changes) {
+      if (results.length >= maxComments) {
+        console.log(`已达到最大评论数量限制 (${maxComments})，停止审查`);
+        break;
       }
 
-      comment += `### 📄 ${review.fileName}\n\n`;
-      
-      if (review.reasoning) {
-        comment += `**思考过程**:\n${review.reasoning}\n\n`;
+      // 解析 diff，提取有意义的变更
+      const hunks = DiffParser.parseDiff(change.diff);
+      const meaningfulChanges = DiffParser.extractMeaningfulChanges(hunks);
+
+      // 对每个有意义的变更进行审查
+      for (const meaningfulChange of meaningfulChanges.slice(0, maxComments - results.length)) {
+        try {
+          const result = await this.reviewAndCommentOnLine(change, meaningfulChange);
+          results.push({
+            status: 'success',
+            fileName: change.new_path || change.old_path,
+            lineNumber: meaningfulChange.lineNumber,
+            ...result,
+          });
+        } catch (error) {
+          results.push({
+            status: 'error',
+            fileName: change.new_path || change.old_path,
+            lineNumber: meaningfulChange.lineNumber,
+            error: error.message,
+          });
+        }
       }
-      
-      comment += `**审查意见**:\n${review.content}\n\n`;
-      comment += `---\n\n`;
     }
 
-    // 添加评论到 MR
-    return this.addComment(comment);
+    return results;
   }
 
   /**
@@ -198,10 +231,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, DiffParser };
 
 // 默认导出
 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/diff-parser.js

@@ -0,0 +1,197 @@
+/**
+ * Diff 解析工具 - 解析 Git Diff 格式
+ */
+
+/**
+ * 解析 diff 的 hunk 头部信息
+ * 例如: @@ -14,7 +14,7 @@ 
+ * @param {string} hunkHeader - hunk 头部字符串
+ * @returns {Object} 解析后的位置信息
+ */
+export function parseHunkHeader(hunkHeader) {
+  const match = hunkHeader.match(/@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@/);
+  
+  if (!match) {
+    return null;
+  }
+
+  return {
+    oldStart: parseInt(match[1], 10),
+    oldLines: match[2] ? parseInt(match[2], 10) : 1,
+    newStart: parseInt(match[3], 10),
+    newLines: match[4] ? parseInt(match[4], 10) : 1,
+  };
+}
+
+/**
+ * 解析完整的 diff 内容，提取所有变更位置
+ * @param {string} diff - diff 内容
+ * @returns {Array} 变更块数组
+ */
+export function parseDiff(diff) {
+  if (!diff) return [];
+
+  const lines = diff.split('\n');
+  const hunks = [];
+  let currentHunk = null;
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+
+    // 检测 hunk 头部
+    if (line.startsWith('@@')) {
+      if (currentHunk) {
+        hunks.push(currentHunk);
+      }
+
+      const hunkInfo = parseHunkHeader(line);
+      currentHunk = {
+        ...hunkInfo,
+        header: line,
+        changes: [],
+        contextBefore: [],
+        contextAfter: [],
+      };
+    } else if (currentHunk) {
+      // 收集变更行
+      if (line.startsWith('+') && !line.startsWith('+++')) {
+        currentHunk.changes.push({
+          type: 'addition',
+          content: line.substring(1),
+          line: line,
+        });
+      } else if (line.startsWith('-') && !line.startsWith('---')) {
+        currentHunk.changes.push({
+          type: 'deletion',
+          content: line.substring(1),
+          line: line,
+        });
+      } else if (line.startsWith(' ')) {
+        currentHunk.changes.push({
+          type: 'context',
+          content: line.substring(1),
+          line: line,
+        });
+      }
+    }
+  }
+
+  if (currentHunk) {
+    hunks.push(currentHunk);
+  }
+
+  return hunks;
+}
+
+/**
+ * 计算变更在新文件中的具体行号
+ * @param {Object} hunk - hunk 信息
+ * @param {number} changeIndex - 变更在 changes 数组中的索引
+ * @returns {number} 新文件中的行号
+ */
+export function calculateNewLineNumber(hunk, changeIndex) {
+  let lineNumber = hunk.newStart;
+  
+  for (let i = 0; i <= changeIndex; i++) {
+    const change = hunk.changes[i];
+    if (change.type === 'addition' || change.type === 'context') {
+      if (i === changeIndex) {
+        return lineNumber;
+      }
+      lineNumber++;
+    }
+  }
+  
+  return lineNumber;
+}
+
+/**
+ * 提取有意义的变更（忽略纯空白变更）
+ * @param {Array} hunks - hunks 数组
+ * @returns {Array} 有意义的变更数组
+ */
+export function extractMeaningfulChanges(hunks) {
+  const meaningfulChanges = [];
+
+  hunks.forEach(hunk => {
+    let currentNewLine = hunk.newStart;
+
+    hunk.changes.forEach((change, index) => {
+      if (change.type === 'addition') {
+        const content = change.content.trim();
+        
+        // 过滤空行和仅包含符号的行
+        if (content.length > 0 && !/^[{}()\[\];,]*$/.test(content)) {
+          meaningfulChanges.push({
+            type: 'addition',
+            content: change.content,
+            lineNumber: currentNewLine,
+            hunk: hunk.header,
+            context: {
+              before: hunk.changes.slice(Math.max(0, index - 2), index).map(c => c.content),
+              after: hunk.changes.slice(index + 1, index + 3).map(c => c.content),
+            },
+          });
+        }
+        currentNewLine++;
+      } else if (change.type === 'deletion') {
+        const content = change.content.trim();
+        
+        if (content.length > 0 && !/^[{}()\[\];,]*$/.test(content)) {
+          meaningfulChanges.push({
+            type: 'deletion',
+            content: change.content,
+            oldLineNumber: currentNewLine,
+            hunk: hunk.header,
+            context: {
+              before: hunk.changes.slice(Math.max(0, index - 2), index).map(c => c.content),
+              after: hunk.changes.slice(index + 1, index + 3).map(c => c.content),
+            },
+          });
+        }
+      } else if (change.type === 'context') {
+        currentNewLine++;
+      }
+    });
+  });
+
+  return meaningfulChanges;
+}
+
+/**
+ * 生成变更摘要
+ * @param {string} diff - diff 内容
+ * @returns {Object} 变更摘要
+ */
+export function generateDiffSummary(diff) {
+  if (!diff) {
+    return { additions: 0, deletions: 0, changes: 0 };
+  }
+
+  const lines = diff.split('\n');
+  let additions = 0;
+  let deletions = 0;
+
+  lines.forEach(line => {
+    if (line.startsWith('+') && !line.startsWith('+++')) {
+      additions++;
+    } else if (line.startsWith('-') && !line.startsWith('---')) {
+      deletions++;
+    }
+  });
+
+  return {
+    additions,
+    deletions,
+    changes: additions + deletions,
+  };
+}
+
+export default {
+  parseHunkHeader,
+  parseDiff,
+  calculateNewLineNumber,
+  extractMeaningfulChanges,
+  generateDiffSummary,
+};
+

package/lib/gitlab-client.js

@@ -69,9 +69,37 @@ export class GitLabClient {
   }
 
   /**
-   * 在 MR 上创建讨论（行内评论）
+   * 在 MR 的特定行上创建评论
+   * @param {string} projectId - 项目 ID
+   * @param {number} mergeRequestIid - MR IID
+   * @param {string} body - 评论内容
+   * @param {Object} lineInfo - 行信息
+   * @param {string} lineInfo.filePath - 文件路径
+   * @param {number} lineInfo.newLine - 新文件行号
+   * @param {number} lineInfo.oldLine - 旧文件行号（可选）
+   * @returns {Promise<Object>} 创建的讨论
    */
-  async createMergeRequestDiscussion(projectId, mergeRequestIid, body, position) {
+  async createLineComment(projectId, mergeRequestIid, body, lineInfo) {
+    // 先获取 MR 信息以获取 SHA
+    const mr = await this.getMergeRequest(projectId, mergeRequestIid);
+
+    const position = {
+      base_sha: mr.diff_refs.base_sha,
+      head_sha: mr.diff_refs.head_sha,
+      start_sha: mr.diff_refs.start_sha,
+      position_type: 'text',
+      new_path: lineInfo.filePath,
+      old_path: lineInfo.oldPath || lineInfo.filePath,
+    };
+
+    // 设置行号
+    if (lineInfo.newLine !== undefined) {
+      position.new_line = lineInfo.newLine;
+    }
+    if (lineInfo.oldLine !== undefined) {
+      position.old_line = lineInfo.oldLine;
+    }
+
     return this.request(
       `/projects/${encodeURIComponent(projectId)}/merge_requests/${mergeRequestIid}/discussions`,
       {
@@ -83,5 +111,39 @@ export class GitLabClient {
       }
     );
   }
+
+  /**
+   * 批量创建行级评论
+   * @param {string} projectId - 项目 ID
+   * @param {number} mergeRequestIid - MR IID
+   * @param {Array} comments - 评论数组
+   * @returns {Promise<Array>} 创建结果数组
+   */
+  async createMultipleLineComments(projectId, mergeRequestIid, comments) {
+    const results = [];
+
+    for (const comment of comments) {
+      try {
+        const result = await this.createLineComment(
+          projectId,
+          mergeRequestIid,
+          comment.body,
+          comment.lineInfo
+        );
+        results.push({
+          status: 'success',
+          result,
+        });
+      } catch (error) {
+        results.push({
+          status: 'error',
+          error: error.message,
+          comment,
+        });
+      }
+    }
+
+    return results;
+  }
 }
 

package/lib/prompt-tools.js

@@ -0,0 +1,101 @@
+/**
+ * Prompt 工具 - 用于拼接行级代码审查的提示词
+ * 简化版：只支持行级审查
+ */
+
+/**
+ * 构建系统提示词（附带项目 prompt）
+ * @param {string} projectPrompt - 项目配置的 prompt（来自 reviewguard.md）
+ * @returns {string} 系统提示词
+ */
+export function buildSystemPrompt(projectPrompt = '') {
+  let prompt = `你是一个专业的代码审查助手，负责审查 GitLab Merge Request 的代码变更。
+
+你的职责是：
+1. 识别代码中的潜在问题（安全漏洞、性能问题、逻辑错误等）
+2. 提供具体的改进建议
+3. 指出不符合最佳实践的代码
+4. 评估代码的可维护性和可读性
+
+请以专业、建设性的语气提供审查意见。`;
+
+  // 附带项目特定的审查规则
+  if (projectPrompt) {
+    prompt += `\n\n## 项目特定的审查规则\n\n${projectPrompt}`;
+  }
+
+  return prompt;
+}
+
+/**
+ * 构建针对特定行变更的审查提示词（附带项目 prompt）
+ * @param {Object} changeInfo - 变更信息
+ * @param {string} changeInfo.content - 变更内容
+ * @param {string} changeInfo.type - 变更类型（addition/deletion）
+ * @param {number} changeInfo.lineNumber - 行号
+ * @param {string} changeInfo.fileName - 文件名
+ * @param {Object} changeInfo.context - 上下文
+ * @returns {string} 审查提示词
+ */
+export function buildLineReviewPrompt(changeInfo) {
+  const { content, type, lineNumber, fileName, context } = changeInfo;
+  
+  let prompt = `请审查以下代码变更：
+
+**文件**: ${fileName}
+**行号**: ${lineNumber}
+**变更类型**: ${type === 'addition' ? '新增' : '删除'}
+
+**变更内容**:
+\`\`\`
+${type === 'addition' ? '+' : '-'} ${content}
+\`\`\`
+`;
+
+  if (context && (context.before.length > 0 || context.after.length > 0)) {
+    prompt += '\n**上下文**:\n```\n';
+    if (context.before.length > 0) {
+      context.before.forEach(line => {
+        prompt += `  ${line}\n`;
+      });
+    }
+    prompt += `${type === 'addition' ? '+' : '-'} ${content}\n`;
+    if (context.after.length > 0) {
+      context.after.forEach(line => {
+        prompt += `  ${line}\n`;
+      });
+    }
+    prompt += '```\n';
+  }
+
+  prompt += `
+请提供简洁的审查意见：
+1. 如果有问题，指出具体问题
+2. 如果有改进建议，提供具体的建议
+3. 如果代码没有问题，简单说明"代码质量良好"
+
+请直接给出审查意见，不要重复代码内容。`;
+
+  return prompt;
+}
+
+/**
+ * 构建针对特定行变更的完整消息数组（附带项目 prompt）
+ * @param {Object} changeInfo - 变更信息
+ * @param {string} projectPrompt - 项目配置的 prompt（来自 reviewguard.md）
+ * @returns {Array} 消息数组
+ */
+export function buildLineReviewMessages(changeInfo, projectPrompt = '') {
+  return [
+    { role: 'system', content: buildSystemPrompt(projectPrompt) },
+    { role: 'user', content: buildLineReviewPrompt(changeInfo) },
+  ];
+}
+
+// 只导出行级审查需要的函数
+export default {
+  buildSystemPrompt,
+  buildLineReviewPrompt,
+  buildLineReviewMessages,
+};
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gitlab-ai-review",
-  "version": "1.1.0",
-  "description": "GitLab AI Review SDK - 支持 CI/CD 自动配置和 ARK API",
+  "version": "2.0.0",
+  "description": "GitLab AI Review SDK - 行级代码审查，附带项目 Prompt",
   "main": "index.js",
   "type": "module",
   "scripts": {