gitlab-ai-review 2.5.4 → 3.0.1

package/README.md

@@ -9,6 +9,13 @@ GitLab AI Review SDK - 支持 CI/CD 自动配置和手动配置
 - ✅ 支持手动传递配置
 - ✅ 获取项目和 MR 信息
 - ✅ 添加 MR 评论
+- ✅ **全面影响分析** 🆕
+  - 检测删除符号的影响
+  - 检查文件内部冲突
+  - 追踪跨文件依赖关系
+  - 完整上下文分析
+- ✅ 行级 AI 代码审查
+- ✅ 批量审查和评论
 
 ## 安装
 
@@ -135,44 +142,221 @@ changes.forEach(change => {
 await sdk.addComment('✅ 代码审查通过！');
 ```
 
+#### `reviewWithImpactAnalysis(options)` 🆕
+AI 审查 MR 的所有变更（包含影响分析）
+
+```javascript
+// 使用默认配置（启用影响分析）
+const results = await sdk.reviewWithImpactAnalysis();
+
+// 自定义配置
+const results = await sdk.reviewWithImpactAnalysis({
+  maxFiles: 5,              // 最多审查 5 个文件
+  maxAffectedFiles: 10,     // 每个文件最多分析 10 个受影响的文件
+  enableImpactAnalysis: true // 启用影响分析（默认）
+});
+
+console.log(`审查完成，共添加 ${results.length} 条评论`);
+```
+
+**参数：**
+- `options.maxFiles` - 最大审查文件数量（默认不限制）
+- `options.maxAffectedFiles` - 每个文件最多分析的受影响文件数量（默认 10）
+- `options.enableImpactAnalysis` - 是否启用影响分析（默认 true）
+
+**返回值：**
+返回评论结果数组，每个元素包含：
+- `status` - 'success' 或 'error'
+- `fileName` - 文件名
+- `lineNumber` - 行号
+- `comment` - 评论内容
+- `error` - 错误信息（如果失败）
+
+#### `reviewAndCommentOnLines(options)`
+AI 审查 MR 的所有变更（不包含影响分析）
+
+```javascript
+const results = await sdk.reviewAndCommentOnLines({
+  maxFiles: 10 // 最多审查 10 个文件
+});
+```
+
 ## 在 GitLab CI/CD 中使用
 
-`.gitlab-ci.yml` 示例：
+### 推荐配置：使用 npx 直接运行
+
+在 GitLab 项目根目录创建 `.gitlab-ci.yml` 文件：
 
 ```yaml
+# GitLab CI/CD 配置
+# 使用 gitlab-ai-review CLI (npx 方式)
+
 stages:
   - review
 
-ai-review:
+# gitlab-ai-review CLI 执行任务（推荐）
+ai-code-review:
   stage: review
-  image: node:18
+  image: node:18-alpine 
+  tags:
+    - docker   
+  timeout: 30m
   only:
-    - merge_requests
+    - merge_requests  # 只在 MR 时运行
+  variables:
+    # 🔑 手动传递 GitLab Token
+    # 注意：在生产环境中，应该在 GitLab CI/CD Settings > Variables 中配置
+    GITLAB_TOKEN: $GITLAB_TOKEN
+    
+    # 🤖 ARK API Key（用于 AI Review）
+    ARK_API_KEY: $ARK_API_KEY
+    
+    # GitLab CI 自动提供的环境变量（无需配置）：
+    # - CI_JOB_TOKEN (自动生成的临时 Token)
+    # - CI_SERVER_URL (GitLab 地址)
+    # - CI_PROJECT_ID (项目 ID)
+    # - CI_MERGE_REQUEST_IID (MR 编号)
+    
   script:
-    - npm install gitlab-ai-review
-    - node review.js
+    - echo ""
+    - echo "🔑 环境变量检查..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - echo "ARK_API_KEY = ${ARK_API_KEY}"
+    - echo "GITLAB_TOKEN = ${GITLAB_TOKEN:0:10}..."
+    - echo "CI_JOB_TOKEN = ${CI_JOB_TOKEN:0:10}..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - echo ""
+    - echo "🚀 使用 npx 执行 gitlab-ai-review CLI..."
+    - echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    - npx gitlab-ai-review
+    
+  allow_failure: true  # 不阻塞 MR 合并
+  timeout: 10m  # 超时时间
 ```
 
-`review.js` 示例：
+### 环境变量配置
+
+在 GitLab 项目的 **Settings > CI/CD > Variables** 中配置：
+
+| 变量名 | 说明 | 是否必需 |
+|-------|------|---------|
+| `ARK_API_KEY` | 火山引擎 ARK API 密钥 | ✅ 必需 |
+| `GITLAB_TOKEN` | GitLab 访问令牌 | ⚠️ 建议配置（可用 `CI_JOB_TOKEN` 替代） |
+
+### AI 模型信息
+
+本项目使用**火山引擎豆包大模型**进行代码审查：
+
+- **模型**: `doubao-seed-1-6-251015`
+- **申请地址**: [火山引擎 ARK 平台](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seed-1-6)
+
+**如何申请 ARK API Key：**
+1. 访问 [火山引擎 ARK 控制台](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seed-1-6)
+2. 注册/登录账号
+3. 创建 API Key
+4. 将 API Key 配置到 GitLab CI/CD Variables 中
+
+---
+
+## 🎯 影响分析示例
+
+### 场景 1：删除被使用的函数
 
 ```javascript
-import GitLabAIReview from 'gitlab-ai-review';
+// 变更：删除了 utils/api.js 中的 fetchData
+- export function fetchData(url) { ... }
 
-const sdk = new GitLabAIReview();
+// AI 审查结果：
+🤖 AI 代码审查
 
-// 获取 MR 信息
-const mr = await sdk.getMergeRequest();
-console.log('正在审查 MR:', mr.title);
+⚠️ 严重问题：函数 fetchData 已被删除
 
-// 获取代码变更
-const changes = await sdk.getMergeRequestChanges();
-console.log(`共有 ${changes.length} 个文件变更`);
+影响分析显示：
+- components/UserList.vue (第 45 行) 在使用此函数
+- pages/Dashboard.vue (第 78 行) 在使用此函数
+- services/data.js (第 12 行) 在使用此函数
 
-// 添加评论
-await sdk.addComment('🤖 AI 代码审查已完成！');
+共 3 个文件将无法正常工作，建议：
+1. 恢复此函数，或
+2. 提供替代方案并更新所有调用处
 ```
 
-## 版本
+### 场景 2：文件内部冲突
+
+```javascript
+// 变更：删除了辅助函数
+- function calculateTotal(items) { ... }
+
+export function checkout() {
+  const total = calculateTotal(cart.items)  // 💥 这里会报错
+  // ...
+}
+
+// AI 审查结果：
+🤖 AI 代码审查
+
+🚨 严重错误：文件内部冲突
+
+函数 calculateTotal 在第 5 行被删除，但在第 12 行仍被调用。
+这将导致运行时错误：ReferenceError: calculateTotal is not defined
+
+必须修复：
+1. 恢复 calculateTotal 函数，或
+2. 修改第 12 行的调用逻辑
+```
+
+### 场景 3：函数签名变更
+
+```javascript
+// 变更：修改了函数参数
+- export function process(data) { ... }
++ export function process(data, options = {}) { ... }
+
+// AI 审查结果：
+🤖 AI 代码审查
+
+⚠️ 函数签名已改变，新增了 options 参数
+
+影响分析显示有 8 个文件在使用此函数，但都未传递新参数。
+虽然有默认值，但建议检查是否需要在关键场景中传递 options。
+
+受影响的文件：
+- components/Processor.vue
+- services/processor.js
+...
+```
+
+## 版本历史
+
+### 3.0.0 - 全面影响分析 🆕
+
+**重大更新**：从简单的 diff 审查升级为全面的影响分析系统
+
+- ✨ 删除符号检测：自动检测被删除的函数/类/组件，并分析影响范围
+- ✨ 文件内部冲突检查：检测文件内部是否使用了被删除的符号
+- ✨ 完整文件上下文：AI 审查时提供完整文件内容，而非仅 diff
+- ✨ 跨文件依赖追踪：使用 GitLab Search API 搜索符号使用情况
+- ✨ 修改符号识别：识别被修改的函数签名，检查 API 兼容性
+- ⚡ 使用火山引擎豆包大模型 `doubao-seed-1-6-251015`
+
+### 2.4.0
+
+- ✅ 行级 AI 代码审查
+- ✅ 批量审查和评论
+- ✅ 基础影响分析
+
+### 2.3.0
+
+- ✅ 支持 `reviewguard.md` 配置文件
+- ✅ 项目特定审查规则
+
+### 2.0.0
+
+- ✅ CI/CD 自动配置
+- ✅ 手动配置支持
+- ✅ GitLab API 客户端封装
+
+### 1.0.0
 
-- 1.0.1 - 添加 GitLab 客户端封装和自动配置
-- 1.0.0 - 初始测试版本
+- ✅ 初始版本发布
+- ✅ 基础 GitLab 集成

package/cli.js

@@ -7,7 +7,68 @@
 
 import { GitLabAIReview } from './index.js';
 
+// 解析命令行参数
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const options = {
+    enableImpactAnalysis: true, // 默认启用影响分析
+    maxAffectedFiles: 10,
+    maxFiles: Infinity,
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    
+    if (arg === '--no-impact' || arg === '--disable-impact') {
+      options.enableImpactAnalysis = false;
+    } else if (arg === '--max-affected-files' && args[i + 1]) {
+      options.maxAffectedFiles = parseInt(args[i + 1], 10);
+      i++;
+    } else if (arg === '--max-files' && args[i + 1]) {
+      options.maxFiles = parseInt(args[i + 1], 10);
+      i++;
+    } else if (arg === '--help' || arg === '-h') {
+      console.log(`
+GitLab AI Review CLI
+
+用法:
+  npx gitlab-ai-review [选项]
+
+选项:
+  --no-impact, --disable-impact    禁用影响分析（默认启用）
+  --max-affected-files <数量>      每个文件最多分析的受影响文件数量（默认 10）
+  --max-files <数量>                最大审查文件数量（默认不限制）
+  --help, -h                        显示帮助信息
+
+环境变量:
+  GITLAB_TOKEN                      GitLab 访问令牌
+  CI_PROJECT_ID                     项目 ID
+  CI_MERGE_REQUEST_IID              MR IID
+  ARK_API_KEY                       AI API 密钥
+
+示例:
+  # 默认模式（启用影响分析）
+  npx gitlab-ai-review
+
+  # 禁用影响分析
+  npx gitlab-ai-review --no-impact
+
+  # 自定义受影响文件数量
+  npx gitlab-ai-review --max-affected-files 5
+
+  # 限制审查文件数量
+  npx gitlab-ai-review --max-files 3
+`);
+      process.exit(0);
+    }
+  }
+
+  return options;
+}
+
 async function main() {
+  const cliOptions = parseArgs();
+  
   console.log('🚀 GitLab AI Review CLI 启动...\n');
 
   try {
@@ -16,11 +77,15 @@ async function main() {
 
     // 2. 验证配置
     console.log('📋 配置信息:');
-    console.log(`  - GitLab Host: ${sdk.config.gitlab.host}`);
+    console.log(`  - GitLab Host: ${sdk.config.gitlab.url}`);
     console.log(`  - Project ID: ${sdk.config.project.projectId}`);
     console.log(`  - MR IID: ${sdk.config.project.mergeRequestIid}`);
     console.log(`  - AI API Key: ${sdk.config.ai?.arkApiKey ? '✅ 已配置' : '❌ 未配置'}`);
     console.log(`  - Review Guard: ${sdk.config.ai?.guardConfig?.content ? '✅ 已加载' : '⚠️ 未找到'}`);
+    console.log(`  - 影响分析: ${cliOptions.enableImpactAnalysis ? '✅ 已启用' : '⚠️ 已禁用'}`);
+    if (cliOptions.enableImpactAnalysis) {
+      console.log(`  - 最多分析受影响文件: ${cliOptions.maxAffectedFiles} 个`);
+    }
     console.log();
 
     // 3. 获取 MR 变更信息
@@ -28,105 +93,19 @@ async function main() {
     const changes = await sdk.getMergeRequestChanges();
     console.log(`✅ 共发现 ${changes.length} 个文件变更\n`);
 
-    // 3.1 输出详细的变更列表
-    if (changes.length > 0) {
-      console.log('📝 变更文件列表:');
-      console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
-      
-      changes.forEach((change, index) => {
-        const fileName = change.new_path || change.old_path;
-        let status = '';
-        let statusIcon = '';
-        
-        // 判断文件状态
-        if (change.new_file) {
-          status = '新增';
-          statusIcon = '✨';
-        } else if (change.deleted_file) {
-          status = '删除';
-          statusIcon = '🗑️';
-        } else if (change.renamed_file) {
-          status = '重命名';
-          statusIcon = '📝';
-        } else {
-          status = '修改';
-          statusIcon = '✏️';
-        }
-        
-        // 计算变更行数
-        const diff = change.diff || '';
-        const addedLines = (diff.match(/^\+[^+]/gm) || []).length;
-        const deletedLines = (diff.match(/^-[^-]/gm) || []).length;
-        
-        console.log(`${index + 1}. ${statusIcon} ${status} - ${fileName}`);
-        if (addedLines > 0 || deletedLines > 0) {
-          console.log(`   📊 +${addedLines} -${deletedLines} 行`);
-        }
-        
-        // 如果是重命名，显示旧路径
-        if (change.renamed_file && change.old_path !== change.new_path) {
-          console.log(`   📂 ${change.old_path} → ${change.new_path}`);
-        }
-        
-        // 输出具体的 diff 内容
-        if (diff) {
-          console.log(`\n   📄 Diff 内容:`);
-          console.log('   ┌─────────────────────────────────────────────────────');
-          
-          // 分行显示 diff，并添加颜色标记
-          const diffLines = diff.split('\n');
-          diffLines.forEach((line, lineIndex) => {
-            // 限制显示最多 100 行 diff
-            if (lineIndex >= 100) {
-              if (lineIndex === 100) {
-                console.log('   │ ... (diff 内容过长，已截断)');
-              }
-              return;
-            }
-            
-            // 为不同类型的行添加标记
-            let prefix = '   │ ';
-            if (line.startsWith('+++') || line.startsWith('---')) {
-              prefix = '   │ 📁 '; // 文件路径
-            } else if (line.startsWith('@@')) {
-              prefix = '   │ 🔵 '; // hunk 标记
-            } else if (line.startsWith('+') && !line.startsWith('+++')) {
-              prefix = '   │ ➕ '; // 新增行
-            } else if (line.startsWith('-') && !line.startsWith('---')) {
-              prefix = '   │ ➖ '; // 删除行
-            }
-            
-            console.log(prefix + line);
-          });
-          
-          console.log('   └─────────────────────────────────────────────────────\n');
-        }
-      });
-      
-      console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
-    }
-
     // 4. 执行 AI 代码审查
     if (sdk.config.ai?.arkApiKey && changes.length > 0) {
       console.log('🤖 开始 AI 代码审查...\n');
       
-      const results = await sdk.reviewAndCommentOnLines();
+      // 使用新的影响分析方法
+      const results = await sdk.reviewWithImpactAnalysis(cliOptions);
       
-      // 统计结果
-      const fileNames = new Set(results.map(r => r.fileName));
+      console.log('\n📊 审查结果汇总:');
       const successCount = results.filter(r => r.status === 'success').length;
       const errorCount = results.filter(r => r.status === 'error').length;
-      const skippedCount = results.filter(r => r.status === 'skipped').length;
-      
-      console.log('\n📊 审查结果汇总:');
-      console.log(`  - 审查文件数: ${fileNames.size}`);
-      console.log(`  - 成功添加评论: ${successCount} 条`);
-      if (errorCount > 0) {
-        console.log(`  - 失败: ${errorCount} 条`);
-      }
-      if (skippedCount > 0) {
-        console.log(`  - 跳过: ${skippedCount} 条`);
-      }
+      console.log(`  - 总评论数: ${results.length}`);
+      console.log(`  - 成功: ${successCount}`);
+      console.log(`  - 失败: ${errorCount}`);
       
       if (errorCount > 0) {
         console.log('\n⚠️ 部分评论添加失败，请检查上方日志');