gitlab-ai-review 1.0.0 → 1.0.3

package/README.md

@@ -1,6 +1,14 @@
 # GitLab AI Review SDK
 
-GitLab AI Review SDK - 测试版本
+GitLab AI Review SDK - 支持 CI/CD 自动配置和手动配置
+
+## 功能特性
+
+- ✅ 封装 GitLab API 客户端
+- ✅ CI/CD 环境自动检测配置
+- ✅ 支持手动传递配置
+- ✅ 获取项目和 MR 信息
+- ✅ 添加 MR 评论
 
 ## 安装
 
@@ -8,16 +16,163 @@ GitLab AI Review SDK - 测试版本
 npm install gitlab-ai-review
 ```
 
-## 使用
+## 使用方式
+
+### 方式 1：CI/CD 自动配置（推荐）
+
+在 GitLab CI/CD 环境中，SDK 会自动检测环境变量：
 
 ```javascript
 import GitLabAIReview from 'gitlab-ai-review';
 
+// 自动从环境变量读取配置
 const sdk = new GitLabAIReview();
-console.log(sdk.test());
+
+// 获取 MR 信息
+const mr = await sdk.getMergeRequest();
+console.log('MR 标题:', mr.title);
+
+// 添加评论
+await sdk.addComment('✅ AI 代码审查完成！');
 ```
 
-## 版本
+**自动检测的环境变量：**
+- `CI_JOB_TOKEN` 或 `GITLAB_TOKEN` - GitLab Token
+- `CI_SERVER_URL` 或 `GITLAB_URL` - GitLab 地址
+- `CI_PROJECT_PATH` 或 `PROJECT_ID` - 项目 ID
+- `CI_MERGE_REQUEST_IID` 或 `MERGE_REQUEST_IID` - MR 编号
+
+### 方式 2：手动传递配置
+
+```javascript
+import GitLabAIReview from 'gitlab-ai-review';
+
+// 手动传递配置
+const sdk = new GitLabAIReview({
+  token: 'your-gitlab-token',
+  url: 'https://gitlab.com',
+  projectId: 'group/project',
+  mergeRequestIid: 123,
+});
+
+// 获取项目信息
+const project = await sdk.getProject();
+console.log('项目名:', project.name);
+
+// 获取 MR 信息
+const mr = await sdk.getMergeRequest();
+console.log('MR 标题:', mr.title);
+
+// 添加评论
+await sdk.addComment('✅ 代码审查通过！');
+```
+
+## API 文档
+
+### 构造函数
+
+```javascript
+new GitLabAIReview(options)
+```
+
+**参数：**
+- `options.token` - GitLab Token（可选，CI/CD 中自动获取）
+- `options.url` - GitLab 地址（可选，默认 `https://gitlab.com`）
+- `options.projectId` - 项目 ID（可选，CI/CD 中自动获取）
+- `options.mergeRequestIid` - MR 编号（可选，CI/CD 中自动获取）
+
+### 方法
+
+#### `validate()`
+验证配置是否完整
+
+```javascript
+sdk.validate(); // 返回 true 或抛出错误
+```
+
+#### `getConfig()`
+获取当前配置
+
+```javascript
+const config = sdk.getConfig();
+console.log(config.gitlab.url);
+console.log(config.project.projectId);
+```
+
+#### `getProject()`
+获取项目信息
 
