smart-review 1.0.1

package/bin/install.js

@@ -0,0 +1,280 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { execSync } from 'child_process';
+import { logger } from '../lib/utils/logger.js';
+import { FILE_PERMISSIONS, BATCH_CONSTANTS } from '../lib/utils/constants.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+class Installer {
+  constructor() {
+    this.projectRoot = this.findGitRoot();
+    this.reviewDir = path.join(this.projectRoot, '.smart-review');
+    this.templatesDir = path.join(__dirname, '../templates');
+  }
+
+  findGitRoot() {
+    let currentDir = process.cwd();
+    logger.debug(`查找Git根目录，从 ${currentDir} 开始...`);
+
+    for (let i = 0; i < BATCH_CONSTANTS.MAX_DIRECTORY_SEARCH_DEPTH; i++) {
+      const gitDir = path.join(currentDir, '.git');
+      if (fs.existsSync(gitDir)) {
+        logger.success(`找到Git根目录: ${currentDir}`);
+        return currentDir;
+      }
+
+      const parentDir = path.dirname(currentDir);
+      if (parentDir === currentDir) {
+        break; // 到达根目录
+      }
+      currentDir = parentDir;
+    }
+
+    logger.info('ℹ️  未找到.git目录，使用当前目录作为项目根目录');
+    return process.cwd();
+  }
+
+  install() {
+    logger.info('🚀 开始安装智能代码审查系统...');
+
+    try {
+      this.createReviewDirectory();
+      this.copyTemplateFiles();
+      this.installGitHooks();
+      this.showNextSteps();
+
+      logger.success('\n🎉 智能代码审查系统安装完成！');
+      logger.info('💡 系统已内置默认配置和规则，无需额外配置即可使用');
+      logger.info('📝 如需自定义，请编辑 .smart-review/ 目录下的配置文件');
+      
+    } catch (error) {
+      logger.error('安装失败:', error);
+      process.exit(1);
+    }
+  }
+
+  createReviewDirectory() {
+    if (!fs.existsSync(this.reviewDir)) {
+      fs.mkdirSync(this.reviewDir, { recursive: true });
+      logger.success('创建 .smart-review 目录');
+    }
+
+    // 创建AI提示词子目录（用于AI自定义提示）
+    const aiPromptsDir = path.join(this.reviewDir, 'ai-rules');
+    if (!fs.existsSync(aiPromptsDir)) {
+      fs.mkdirSync(aiPromptsDir, { recursive: true });
+      logger.success('创建 ai-rules 子目录（AI提示词）');
+    }
+
+    // 创建本地静态规则目录
+    const localRulesDir = path.join(this.reviewDir, 'local-rules');
+    if (!fs.existsSync(localRulesDir)) {
+      fs.mkdirSync(localRulesDir, { recursive: true });
+      logger.success('创建 local-rules 子目录（静态规则）');
+    }
+  }
+
+  copyTemplateFiles() {
+    // 将模板源路径（templates 下）映射到目标路径（.smart-review 下）
+    const templatesMap = [
+      { src: 'smart-review.json', dest: 'smart-review.json', description: '主配置文件' },
+      { src: 'rules/security.js', dest: 'local-rules/security.js', description: '安全规则' },
+      { src: 'rules/performance.js', dest: 'local-rules/performance.js', description: '性能规则' },
+      { src: 'rules/best-practices.js', dest: 'local-rules/best-practices.js', description: '最佳实践规则' }
+    ];
+
+    for (const { src, dest, description } of templatesMap) {
+      const templatePath = path.join(this.templatesDir, src);
+      const targetPath = path.join(this.reviewDir, dest);
+
+      if (fs.existsSync(templatePath) && !fs.existsSync(targetPath)) {
+        // 确保目标目录存在
+        const targetDir = path.dirname(targetPath);
+        if (!fs.existsSync(targetDir)) {
+          fs.mkdirSync(targetDir, { recursive: true });
+        }
+
+        fs.copyFileSync(templatePath, targetPath);
+        logger.success(`创建 ${description}`);
+      }
+    }
+  }
+
+  installGitHooks() {
+    // 1) 检测是否存在 git 命令
+    let gitAvailable = false;
+    try {
+      execSync('git --version', { stdio: 'ignore' });
+      gitAvailable = true;
+    } catch (e) {
+      gitAvailable = false;
+    }
+
+    if (!gitAvailable) {
+      logger.error('未检测到 Git，请先安装后重试： https://git-scm.com/downloads');
+      process.exit(1);
+    }
+
+    // 2) 若项目未初始化为 Git 仓库，执行 git init
+    const gitDir = path.join(this.projectRoot, '.git');
+    // review-disable-start
+    if (!fs.existsSync(gitDir)) {
+      logger.warn('未检测到 .git 目录，正在初始化 Git 仓库...');
+      try {
+        execSync('git init', { cwd: this.projectRoot, stdio: 'ignore' });
+      } catch (e) {
+        logger.error('Git 仓库初始化失败，请手动执行 `git init` 后重试');
+        process.exit(1);
+      }
+    }
+    // review-disable-end
+
+    // 3) 确保 hooks 目录存在
+    const gitHooksDir = path.join(gitDir, 'hooks');
+    // review-disable-start
+    if (!fs.existsSync(gitHooksDir)) {
+      fs.mkdirSync(gitHooksDir, { recursive: true });
+    }
+    // review-disable-end
+
+    const preCommitHook = path.join(gitHooksDir, 'pre-commit');
+    
+    const hookContent = `#!/bin/bash
+# 智能代码审查 - pre-commit钩子（子项目兼容，基于暂存文件逐层定位）
+
+echo "🔍 启动代码审查..."
+
+# 获取暂存区文件
+STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM)
+
+if [ -z "$STAGED_FILES" ]; then
+  echo "📭 没有暂存的文件需要审查"
+  exit 0
+fi
+
+echo "📁 发现暂存文件:"
+echo "$STAGED_FILES"
+
+# 运行代码审查（定位到仓库根目录）
+REPO_ROOT=$(git rev-parse --show-toplevel)
+cd "$REPO_ROOT" || { echo "❌ 无法进入仓库根目录"; exit 1; }
+
+# 优先使用仓库根目录安装的 CLI
+ROOT_BIN="$REPO_ROOT/node_modules/.bin/smart-review"
+
+FOUND_CMD=""
+FOUND_IS_ENTRY=0
+
+if [ -f "$ROOT_BIN" ]; then
+  FOUND_CMD="$ROOT_BIN"
+else
+  # 基于暂存文件的路径，逐层向上查找其子项目的 node_modules
+  # 限制最大向上层级，避免卡住
+  MAX_ASCEND=6
+  while IFS= read -r file; do
+    [ -z "$file" ] && continue
+    dir=$(dirname "$file")
+    depth=0
+    while [ "$dir" != "." ] && [ $depth -lt $MAX_ASCEND ]; do
+      candidate_bin="$REPO_ROOT/$dir/node_modules/.bin/smart-review"
+      candidate_entry="$REPO_ROOT/$dir/node_modules/smart-review/bin/review.js"
+      if [ -f "$candidate_bin" ]; then
+        FOUND_CMD="$candidate_bin"; FOUND_IS_ENTRY=0; break 2
+      elif [ -f "$candidate_entry" ]; then
+        FOUND_CMD="$candidate_entry"; FOUND_IS_ENTRY=1; break 2
+      fi
+      dir=$(dirname "$dir")
+      depth=$((depth + 1))
+    done
+  done <<< "$STAGED_FILES"
+fi
+
+# 额外兜底：PATH 中的全局 smart-review
+if [ -z "$FOUND_CMD" ] && command -v smart-review >/dev/null 2>&1; then
+  FOUND_CMD="smart-review"; FOUND_IS_ENTRY=0
+fi
+
+if [ -z "$FOUND_CMD" ]; then
+  echo "❌ 未找到 smart-review。请在对应子项目安装：npm i -D smart-review"
+  echo "   或在仓库根安装供统一使用：npm i -D smart-review"
+  exit 1
+fi
+
+echo "⚙️  使用命令: $FOUND_CMD --staged"
+if [ $FOUND_IS_ENTRY -eq 1 ]; then
+  node "$FOUND_CMD" --staged
+else
+  "$FOUND_CMD" --staged
+fi
+
+EXIT_CODE=$?
+if [ $EXIT_CODE -ne 0 ]; then
+  echo "❌ 代码审查未通过，请修复问题后重新提交"
+  exit 1
+else
+  echo "✅ 代码审查通过，继续提交"
+  exit 0
+fi
+`;
+    fs.writeFileSync(preCommitHook, hookContent);
+    
+    // 设置执行权限
+    try {
+      fs.chmodSync(preCommitHook, FILE_PERMISSIONS.EXECUTABLE);
+      logger.success('安装 pre-commit Git钩子');
+    } catch (error) {
+      logger.warn('无法设置执行权限，但钩子文件已创建');
+    }
+    
+    // 测试钩子是否能正常执行
+    this.testHook(preCommitHook);
+  }
+
+  testHook(hookPath) {
+    logger.info('🧪 测试Git钩子...');
+    
+    // 检查文件是否存在且可执行
+    if (!fs.existsSync(hookPath)) {
+      logger.error('钩子文件不存在');
+      return;
+    }
+    
+    try {
+      const stats = fs.statSync(hookPath);
+      const isExecutable = !!(stats.mode & 0o111);
+      logger.debug(`钩子文件权限: ${stats.mode.toString(8)}, 可执行: ${isExecutable}`);
+      
+      if (!isExecutable) {
+        logger.warn('钩子文件不可执行，尝试重新设置权限...');
+        fs.chmodSync(hookPath, FILE_PERMISSIONS.EXECUTABLE);
+      }
+    } catch (error) {
+      logger.warn('无法检查钩子文件权限:', error.message);
+    }
+  }
+
+  showNextSteps() {
+    logger.info('\n📝 可选配置:');
+    logger.info('   1. 编辑 .smart-review/smart-review.json 配置AI参数和风险等级');
+    logger.info('   2. 在 .smart-review/local-rules/ 目录添加静态规则文件');
+    logger.info('   3. 在 .smart-review/ai-rules/ 目录添加AI提示词文件');
+    logger.info('   4. 设置 OPENAI_API_KEY 环境变量启用AI审查');
+    logger.info('\n⚙️  配置文件位置:');
+    logger.info(`   ${path.join(this.reviewDir, 'smart-review.json')}`);
+    logger.info(`   静态规则: ${path.join(this.reviewDir, 'local-rules/')}`);
+    logger.info(`   AI提示词: ${path.join(this.reviewDir, 'ai-rules/')}`);
+    
+    logger.info('\n🔧 测试命令:');
+    logger.info('   git add . && git commit -m "test"  # 测试提交触发审查');
+    logger.info('   npx smart-review --files test/src/test-file.js  # 手动测试审查（使用项目内CLI）');
+  }
+}
+
+// 运行安装
+const installer = new Installer();
+installer.install();

