@ttjl/ai-code-review 1.0.0

package/src/core/ai-client.js

@@ -0,0 +1,257 @@
+const axios = require('axios');
+const retry = require('async-retry');
+
+class AIClient {
+  constructor(config) {
+    this.config = config;
+
+    // 优先使用配置文件中的 API Key，否则使用环境变量
+    const apiKey = config.ai?.apiKey || process.env.DASHSCOPE_API_KEY;
+
+    if (!apiKey) {
+      throw new Error('缺少 API Key 配置。请在配置文件中设置 ai.apiKey 或设置 DASHSCOPE_API_KEY 环境变量');
+    }
+
+    // 阿里云百炼 API 配置
+    this.apiKey = apiKey;
+    this.baseUrl = config.ai?.baseUrl || 'https://dashscope.aliyuncs.com/compatible-mode/v1';
+    this.model = config.ai.model || 'qwen-max-latest';
+    console.log('使用模型:', this.model);
+  }
+
+  /**
+   * 审查代码
+   */
+  async reviewCode(file, diff, rules) {
+    const prompt = this.buildPrompt(file, diff, rules);
+
+    try {
+      const result = await retry(
+        async (bail) => {
+          try {
+            const startTime = Date.now();
+
+            // 使用 OpenAI 兼容接口调用阿里云百炼
+            const response = await axios.post(
+              `${this.baseUrl}/chat/completions`,
+              {
+                model: this.model,
+                messages: [
+                  {
+                    role: 'user',
+                    content: prompt
+                  }
+                ],
+                temperature: this.config.ai.temperature || 0.3,
+                max_tokens: this.config.ai.maxTokens || 4096
+              },
+              {
+                headers: {
+                  'Authorization': `Bearer ${this.apiKey}`,
+                  'Content-Type': 'application/json'
+                },
+                timeout: this.config.ai.timeout || 30000
+              }
+            );
+
+            const duration = Date.now() - startTime;
+
+            // 获取响应内容
+            const content = response.data.choices?.[0]?.message?.content || '';
+
+            return {
+              ...this.parseResponse(content, file),
+              duration
+            };
+          } catch (error) {
+            // 认证错误不需要重试
+            if (error.response?.status === 401 || error.response?.status === 403) {
+              bail(
+                new Error(
+                  'API 认证失败,请检查 DASHSCOPE_API_KEY 是否正确'
+                )
+              );
+              return;
+            }
+            throw error;
+          }
+        },
+        {
+          retries: this.config.ai.retry.times,
+          minTimeout: this.config.ai.retry.delay,
+          onRetry: (error, attempt) => {
+            console.log(`  重试第 ${attempt} 次...`);
+          }
+        }
+      );
+
+      return result;
+    } catch (error) {
+      throw new Error(`AI 审查失败: ${error.message}`);
+    }
+  }
+
+  /**
+   * 构建 AI Prompt
+   */
+  buildPrompt(file, diff, rules) {
+    return `
+你是一个专业的代码审查专家。请审查以下代码变更,并根据指定的规则提供建议。
+
+文件路径: ${file.path}
+文件类型: ${file.ext}
+
+代码差异:
+\`\`\`diff
+${diff}
+\`\`\`
+
+审查规则:
+${this.formatRules(rules)}
+
+请以 JSON 格式返回审查结果,包含以下字段:
+{
+  "summary": "审查摘要,简要描述发现的问题",
+  "issues": [
+    {
+      "severity": "error|warning|info",
+      "category": "quality|security|performance|naming|best-practices",
+      "line": 行号,
+      "message": "问题描述",
+      "suggestion": "改进建议",
+      "code": "相关代码片段(可选)"
+    }
+  ],
+  "metrics": {
+    "complexity": 数字(1-10),
+    "maintainabilityIndex": 数字(0-100)
+  }
+}
+
+注意事项:
+1. 只报告真正的问题,避免误报
+2. 提供具体的改进建议
+3. 使用准确的严重级别:
+   - error: 必须修复的问题(安全漏洞、严重bug等)
+   - warning: 建议修复的问题(代码质量、性能等)
+   - info: 提示性建议(最佳实践、命名规范等)
+4. 如果代码没有问题,返回空 issues 数组
+    `.trim();
+  }
+
+  /**
+   * 格式化规则描述
+   */
+  formatRules(rules) {
+    const enabledRules = [];
+
+    if (rules.codeQuality) enabledRules.push('代码质量');
+    if (rules.security) enabledRules.push('安全问题');
+    if (rules.bestPractices) enabledRules.push('最佳实践');
+    if (rules.naming) enabledRules.push('命名规范');
+    if (rules.complexity) enabledRules.push('代码复杂度');
+    if (rules.performance) enabledRules.push('性能优化');
+
+    return enabledRules.length > 0 ? enabledRules.join(', ') : '全面审查';
+  }
+
+  /**
+   * 解析 AI 响应
+   */
+  parseResponse(text, file) {
+    try {
+      // 尝试提取 JSON 内容
+      let jsonStr = null;
+
+      // 方法1: 匹配 ```json...``` 代码块
+      const jsonCodeBlockMatch = text.match(/```json\n([\s\S]*?)\n```/);
+      if (jsonCodeBlockMatch) {
+        jsonStr = jsonCodeBlockMatch[1];
+      }
+
+      // 方法2: 匹配 ```...``` 代码块
+      if (!jsonStr) {
+        const codeBlockMatch = text.match(/```\n([\s\S]*?)\n```/);
+        if (codeBlockMatch) {
+          jsonStr = codeBlockMatch[1];
+        }
+      }
+
+      // 方法3: 匹配 JSON 对象
+      if (!jsonStr) {
+        const jsonObjectMatch = text.match(/\{[\s\S]*\}/);
+        if (jsonObjectMatch) {
+          jsonStr = jsonObjectMatch[0];
+        }
+      }
+
+      if (!jsonStr) {
+        throw new Error('无法从响应中提取 JSON');
+      }
+
+      // 清理可能的 markdown 格式
+      jsonStr = jsonStr
+        .replace(/^```json\n/, '')
+        .replace(/^```\n/, '')
+        .replace(/\n```$/, '');
+
+      const result = JSON.parse(jsonStr);
+
+      return {
+        file: file.path,
+        summary: result.summary || '代码审查完成',
+        issues: this.normalizeIssues(result.issues || []),
+        metrics: result.metrics || { complexity: 0, maintainabilityIndex: 100 },
+        rawResponse: text
+      };
+    } catch (error) {
+      // 解析失败,返回默认结构
+      return {
+        file: file.path,
+        summary: '审查完成(响应解析失败)',
+        issues: [],
+        error: error.message,
+        rawResponse: text,
+        metrics: { complexity: 0, maintainabilityIndex: 100 }
+      };
+    }
+  }
+
+  /**
+   * 标准化问题对象
+   */
+  normalizeIssues(issues) {
+    return issues.map(issue => ({
+      severity: this.normalizeSeverity(issue.severity),
+      category: this.normalizeCategory(issue.category),
+      line: issue.line || 0,
+      message: issue.message || '未描述的问题',
+      suggestion: issue.suggestion || '',
+      code: issue.code || ''
+    }));
+  }
+
+  /**
+   * 标准化严重级别
+   */
+  normalizeSeverity(severity) {
+    const validSeverities = ['error', 'warning', 'info'];
+    return validSeverities.includes(severity) ? severity : 'info';
+  }
+
+  /**
+   * 标准化问题类别
+   */
+  normalizeCategory(category) {
+    const validCategories = [
+      'quality',
+      'security',
+      'performance',
+      'naming',
+      'best-practices'
+    ];
+    return validCategories.includes(category) ? category : 'quality';
+  }
+}
+
+module.exports = AIClient;

package/src/core/config-loader.js

@@ -0,0 +1,102 @@
+const fs = require('fs').promises;
+const path = require('path');
+const defaultConfig = require('../../config/default.config.js');
+
+class ConfigLoader {
+  static async load(customConfigPath = null) {
+    let userConfig = {};
+
+    if (customConfigPath) {
+      userConfig = await this.loadConfigFile(customConfigPath);
+    } else {
+      // 尝试按优先级加载配置文件
+      const configFiles = [
+        '.ai-reviewrc.json',
+        '.ai-reviewrc.js',
+        'ai-review.config.js'
+      ];
+
+      for (const file of configFiles) {
+        try {
+          const config = await this.loadConfigFile(file);
+          if (config) {
+            userConfig = config;
+            break;
+          }
+        } catch (error) {
+          // 文件不存在,继续尝试下一个
+          continue;
+        }
+      }
+    }
+
+    return this.mergeConfig(defaultConfig, userConfig);
+  }
+
+  static async loadConfigFile(filename) {
+    const filePath = path.resolve(process.cwd(), filename);
+
+    try {
+      const content = await fs.readFile(filePath, 'utf-8');
+
+      if (filename.endsWith('.json')) {
+        return JSON.parse(content);
+      } else if (filename.endsWith('.js')) {
+        // eslint-disable-next-line no-eval
+        return eval(`(${content})`);
+      }
+
+      throw new Error(`不支持的配置文件类型: ${filename}`);
+    } catch (error) {
+      if (error.code === 'ENOENT') {
+        throw new Error(`配置文件不存在: ${filename}`);
+      }
+      throw new Error(`加载配置文件失败: ${error.message}`);
+    }
+  }
+
+  static mergeConfig(defaultConfig, userConfig) {
+    const merged = { ...defaultConfig };
+
+    for (const key in userConfig) {
+      if (typeof userConfig[key] === 'object' && !Array.isArray(userConfig[key])) {
+        merged[key] = {
+          ...merged[key],
+          ...userConfig[key]
+        };
+      } else {
+        merged[key] = userConfig[key];
+      }
+    }
+
+    return merged;
+  }
+
+  static validate(config) {
+    const errors = [];
+
+    if (!config.review || typeof config.review.enabled !== 'boolean') {
+      errors.push('review.enabled 必须是布尔值');
+    }
+
+    if (!config.review || !['block', 'warn'].includes(config.review.onFail)) {
+      errors.push('review.onFail 必须是 "block" 或 "warn"');
+    }
+
+    if (!config.ai || !config.ai.model) {
+      errors.push('ai.model 是必需的');
+    }
+
+    if (!config.files || !Array.isArray(config.files.include)) {
+      errors.push('files.include 必须是数组');
+    }
+
+    if (errors.length > 0) {
+      throw new Error(`配置验证失败:\n${errors.join('\n')}`);
+    }
+
+    return true;
+  }
+}
+
+module.exports = ConfigLoader;

package/src/core/file-collector.js

@@ -0,0 +1,115 @@
+const path = require('path');
+const fs = require('fs').promises;
+const minimatch = require('minimatch');
+const GitUtils = require('../utils/git.js');
+
+class FileCollector {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * 收集需要审查的文件
+   */
+  async collect() {
+    const files = this.config.git.stagedOnly
+      ? GitUtils.getStagedFiles()
+      : GitUtils.getChangedFiles(this.config.git.diffBase);
+
+    return this.filterFiles(files);
+  }
+
+  /**
+   * 过滤文件
+   */
+  filterFiles(files) {
+    return files
+      .map(file => ({
+        path: file,
+        ext: path.extname(file),
+        relativePath: file
+      }))
+      .filter(file => this.isIncluded(file))
+      .filter(file => !this.isExcluded(file))
+      .filter(file => this.isWithinSizeLimit(file))
+      .slice(0, this.config.review.maxFiles);
+  }
+
+  /**
+   * 检查文件是否包含在审查范围内
+   */
+  isIncluded(file) {
+    return this.config.files.include.some(pattern =>
+      minimatch(file.path, pattern)
+    );
+  }
+
+  /**
+   * 检查文件是否被排除
+   */
+  isExcluded(file) {
+    return this.config.files.exclude.some(pattern =>
+      minimatch(file.path, pattern)
+    );
+  }
+
+  /**
+   * 检查文件大小是否在限制内
+   */
+  async isWithinSizeLimit(file) {
+    try {
+      const stats = await fs.stat(file.path);
+      const sizeKB = stats.size / 1024;
+      return sizeKB <= this.config.review.maxFileSize;
+    } catch (error) {
+      // 文件不存在或无法访问
+      return false;
+    }
+  }
+
+  /**
+   * 获取文件差异
+   */
+  getDiff(file) {
+    const diff = this.config.git.stagedOnly
+      ? GitUtils.getStagedFileDiff(file.path)
+      : GitUtils.getFileDiff(file.path, this.config.git.diffBase);
+    return this.truncateDiff(diff);
+  }
+
+  /**
+   * 截断过长的差异内容
+   */
+  truncateDiff(diff) {
+    const lines = diff.split('\n');
+    if (lines.length > this.config.review.maxLineLength) {
+      return (
+        lines.slice(0, this.config.review.maxLineLength).join('\n') +
+        '\n... (内容过长,已截断)'
+      );
+    }
+    return diff;
+  }
+
+  /**
+   * 获取文件信息
+   */
+  async getFileInfo(file) {
+    try {
+      const stats = await fs.stat(file.path);
+      const diff = this.getDiff(file);
+
+      return {
+        path: file.path,
+        ext: file.ext,
+        size: stats.size,
+        diff: diff,
+        lines: diff.split('\n').length
+      };
+    } catch (error) {
+      throw new Error(`获取文件信息失败: ${file.path} - ${error.message}`);
+    }
+  }
+}
+
+module.exports = FileCollector;

package/src/core/reviewer.js

@@ -0,0 +1,163 @@
+const chalk = require('chalk');
+const AIClient = require('./ai-client');
+const FileCollector = require('./file-collector');
+const ConsoleFormatter = require('../formatters/console-formatter');
+const JSONFormatter = require('../formatters/json-formatter');
+const GitUtils = require('../utils/git');
+const ErrorHandler = require('../utils/error-handler');
+
+class CodeReviewer {
+  constructor(config) {
+    this.config = config;
+    this.aiClient = new AIClient(config);
+    this.fileCollector = new FileCollector(config);
+    this.consoleFormatter = new ConsoleFormatter(config);
+    this.jsonFormatter = new JSONFormatter(config);
+  }
+
+  /**
+   * 执行代码审查
+   */
+  async review() {
+    try {
+      // 检查是否启用审查
+      if (!this.config.review.enabled) {
+        this.consoleFormatter.formatSuccess('代码审查已禁用');
+        return { success: true, issues: [] };
+      }
+
+      // 检查是否在 Git 仓库中
+      if (!GitUtils.isGitRepo()) {
+        throw new Error('当前目录不是 Git 仓库');
+      }
+
+      this.consoleFormatter.formatProgress('🔍 开始收集文件...');
+
+      // 收集需要审查的文件
+      const files = await this.fileCollector.collect();
+
+      if (files.length === 0) {
+        this.consoleFormatter.formatSuccess('没有需要审查的文件');
+        return { success: true, issues: [] };
+      }
+
+      this.consoleFormatter.formatProgress(
+        `📁 找到 ${files.length} 个文件需要审查\n`
+      );
+
+      const results = [];
+      const allIssues = [];
+
+      // 逐个审查文件
+      for (const file of files) {
+        console.log(chalk.cyan(`正在审查: ${file.path}`));
+
+        try {
+          const fileInfo = await this.fileCollector.getFileInfo(file);
+
+          if (!fileInfo.diff || fileInfo.diff.trim().length === 0) {
+            console.log('  ⏭️  跳过: 无差异内容\n');
+            continue;
+          }
+
+          // 调用 AI 审查
+          const result = await this.aiClient.reviewCode(
+            fileInfo,
+            fileInfo.diff,
+            this.config.rules
+          );
+
+          results.push(result);
+
+          if (result.issues) {
+            allIssues.push(...result.issues);
+          }
+
+          // 格式化输出
+          this.consoleFormatter.formatFile(result);
+          console.log('');
+        } catch (error) {
+          console.error(`  ❌ 错误: ${error.message}\n`);
+          results.push({
+            file: file.path,
+            error: error.message,
+            issues: []
+          });
+        }
+      }
+
+      // 生成报告
+      await this.generateReports(results, allIssues);
+
+      // 判断是否阻止提交
+      const shouldBlock = this.shouldBlockCommit(allIssues);
+
+      return {
+        success: !shouldBlock,
+        filesReviewed: results.length,
+        issues: allIssues,
+        summary: this.generateSummary(allIssues)
+      };
+    } catch (error) {
+      const result = ErrorHandler.handle(error);
+      return {
+        success: !result.shouldExit,
+        issues: [],
+        error: error.message
+      };
+    }
+  }
+
+  /**
+   * 生成报告
+   */
+  async generateReports(results, issues) {
+    // 控制台输出
+    if (this.config.output.console.enabled) {
+      this.consoleFormatter.formatSummary(results, issues);
+    }
+
+    // JSON 报告
+    if (this.config.output.file.enabled) {
+      try {
+        await this.jsonFormatter.generate(results, issues);
+      } catch (error) {
+        console.error(chalk.red(`生成报告失败: ${error.message}`));
+      }
+    }
+  }
+
+  /**
+   * 判断是否应该阻止提交
+   */
+  shouldBlockCommit(issues) {
+    if (this.config.review.onFail !== 'block') {
+      return false;
+    }
+
+    return issues.some(issue => issue.severity === 'error');
+  }
+
+  /**
+   * 生成总结
+   */
+  generateSummary(issues) {
+    const bySeverity = {
+      error: issues.filter(i => i.severity === 'error').length,
+      warning: issues.filter(i => i.severity === 'warning').length,
+      info: issues.filter(i => i.severity === 'info').length
+    };
+
+    const byCategory = {
+      quality: issues.filter(i => i.category === 'quality').length,
+      security: issues.filter(i => i.category === 'security').length,
+      performance: issues.filter(i => i.category === 'performance').length,
+      naming: issues.filter(i => i.category === 'naming').length,
+      bestPractices: issues.filter(i => i.category === 'best-practices').length
+    };
+
+    return { bySeverity, byCategory };
+  }
+}
+
+module.exports = CodeReviewer;