-1.0.0 - 初始测试版本
+```javascript
+const project = await sdk.getProject();
+console.log(project.name);
+console.log(project.description);
+```
+
+#### `getMergeRequest()`
+获取 MR 信息
+
+```javascript
+const mr = await sdk.getMergeRequest();
+console.log(mr.title);
+console.log(mr.author.name);
+```
+
+#### `getMergeRequestChanges()`
+获取 MR 的代码变更
+
+```javascript
+const changes = await sdk.getMergeRequestChanges();
+changes.forEach(change => {
+  console.log('文件:', change.new_path);
+  console.log('Diff:', change.diff);
+});
+```
+
+#### `addComment(body)`
+在 MR 上添加评论
+
+```javascript
+await sdk.addComment('✅ 代码审查通过！');
+```
+
+## 在 GitLab CI/CD 中使用
+
+`.gitlab-ci.yml` 示例：
+
+```yaml
+stages:
+  - review
+
+ai-review:
+  stage: review
+  image: node:18
+  only:
+    - merge_requests
+  script:
+    - npm install gitlab-ai-review
+    - node review.js
+```
+
+`review.js` 示例：
+
+```javascript
+import GitLabAIReview from 'gitlab-ai-review';
+
+const sdk = new GitLabAIReview();
+
+// 获取 MR 信息
+const mr = await sdk.getMergeRequest();
+console.log('正在审查 MR:', mr.title);
+
+// 获取代码变更
+const changes = await sdk.getMergeRequestChanges();
+console.log(`共有 ${changes.length} 个文件变更`);
+
+// 添加评论
+await sdk.addComment('🤖 AI 代码审查已完成！');
+```
+
+## 版本
 
+- 1.0.1 - 添加 GitLab 客户端封装和自动配置
+- 1.0.0 - 初始测试版本

package/index.js

@@ -1,12 +1,115 @@
 /**
  * GitLab AI Review SDK
- * 测试版本 - 最小化实现
+ * 支持 CI/CD 自动配置和手动配置
  */
 