package/bin/review.js

@@ -0,0 +1,256 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import fs from 'fs';
+import { CodeReviewer } from '../lib/reviewer.js';
+import { ConfigLoader } from '../lib/config-loader.js';
+import { logger } from '../lib/utils/logger.js';
+import { BATCH_CONSTANTS } from '../lib/utils/constants.js';
+
+class ReviewCLI {
+  constructor() {
+    this.projectRoot = this.findProjectRoot();
+  }
+
+  findProjectRoot() {
+    let currentDir = process.cwd();
+    // 静默查找项目根目录，优先 .smart-review 其次 .git
+    for (let i = 0; i < BATCH_CONSTANTS.MAX_DIRECTORY_SEARCH_DEPTH; i++) {
+      if (fs.existsSync(path.join(currentDir, '.smart-review'))) {
+        return currentDir;
+      }
+      if (fs.existsSync(path.join(currentDir, '.git'))) {
+        return currentDir;
+      }
+      const parentDir = path.dirname(currentDir);
+      if (parentDir === currentDir) break;
+      currentDir = parentDir;
+    }
+    return process.cwd();
+  }
+
+  async run() {
+    const args = process.argv.slice(2);
+    
+    try {
+      logger.progress('代码审查启动中，请等待...');
+      // 加载配置
+      const configLoader = new ConfigLoader(this.projectRoot);
+      const config = await configLoader.loadConfig();
+      
+      // 调试日志开关（命令行）
+      if (args.includes('--debug')) {
+        logger.debugMode = true;
+        logger.info('通过命令行参数启用调试日志模式');
+      }
+
+      // 处理AI相关的命令行参数
+      if (args.includes('--no-ai')) {
+        config.ai = { ...config.ai, enabled: false };
+        logger.info('通过命令行参数禁用AI分析');
+      } else if (args.includes('--ai')) {
+        config.ai = { ...config.ai, enabled: true };
+        logger.info('通过命令行参数启用AI分析');
+      }
+      
+      // 处理Git Diff审查相关参数
+      if (args.includes('--diff-only')) {
+        config.ai = { ...config.ai, reviewOnlyChanges: true };
+        logger.info('通过命令行参数启用Git Diff增量审查模式');
+      }
+      
+      const rules = await configLoader.loadRules(config);
+      // 创建审查器
+      const reviewer = new CodeReviewer(config, rules);
+      
+      let result;
+      if (args.includes('--staged')) {
+        result = await reviewer.reviewStagedFiles();
+      } else if (args.includes('--files')) {
+        const filesIndex = args.indexOf('--files');
+        const fileList = args[filesIndex + 1]?.split(',').map(f => f.trim()) || [];
+        result = await reviewer.reviewSpecificFiles(fileList);
+      } else {
+        logger.info('使用方法:');
+        logger.info('  npx smart-code-reviewer --staged    # 审查暂存区文件');
+        logger.info('  npx smart-code-reviewer --staged --diff-only  # 仅审查暂存区变动内容(git diff)');
+        logger.info('  npx smart-code-reviewer --files file1,file2  # 审查指定文件');
+        process.exit(1);
+      }
+      
+      this.printResults(result);
+      process.exit(result.blockSubmission ? 1 : 0);
+      
+    } catch (error) {
+      logger.error('审查执行失败:', error);
+      process.exit(1);
+    }
+  }
+
+  printResults(result) {
+    const staticIssues = result.issues.filter(i => i.source === 'static');
+    const aiIssues = result.issues.filter(i => i.source === 'ai');
+    // 本地规则审查结果
+    logger.info('\n本地规则审查结果');
+    const staticByFile = this.groupIssuesByFile(staticIssues);
+      if (staticIssues.length === 0) {
+        logger.info('无');
+      } else {
+        Object.entries(staticByFile).forEach(([file, issues]) => {
+          logger.info(`\n文件: ${file}`);
+          // 根据行号排序，保证位置从上到下
+          const getLineKey = (i) => {
+            const s = Number(i.lineStart);
+            const single = Number(i.line);
+            const e = Number(i.lineEnd);
+            if (Number.isFinite(s) && s > 0) return s;
+            if (Number.isFinite(single) && single > 0) return single;
+            if (Number.isFinite(e) && e > 0) return e;
+            return Number.POSITIVE_INFINITY;
+          };
+          const sorted = [...issues].sort((a, b) => getLineKey(a) - getLineKey(b));
+          sorted.forEach((issue, index) => {
+            logger.info(`\n问题${index + 1}:`);
+            const locationLabel = this.formatLocationLabel(issue);
+            if (locationLabel) logger.info(locationLabel);
+            // 美化代码片段输出：去除行号前缀并统一缩进
+            if (issue.snippet && issue.snippet.trim().length > 0) {
+              logger.info('代码片段：');
+              logger.info(this.formatSnippet(issue.snippet));
+            } else {
+              logger.info('代码片段：(全局性问题)');
+            }
+            logger.info(`风险等级：${this.getRiskLevelText(issue.risk)}`);
+            logger.info(`风险原因：${issue.message}`);
+            if (issue.suggestion) logger.info(`修改建议：${issue.suggestion}`);
+          });
+        });
+      }
+
+    // AI代码分析结果（若有）
+    if (result.aiRan) {
+      logger.info('\nAI代码分析结果');
+      // 说明：行号可能不连续是预处理所致（剥离注释/无需审查片段），请忽略行号跳跃
+      logger.info('提示：片段行号为源文件绝对行号，因清洗注释/无需审查片段可能出现跳跃，请忽略行号不连续。');
+      // 去重：按 file+line+message 进行去重，避免重复输出
+      // 打印时不再对 AI 结果做粗略去重（聚合逻辑已在 reviewer.generateResult 中完成），仅分文件展示
+      const aiByFile = this.groupIssuesByFile(aiIssues);
+      if (aiIssues.length === 0) {
+        logger.info('无');
+      } else {
+        Object.entries(aiByFile).forEach(([file, issues]) => {
+          logger.info(`\n文件: ${file}`);
+          // 根据行号排序：起始行号优先，其次单行号；无行号的排后
+          const getLineKey = (i) => {
+            const s = Number(i.lineStart);
+            const single = Number(i.line);
+            const e = Number(i.lineEnd);
+            if (Number.isFinite(s) && s > 0) return s;
+            if (Number.isFinite(single) && single > 0) return single;
+            if (Number.isFinite(e) && e > 0) return e;
+            return Number.POSITIVE_INFINITY;
+          };
+          const sorted = [...issues].sort((a, b) => getLineKey(a) - getLineKey(b));
+          sorted.forEach((issue, index) => {
+            logger.info(`\n问题${index + 1}:`);
+            const locationLabel = this.formatLocationLabel(issue);
+            if (locationLabel) logger.info(locationLabel);
+            // 美化代码片段输出：去除行号前缀并统一缩进
+            if (issue.snippet && issue.snippet.trim().length > 0) {
+              logger.info('代码片段：');
+              logger.info(this.formatSnippet(issue.snippet));
+            } else {
+              logger.info('代码片段：(全局性问题)');
+            }
+            logger.info(`风险等级：${this.getRiskLevelText(issue.risk)}`);
+            logger.info(`风险原因：${issue.message}`);
+            if (issue.suggestion) logger.info(`修改建议：${issue.suggestion}`);
+          });
+        });
+      }
+    }
+  }
+
+  groupIssuesByFile(issues) {
+    return issues.reduce((groups, issue) => {
+      // 确保 issue.file 存在且为字符串
+      if (!issue.file || typeof issue.file !== 'string') {
+        logger.warn('发现无效的问题对象，缺少有效的文件路径:', issue);
+        return groups;
+      }
+      
+      const relativePath = path.relative(this.projectRoot, issue.file);
+      if (!groups[relativePath]) {
+        groups[relativePath] = [];
+      }
+      groups[relativePath].push(issue);
+      return groups;
+    }, {});
+  }
+
+  getRiskLevelText(risk) {
+    const levels = {
+      'critical': '致命',
+      'high': '高危', 
+      'medium': '中危',
+      'low': '低危',
+      'suggestion': '建议'
+    };
+    return levels[risk] || risk;
+  }
+
+  // 位置标签：范围为“行号范围：start-end”，单行为“行号：n”
+  formatLocationLabel(issue) {
+    const start = Number(issue.lineStart);
+    const end = Number(issue.lineEnd);
+    const single = Number(issue.line);
+    if (Number.isFinite(start) && Number.isFinite(end) && start > 0 && end >= start) {
+      if (start === end) return `行号：${start}`;
+      return `行号范围：${start}-${end}`;
+    }
+    if (Number.isFinite(single) && single > 0) {
+      return `行号：${single}`;
+    }
+    return '';
+  }
+
+  // 美化代码片段：
+  // - 去除开头的 [n] 行号标记
+  // - 去除片段前后的空行并合并连续空行
+  // - 按第一行的缩进等比例裁剪，保持代码梯度
+  // - 统一前置两空格缩进以便阅读
+  formatSnippet(snippet) {
+    if (!snippet || typeof snippet !== 'string') return '';
+    const lines = snippet.split('\n').map(line => line.replace(/^\s*[+ ]?\[(\d+)\]\s?/, ''));
+    // 去除片段前后的空行
+    while (lines.length > 0 && lines[0].trim() === '') lines.shift();
+    while (lines.length > 0 && lines[lines.length - 1].trim() === '') lines.pop();
+    // 合并连续空行
+    const compact = [];
+    let prevBlank = false;
+    for (const line of lines) {
+      const isBlank = line.trim() === '';
+      if (isBlank) {
+        if (!prevBlank) compact.push('');
+        prevBlank = true;
+      } else {
+        compact.push(line);
+        prevBlank = false;
+      }
+    }
+    // 以第一行非空的缩进作为基准，等比例裁剪
+    const firstNonEmpty = compact.find(l => l.trim() !== '') || '';
+    const baseIndent = (firstNonEmpty.match(/^[\t ]*/)?.[0]?.length) || 0;
+    const normalized = compact.map(l => {
+      const thisIndent = (l.match(/^[\t ]*/)?.[0]?.length) || 0;
+      const removeLen = Math.min(baseIndent, thisIndent);
+      return l.slice(removeLen);
+    });
+    // 统一两空格缩进
+    return normalized.map(l => `  ${l}`).join('\n');
+  }
+}
+
+// 运行审查
+const cli = new ReviewCLI();
+cli.run().catch(error => logger.error('CLI运行失败:', error));

package/index.js

@@ -0,0 +1,5 @@
+export { CodeReviewer } from './lib/reviewer.js';
+export { AIClient } from './lib/ai-client.js';
+export { ConfigLoader } from './lib/config-loader.js';
+export { defaultConfig, defaultRules } from './lib/default-config.js';
+// https://ci.das-security.cn/repository/ah_npm