gitlab-ai-review 4.2.4 → 6.3.9

package/README.md

@@ -1,5 +1,7 @@
 # GitLab AI Review SDK
 
+> ⚠️ **v5.0.0 重大变更**：已迁移至 WPS LLM Proxy API，不再支持豆包官网 ARK API。详见[版本历史](#版本历史)。
+
 GitLab AI Review SDK - 支持 CI/CD 自动配置和手动配置
 
 ## 功能特性
@@ -20,10 +22,20 @@ GitLab AI Review SDK - 支持 CI/CD 自动配置和手动配置
   - 自动跳过 Markdown 文件 (`.md`)
   - 自动跳过配置文件 (`.json`, `.yml`, `.yaml`)
   - 自动跳过依赖锁文件 (`package-lock.json`, `yarn.lock` 等)
-- ✅ **AI 自动生成审核规则** 🚀 NEW!
+- ✅ **AI 自动生成审核规则** 🚀
   - 自动分析项目技术栈和代码结构
   - 智能生成适合项目的审核提示词
   - 无需手动编写 `reviewguard.md` 文件
+- ✅ **评论反馈学习机制** 🆕 NEW!
+  - 自动收集 MR 评论上的 👍/👎 表情反馈
+  - 区分正样本（好评）和负样本（差评）
+  - 审查时携带历史反馈，AI 学习优秀审查风格
+  - 数据存储在 GitLab Package Registry，不污染代码提交
+- ✅ **项目文档上下文加载** 🆕 NEW!
+  - 自动加载项目根目录 `documents/` 文件夹下的 PRD.docx 和 TD.docx
+  - AI 自动总结产品需求文档和技术设计文档
+  - 审查时携带文档上下文，确保代码符合产品和技术设计
+  - 支持自定义文档路径
 
 ## 安装
 
@@ -322,6 +334,15 @@ npx gitlab-ai-review --max-files 5
 # 限制受影响文件分析数量
 npx gitlab-ai-review --max-affected-files 10
 
+# 禁用项目文档加载（PRD.docx 和 TD.docx）
+npx gitlab-ai-review --no-documents
+
+# 自定义文档路径
+npx gitlab-ai-review --documents-path docs
+
+# 禁用智能补充模式
+npx gitlab-ai-review --no-enhance
+
 # 查看帮助
 npx gitlab-ai-review --help
 ```
@@ -386,8 +407,21 @@ console.log('工具:', analysis.techStack.tools);
 console.log('关键文件:', analysis.keyFiles.length, '个');
 ```
 
-## 版本
+## 版本历史
+
+### v5.0.0 🔄 重大变更
+
+**⚠️ 破坏性变更：不再支持豆包官网 ARK API**
+
+
+
+
+
+
+
+### v4.x 历史版本
 
+- 4.2.4 - 支持豆包官网 ARK API（已废弃）
 - 4.0.3 - 🚀 新增 AI 自动生成审核规则功能，支持项目结构分析
 - 4.0.2 - 添加影响分析和智能文件过滤
 - 1.0.1 - 添加 GitLab 客户端封装和自动配置

package/cli.js

@@ -11,22 +11,37 @@ import { GitLabAIReview } from './index.js';
 function parseArgs() {
   const args = process.argv.slice(2);
   const options = {
-    enableImpactAnalysis: true, // 默认启用影响分析
-    maxAffectedFiles: 10,
     maxFiles: Infinity,
+    enableSummary: true,
+    // Guard 配置选项
+    useGitLabAPI: true,      // 使用 GitLab API 获取项目代码
+    enableEnhance: true,     // 启用智能补充模式
+    // 文档加载选项
+    loadDocuments: true,      // 加载项目文档 (PRD.docx 和 TD.docx)
+    documentsPath: 'documents', // 文档路径
   };
 
   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]) {
+    if (arg === '--max-files' && args[i + 1]) {
       options.maxFiles = parseInt(args[i + 1], 10);
       i++;
+    } else if (arg === '--no-summary') {
+      options.enableSummary = false;
+    } else if (arg === '--no-enhance') {
+      // 禁用智能补充模式（直接使用现有 reviewguard.md，不检查是否完整）
+      options.enableEnhance = false;
+    } else if (arg === '--local') {
+      // 使用本地模式（不通过 GitLab API 获取项目代码）
+      options.useGitLabAPI = false;
+    } else if (arg === '--no-documents') {
+      // 禁用文档加载
+      options.loadDocuments = false;
+    } else if (arg === '--documents-path' && args[i + 1]) {
+      // 自定义文档路径
+      options.documentsPath = args[i + 1];
+      i++;
     } else if (arg === '--help' || arg === '-h') {
       console.log(`
 GitLab AI Review CLI
@@ -35,29 +50,55 @@ GitLab AI Review CLI
   npx gitlab-ai-review [选项]
 
 选项:
-  --no-impact, --disable-impact    禁用影响分析（默认启用）
-  --max-affected-files <数量>      每个文件最多分析的受影响文件数量（默认 10）
-  --max-files <数量>                最大审查文件数量（默认不限制）
-  --help, -h                        显示帮助信息
+  --max-files <数量>        最大审查文件数量（默认不限制）
+  --no-summary              禁用 MR 总结评论
+  --no-enhance              禁用智能补充模式（直接使用现有 reviewguard.md）
+  --local                   使用本地模式（不通过 GitLab API 获取项目代码）
+  --no-documents            禁用项目文档加载（PRD.docx 和 TD.docx）
+  --documents-path <路径>   自定义文档文件夹路径（默认 'documents'）
+  --help, -h                显示帮助信息
 
 环境变量:
-  GITLAB_TOKEN                      GitLab 访问令牌
-  CI_PROJECT_ID                     项目 ID
-  CI_MERGE_REQUEST_IID              MR IID
-  ARK_API_KEY                       AI API 密钥
+  GITLAB_TOKEN              GitLab 访问令牌
+  CI_PROJECT_ID             项目 ID
+  CI_MERGE_REQUEST_IID      MR IID
+  ARK_API_KEY               AI API 密钥
 
-示例:
-  # 默认模式（启用影响分析）
-  npx gitlab-ai-review
+工作模式说明:
+
+  📌 默认模式（推荐）:
+     - 有 reviewguard.md: 结合项目代码检查是否完整，不完整则 AI 补充
+     - 无 reviewguard.md: 通过 GitLab API 获取整个项目代码，AI 生成
+     - 加载项目文档（PRD.docx 和 TD.docx），提供审查上下文
+
+  📌 --no-enhance 模式:
+     - 有 reviewguard.md: 直接使用，不检查是否完整
+     - 无 reviewguard.md: 通过 GitLab API 获取项目代码，AI 生成
 
-  # 禁用影响分析
-  npx gitlab-ai-review --no-impact
+  📌 --local 模式:
+     - 使用本地文件系统分析项目（适用于本地开发环境）
 
-  # 自定义受影响文件数量
-  npx gitlab-ai-review --max-affected-files 5
+  📌 --no-documents 模式:
+     - 不加载项目文档，在没有 PRD/TD 或文档不适用时使用
+
+示例:
+  # 默认模式（智能补充 + 文档加载）
+  npx gitlab-ai-review
 
   # 限制审查文件数量
   npx gitlab-ai-review --max-files 3
+
+  # 禁用智能补充（直接使用现有 reviewguard.md）
+  npx gitlab-ai-review --no-enhance
+
+  # 本地模式
+  npx gitlab-ai-review --local
+
+  # 禁用文档加载
+  npx gitlab-ai-review --no-documents
+
+  # 自定义文档路径
+  npx gitlab-ai-review --documents-path docs
 `);
       process.exit(0);
     }
@@ -71,6 +112,17 @@ async function main() {
   
   console.log('🚀 GitLab AI Review CLI 启动...\n');
 
+  // 显示当前模式
+  console.log('⚙️  运行模式:');
+  console.log(`  - GitLab API 模式: ${cliOptions.useGitLabAPI ? '✅ 开启' : '❌ 关闭 (本地模式)'}`);
+  console.log(`  - 智能补充模式: ${cliOptions.enableEnhance ? '✅ 开启' : '❌ 关闭'}`);
+  console.log(`  - MR 总结: ${cliOptions.enableSummary ? '✅ 开启' : '❌ 关闭'}`);
+  console.log(`  - 文档加载: ${cliOptions.loadDocuments ? '✅ 开启' : '❌ 关闭'}`);
+  if (cliOptions.loadDocuments) {
+    console.log(`  - 文档路径: ${cliOptions.documentsPath}`);
+  }
+  console.log();
+
   try {
     // 1. 创建 SDK 实例（自动从环境变量读取配置）
     const sdk = new GitLabAIReview();
@@ -81,24 +133,59 @@ async function main() {
     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. 🎯 初始化 Guard 配置（根据命令行参数选择模式）
+    console.log('📚 初始化 Guard 配置...');
+    await sdk.initGuardConfig({
+      useGitLabAPI: cliOptions.useGitLabAPI,
+      enableEnhance: cliOptions.enableEnhance,
+    });
+    
+    const guardStatus = sdk.config.ai?.guardConfig;
+    if (guardStatus) {
+      console.log(`  - Guard 状态: ✅ ${guardStatus.filename}`);
+      if (guardStatus.enhanced) {
+        console.log(`  - 增强状态: ✅ AI 已补充完善`);
+      } else if (guardStatus.isComplete) {
+        console.log(`  - 检查状态: ✅ 内容完整`);
+      } else if (guardStatus.generated) {
+        console.log(`  - 生成状态: ✅ AI 自动生成`);
+      }
+    } else {
+      console.log(`  - Guard 状态: ⚠️  未找到，使用默认规则`);
     }
     console.log();
 
-    // 3. 获取 MR 变更信息
+    // 3.5 📚 加载项目文档（PRD.docx 和 TD.docx）
+    if (cliOptions.loadDocuments && sdk.config.ai?.arkApiKey) {
+      try {
+        await sdk.loadProjectDocuments({
+          documentsPath: cliOptions.documentsPath,
+          enableSummary: true,  // 使用 AI 生成文档总结
+        });
+      } catch (error) {
+        console.warn(`⚠️  加载项目文档失败: ${error.message}`);
+        console.log('   将继续进行代码审查（无文档上下文）\n');
+      }
+    } else if (!cliOptions.loadDocuments) {
+      console.log('⏭️  已禁用文档加载，跳过\n');
+    }
+
+    // 4. 获取 MR 变更信息
     console.log('📥 获取 MR 变更信息...');
     const changes = await sdk.getMergeRequestChanges();
     console.log(`✅ 共发现 ${changes.length} 个文件变更\n`);
 
-    // 4. 执行 AI 代码审查
+    // 5. 执行 AI 代码审查
     if (sdk.config.ai?.arkApiKey && changes.length > 0) {
       console.log('🤖 开始 AI 代码审查...\n');
       
-      // 使用新的影响分析方法
-      const results = await sdk.reviewWithImpactAnalysis(cliOptions);
+      // 使用代码审查方法
+      const results = await sdk.reviewAndCommentOnLines({
+        maxFiles: cliOptions.maxFiles,
+        enableSummary: cliOptions.enableSummary,
+      });
       
       console.log('\n📊 审查结果汇总:');
       const successCount = results.filter(r => r.status === 'success').length;
@@ -129,4 +216,3 @@ async function main() {
 
 // 执行主函数
 main();
-