+import { getConfig, validateConfig } from './lib/config.js';
+import { GitLabClient } from './lib/gitlab-client.js';
+
+/**
+ * GitLab AI Review SDK 主类
+ */
 export class GitLabAIReview {
-  constructor() {
+  constructor(options = {}) {
     this.name = 'GitLab AI Review SDK';
     this.version = '1.0.0';
+
+    // 如果传入了配置，使用手动配置；否则使用自动检测
+    if (options.token || options.gitlab) {
+      // 手动配置模式
+      this.config = {
+        gitlab: {
+          token: options.token || options.gitlab?.token,
+          url: options.url || options.gitlab?.url || 'https://gitlab.com',
+        },
+        project: {
+          projectId: options.projectId || options.project?.projectId,
+          mergeRequestIid: options.mergeRequestIid || options.project?.mergeRequestIid,
+        },
+      };
+    } else {
+      // 自动检测模式（CI/CD）
+      this.config = getConfig();
+    }
+
+    // 创建 GitLab 客户端
+    this.gitlabClient = new GitLabClient({
+      token: this.config.gitlab.token,
+      host: this.config.gitlab.url,
+    });
+  }
+
+  /**
+   * 验证配置
+   */
+  validate() {
+    return validateConfig(this.config);
+  }
+
+  /**
+   * 获取当前配置
+   */
+  getConfig() {
+    return this.config;
+  }
+
+  /**
+   * 获取项目信息
+   */
+  async getProject() {
+    if (!this.config.project.projectId) {
+      throw new Error('未配置项目 ID');
+    }
+    return this.gitlabClient.getProject(this.config.project.projectId);
+  }
+
+  /**
+   * 获取 MR 信息
+   */
+  async getMergeRequest() {
+    if (!this.config.project.projectId) {
+      throw new Error('未配置项目 ID');
+    }
+    if (!this.config.project.mergeRequestIid) {
+      throw new Error('未配置 MR IID');
+    }
+    return this.gitlabClient.getMergeRequest(
+      this.config.project.projectId,
+      this.config.project.mergeRequestIid
+    );
+  }
+
+  /**
+   * 获取 MR 的代码变更
+   */
+  async getMergeRequestChanges() {
+    if (!this.config.project.projectId) {
+      throw new Error('未配置项目 ID');
+    }
+    if (!this.config.project.mergeRequestIid) {
+      throw new Error('未配置 MR IID');
+    }
+    return this.gitlabClient.getMergeRequestChanges(
+      this.config.project.projectId,
+      this.config.project.mergeRequestIid
+    );
+  }
+
+  /**
+   * 在 MR 上添加评论
+   */
+  async addComment(body) {
+    if (!this.config.project.projectId) {
+      throw new Error('未配置项目 ID');
+    }
+    if (!this.config.project.mergeRequestIid) {
+      throw new Error('未配置 MR IID');
+    }
+    return this.gitlabClient.createMergeRequestNote(
+      this.config.project.projectId,
+      this.config.project.mergeRequestIid,
+      body
+    );
   }
 
   /**
@@ -17,6 +120,9 @@ export class GitLabAIReview {
   }
 }
 
+// 导出工具函数
+export { getConfig, validateConfig } from './lib/config.js';
+export { GitLabClient } from './lib/gitlab-client.js';
+
 // 默认导出
 export default GitLabAIReview;
-

package/lib/config.js

@@ -0,0 +1,150 @@
+/**
+ * 配置模块 - 自动检测 CI/CD 环境变量
+ * 参考 review-bot/config.js 的实现
+ */
+
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * 读取项目根目录下的 AI Review Guard 配置文件
+ */
+function readAIReviewGuardConfig() {
+  const configFiles = ['.aireviewguard', 'aireviewguard', '.aireviewguard.json', 'reviewguard.md', '.reviewguard.md'];
+  
+  for (const filename of configFiles) {
+    try {
+      const configPath = path.join(process.cwd(), filename);
+      if (fs.existsSync(configPath)) {
+        const content = fs.readFileSync(configPath, 'utf-8');
+        
+        // 如果是 Markdown 文件，返回原始内容
+        if (filename.endsWith('.md')) {
+          return {
+            type: 'markdown',
+            filename,
+            content,
+          };
+        }
+        
+        // 尝试解析 JSON，如果失败则返回纯文本
+        try {
+          return {
+            type: 'json',
+            filename,
+            ...JSON.parse(content),
+          };
+        } catch {
+          return {
+            type: 'text',
+            filename,
+            content,
+          };
+        }
+      }
+    } catch (error) {
+      // 忽略读取错误，继续尝试下一个文件
+    }
+  }
+  
+  return null;
+}
+
+/**
+ * 获取 GitLab 配置（支持自动检测 CI 环境）
+ */
+export function getGitLabConfig() {
+  // Token 优先级：GITLAB_TOKEN > CI_JOB_TOKEN
+  const token = process.env.GITLAB_TOKEN || 
+                process.env.CI_JOB_TOKEN || 
+                '';
+
+  // GitLab URL 优先级：GITLAB_URL > CI_SERVER_URL > 默认值
+  let url = process.env.GITLAB_URL;
+  if (!url && process.env.CI_SERVER_URL) {
+    url = process.env.CI_SERVER_URL;
+  } else if (!url && process.env.CI_API_V4_URL) {
+    // 从 API URL 推导（移除 /api/v4）
+    url = process.env.CI_API_V4_URL.replace(/\/api\/v4\/?$/, '');
+  } else if (!url) {
+    url = 'https://gitlab.com';
+  }
+
+  return { token, url };
+}
+
+/**
+ * 获取 AI 配置（ARK API Key）
+ */
+export function getAIConfig() {
+  // 从环境变量读取 ARK_API_KEY
+  const arkApiKey = process.env.ARK_API_KEY || '';
+  
+  // 从配置文件读取其他配置
+  const guardConfig = readAIReviewGuardConfig();
+  
+  return {
+    arkApiKey,
+    guardConfig,
+  };
+}
+
+/**
+ * 获取项目配置（支持自动检测 CI 环境）
+ */
+export function getProjectConfig() {
+  // 项目 ID：PROJECT_ID > CI_PROJECT_ID > CI_PROJECT_PATH
+  let projectId = process.env.PROJECT_ID || process.env.CI_PROJECT_ID;
+  
+  if (!projectId && process.env.CI_PROJECT_NAMESPACE && process.env.CI_PROJECT_NAME) {
+    projectId = `${process.env.CI_PROJECT_NAMESPACE}/${process.env.CI_PROJECT_NAME}`;
+  }
+  
+  if (!projectId && process.env.CI_PROJECT_PATH) {
+    projectId = process.env.CI_PROJECT_PATH;
+  }
+
+  // MR IID：MERGE_REQUEST_IID > CI_MERGE_REQUEST_IID
+  const mergeRequestIid = process.env.MERGE_REQUEST_IID || 
+                          process.env.CI_MERGE_REQUEST_IID || 
+                          '';
+
+  return { projectId, mergeRequestIid };
+}
+
+/**
+ * 获取完整配置
+ */
+export function getConfig() {
+  const gitlab = getGitLabConfig();
+  const project = getProjectConfig();
+  const ai = getAIConfig();
+
+  return {
+    gitlab,
+    project,
+    ai,
+  };
+}
+
+/**
+ * 验证配置
+ */
+export function validateConfig(config) {
+  const errors = [];
+
+  if (!config.gitlab.token) {
+    errors.push('缺少 GitLab Token');
+  }
+
+  if (!config.project.projectId) {
+    errors.push('缺少项目 ID');
+  }
+
+  if (errors.length > 0) {
+    throw new Error('配置验证失败: ' + errors.join(', '));
+  }
+
+  return true;
+}
+

package/lib/gitlab-client.js

@@ -0,0 +1,87 @@
+/**
+ * GitLab API 客户端封装
+ * 简化版，仅包含基础功能
+ */
+
+export class GitLabClient {
+  constructor(options = {}) {
+    this.token = options.token;
+    this.host = options.host || 'https://gitlab.com';
+    this.apiUrl = `${this.host}/api/v4`;
+  }
+
+  /**
+   * 发送 API 请求
+   */
+  async request(endpoint, options = {}) {
+    const url = `${this.apiUrl}${endpoint}`;
+    const headers = {
+      'PRIVATE-TOKEN': this.token,
+      'Content-Type': 'application/json',
+      ...options.headers,
+    };
+
+    const response = await fetch(url, {
+      ...options,
+      headers,
+    });
+
+    if (!response.ok) {
+      throw new Error(`GitLab API 请求失败: ${response.status} ${response.statusText}`);
+    }
+
+    return response.json();
+  }
+
+  /**
+   * 获取项目信息
+   */
+  async getProject(projectId) {
+    return this.request(`/projects/${encodeURIComponent(projectId)}`);
+  }
+
+  /**
+   * 获取 Merge Request 信息
+   */
+  async getMergeRequest(projectId, mergeRequestIid) {
+    return this.request(`/projects/${encodeURIComponent(projectId)}/merge_requests/${mergeRequestIid}`);
+  }
+
+  /**
+   * 获取 MR 的代码变更
+   */
+  async getMergeRequestChanges(projectId, mergeRequestIid) {
+    const mr = await this.request(`/projects/${encodeURIComponent(projectId)}/merge_requests/${mergeRequestIid}/changes`);
+    return mr.changes || [];
+  }
+
+  /**
+   * 在 MR 上创建评论
+   */
+  async createMergeRequestNote(projectId, mergeRequestIid, body) {
+    return this.request(
+      `/projects/${encodeURIComponent(projectId)}/merge_requests/${mergeRequestIid}/notes`,
+      {
+        method: 'POST',
+        body: JSON.stringify({ body }),
+      }
+    );
+  }
+
+  /**
+   * 在 MR 上创建讨论（行内评论）
+   */
+  async createMergeRequestDiscussion(projectId, mergeRequestIid, body, position) {
+    return this.request(
+      `/projects/${encodeURIComponent(projectId)}/merge_requests/${mergeRequestIid}/discussions`,
+      {
+        method: 'POST',
+        body: JSON.stringify({
+          body,
+          position,
+        }),
+      }
+    );
+  }
+}
+

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "gitlab-ai-review",
-  "version": "1.0.0",
-  "description": "GitLab AI Review SDK - 测试版本",
+  "version": "1.0.3",
+  "description": "GitLab AI Review SDK - 支持 CI/CD 自动配置和 ARK API",
   "main": "index.js",
   "type": "module",
+  "scripts": {
+    "test": "node test-info.js",
+    "test:info": "node test-info.js"
+  },
   "files": [
     "index.js",
+    "lib/",
+    "test-info.js",
     "README.md"
   ],
   "keywords": [
     "gitlab",
     "ai",
     "review",
-    "sdk"
+    "sdk",
+    "ci-cd"
   ],
   "author": "",
   "license": "MIT",
@@ -20,4 +27,3 @@
     "node": ">=18.0.0"
   }
 }
-

package/test-info.js

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+/**
+ * 测试脚本：输出项目 URL 和最新 MR 编号
+ * 用于验证 gitlab-ai-review SDK 在 CI/CD 中的配置
+ */
+
+import { GitLabAIReview } from './index.js';
+
+async function testInfo() {
+  try {
+    console.log('🔍 正在测试 gitlab-ai-review SDK...\n');
+
+    // 创建 SDK 实例（自动从环境变量读取配置）
+    const sdk = new GitLabAIReview();
+
+    // 获取配置信息
+    const config = sdk.getConfig();
+    
+    console.log('📋 配置信息:');
+    console.log('━'.repeat(50));
+    console.log(`GitLab URL: ${config.gitlab.url}`);
+    console.log(`项目 ID: ${config.project.projectId || '(未设置)'}`);
+    console.log(`MR IID: ${config.project.mergeRequestIid || '(未设置)'}`);
+    console.log(`Token: ${config.gitlab.token ? '✓ 已配置' : '✗ 未配置'}`);
+    console.log('━'.repeat(50));
+    console.log();
+
+    // 验证配置
+    try {
+      sdk.validate();
+      console.log('✅ 配置验证通过\n');
+    } catch (error) {
+      console.error('❌ 配置验证失败:', error.message);
+      console.log('\n💡 提示: 在 CI/CD 中，GitLab 会自动提供以下环境变量：');
+      console.log('  - CI_JOB_TOKEN (GitLab Token)');
+      console.log('  - CI_SERVER_URL (GitLab 地址)');
+      console.log('  - CI_PROJECT_PATH (项目路径)');
+      console.log('  - CI_MERGE_REQUEST_IID (MR 编号)\n');
+      process.exit(1);
+    }
+
+    // 获取项目信息
+    console.log('📦 正在获取项目信息...');
+    const project = await sdk.getProject();
+    console.log(`项目名称: ${project.name}`);
+    console.log(`项目描述: ${project.description || '(无)'}`);
+    console.log(`项目 URL: ${project.web_url}`);
+    console.log(`命名空间: ${project.namespace.full_path}`);
+    console.log(`默认分支: ${project.default_branch}`);
+    console.log();
+
+    // 获取 MR 信息
+    if (config.project.mergeRequestIid) {
+      console.log('🔀 正在获取 MR 信息...');
+      const mr = await sdk.getMergeRequest();
+      console.log(`MR 标题: ${mr.title}`);
+      console.log(`MR 编号: #${mr.iid}`);
+      console.log(`MR URL: ${mr.web_url}`);
+      console.log(`作者: ${mr.author.name} (@${mr.author.username})`);
+      console.log(`源分支: ${mr.source_branch}`);
+      console.log(`目标分支: ${mr.target_branch}`);
+      console.log(`状态: ${mr.state}`);
+      console.log(`创建时间: ${mr.created_at}`);
+      console.log();
+
+      // 获取代码变更
+      console.log('📝 正在获取代码变更...');
+      const changes = await sdk.getMergeRequestChanges();
+      console.log(`共有 ${changes.length} 个文件变更:`);
+      changes.forEach((change, index) => {
+        console.log(`  ${index + 1}. ${change.new_path}`);
+      });
+      console.log();
+    } else {
+      console.log('⚠️  未检测到 MR 环境（非 MR Pipeline）\n');
+    }
+
+    console.log('━'.repeat(50));
+    console.log('✅ 测试完成！gitlab-ai-review SDK 工作正常！');
+    console.log('━'.repeat(50));
+
+  } catch (error) {
+    console.error('\n❌ 测试失败:', error.message);
+    console.error('\n详细错误:', error);
+    process.exit(1);
+  }
+}
+
+// 运行测试
+testInfo();
+