@ttjl/ai-code-review 1.0.0

package/.env.example

@@ -0,0 +1,3 @@
+# 阿里云百炼 API 配置
+# 获取 API Key: https://bailian.console.aliyun.com/
+DASHSCOPE_API_KEY=sk-48566cc7ac734ae1a1560f411ca3564d

package/Readme.md

@@ -0,0 +1,262 @@
+# AI 驱动的代码审查工具
+
+基于 Git Hooks 和阿里云百炼 qwen-max 的自动化代码审查系统,用于在代码提交前验证代码质量、规范和潜在的安全问题。
+
+## ✨ 特性
+
+- 🔍 **智能代码审查**: 使用阿里云百炼 qwen-max 进行深度代码分析
+- 🚀 **自动化集成**: 通过 Git Hooks 在提交前自动触发
+- 📝 **多文件类型支持**: 支持 JavaScript、TypeScript、Vue、CSS 等
+- ⚙️ **灵活配置**: 支持自定义审查规则和输出格式
+- 📊 **详细报告**: 生成控制台彩色输出和 JSON 格式报告
+- 🎯 **问题分类**: 代码质量、安全、性能、最佳实践等多维度审查
+
+## 核心技术栈
+
+- **Git Hooks 管理**: Lefthook
+- **运行环境**: Node.js >= 18.0.0
+- **AI SDK**: 阿里云百炼 SDK (@alicloud/ai-2024-06-01)
+- **AI 模型**: qwen-max-latest
+
+## 📦 安装
+
+### 全局安装
+
+```bash
+npm install -g @your-scope/ai-code-review
+```
+
+### 项目本地安装
+
+```bash
+npm install -D @your-scope/ai-code-review
+```
+
+## 🚀 快速开始
+
+### 1. 配置 API Key
+
+有两种方式配置阿里云百炼 API Key:
+
+#### 方式一: 在配置文件中配置(推荐)
+
+在 `.ai-reviewrc.json` 中直接配置:
+
+```json
+{
+  "ai": {
+    "apiKey": "sk-your-api-key-here",
+    "model": "qwen-max-latest"
+  }
+}
+```
+
+#### 方式二: 使用环境变量
+
+创建 `.env` 文件:
+
+```bash
+cp .env.example .env
+```
+
+编辑 `.env` 文件,添加你的阿里云百炼 API Key:
+
+```env
+DASHSCOPE_API_KEY=your_dashscope_api_key_here
+```
+
+**优先级**: 配置文件中的 API Key 优先级高于环境变量。
+
+获取 API Key: https://bailian.console.aliyun.com/
+
+### 2. 初始化配置
+
+```bash
+ai-review init
+```
+
+这将创建 `.ai-reviewrc.json` 配置文件。
+
+### 3. 检查环境
+
+```bash
+ai-review check
+```
+
+### 4. 手动触发审查
+
+```bash
+ai-review review
+```
+
+## ⚙️ 配置
+
+`.ai-reviewrc.json` 配置文件示例:
+
+```json
+{
+  "review": {
+    "enabled": true,
+    "onFail": "block",
+    "maxFiles": 20
+  },
+  "files": {
+    "include": ["**/*.js", "**/*.ts", "**/*.tsx", "**/*.vue"],
+    "exclude": ["node_modules/**", "dist/**"]
+  },
+  "ai": {
+    "apiKey": "sk-your-api-key-here",
+    "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
+    "model": "qwen-max-latest",
+    "temperature": 0.3
+  },
+  "rules": {
+    "codeQuality": true,
+    "security": true,
+    "bestPractices": true
+  }
+}
+```
+
+**配置说明**:
+- `ai.apiKey`: 阿里云百炼 API Key(可选,不配置则使用环境变量)
+- `ai.baseUrl`: API 地址(可选,默认为阿里云百炼兼容模式地址)
+- `ai.model`: 使用的模型名称(默认: qwen-max-latest)
+- `ai.temperature`: 温度参数,控制输出随机性(0-1)
+- `ai.maxTokens`: 最大 token 数
+
+## 📖 使用方法
+
+### 命令行工具
+
+```bash
+# 执行代码审查
+ai-review review
+
+# 初始化配置文件
+ai-review init
+
+# 显示当前配置
+ai-review config
+
+# 检查环境配置
+ai-review check
+```
+
+### Git Hooks 集成
+
+当你暂存文件并执行 `git commit` 时,代码审查会自动运行:
+
+```bash
+git add .
+git commit  # 自动触发 AI 代码审查
+```
+
+如果发现问题,提交将被阻止(取决于 `review.onFail` 配置)。
+
+## 📊 审查报告
+
+### 控制台输出
+
+```
+============================================================
+  代码审查总结
+============================================================
+
+  📁 审查文件: 5
+  ❌ 错误: 2
+  ⚠️  警告: 3
+  ℹ️  提示: 1
+
+============================================================
+```
+
+### JSON 报告
+
+审查报告会保存在 `reports/` 目录下:
+
+```json
+{
+  "timestamp": "2026-01-02T00:00:00.000Z",
+  "summary": {
+    "totalFiles": 5,
+    "totalIssues": 6,
+    "bySeverity": {
+      "error": 2,
+      "warning": 3,
+      "info": 1
+    }
+  },
+  "files": [...],
+  "issues": [...]
+}
+```
+
+## 🛠️ 开发
+
+### 安装依赖
+
+```bash
+npm install
+```
+
+### 运行测试
+
+```bash
+npm test
+```
+
+### 代码检查
+
+```bash
+npm run lint
+```
+
+### 格式化代码
+
+```bash
+npm run format
+```
+
+## 📝 项目结构
+
+```
+ai-code-review/
+├── src/
+│   ├── core/              # 核心逻辑
+│   │   ├── ai-client.js       # AI 客户端
+│   │   ├── config-loader.js   # 配置加载器
+│   │   ├── file-collector.js  # 文件收集器
+│   │   └── reviewer.js        # 审查器
+│   ├── formatters/        # 输出格式化
+│   │   ├── console-formatter.js
+│   │   └── json-formatter.js
+│   ├── utils/             # 工具函数
+│   │   ├── git.js
+│   │   └── error-handler.js
+│   └── cli/               # 命令行工具
+│       └── index.js
+├── bin/                    # 可执行命令
+├── config/                 # 默认配置
+├── templates/              # 配置模板
+├── lefthook.yml           # Git Hooks 配置
+└── package.json
+```
+
+## ⚠️ 注意事项
+
+### API 配额
+
+阿里云百炼 API 有调用频率限制。如果遇到配额问题,可以考虑:
+
+1. 减少单次审查的文件数量 (`maxFiles`)
+2. 增加 API 调用间隔
+3. 查看 [阿里云百炼定价页面](https://bailian.console.aliyun.com/)了解详情
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request!
+
+## 📄 许可证
+
+MIT License

package/bin/ai-review

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../src/cli/index');

package/config/default.config.js

@@ -0,0 +1,67 @@
+module.exports = {
+  review: {
+    enabled: true,
+    onFail: 'block',
+    maxFileSize: 1024,
+    maxFiles: 20,
+    maxLineLength: 500
+  },
+  files: {
+    include: [
+      '**/*.js',
+      '**/*.jsx',
+      '**/*.ts',
+      '**/*.tsx',
+      '**/*.vue',
+      '**/*.css',
+      '**/*.scss',
+      '**/*.less'
+    ],
+    exclude: [
+      'node_modules/**',
+      'dist/**',
+      'build/**',
+      '*.min.js',
+      '*.config.js',
+      'coverage/**'
+    ]
+  },
+  ai: {
+    // API Key 可以在这里配置，也可以通过 DASHSCOPE_API_KEY 环境变量设置
+    // apiKey: 'your-dashscope-api-key-here',
+    baseUrl: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
+    model: 'qwen-max-latest',
+    temperature: 0.3,
+    maxTokens: 4096,
+    timeout: 30000,
+    retry: {
+      times: 3,
+      delay: 1000
+    }
+  },
+  rules: {
+    codeQuality: true,
+    security: true,
+    bestPractices: true,
+    naming: true,
+    complexity: true,
+    performance: true
+  },
+  output: {
+    console: {
+      enabled: true,
+      format: 'pretty',
+      color: true
+    },
+    file: {
+      enabled: true,
+      path: './reports',
+      format: 'json',
+      filename: 'review-report-{timestamp}.json'
+    }
+  },
+  git: {
+    stagedOnly: true,
+    diffBase: 'HEAD'
+  }
+};

package/lefthook.yml

@@ -0,0 +1,13 @@
+pre-commit:
+  parallel: false
+  commands:
+    ai-code-review:
+      run: npx ai-review review
+      glob: "*.{js,jsx,ts,tsx,vue,css,scss,less}"
+      exclude:
+        - node_modules/**
+        - dist/**
+        - build/**
+        - "*.min.js"
+        - "*.config.js"
+      stage_fixed: true

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@ttjl/ai-code-review",
+  "version": "1.0.0",
+  "description": "AI 驱动的代码审查工具 - 基于 Git Hooks 和阿里百炼 qwen3-max 自动审查前端代码",
+  "main": "src/cli/index.js",
+  "bin": {
+    "ai-review": "./bin/ai-review"
+  },
+  "scripts": {
+    "lint": "eslint src/**/*.js",
+    "format": "prettier --write src/**/*.js",
+    "prepare": "lefthook install",
+    "review": "node src/cli/index.js review"
+  },
+  "keywords": [
+    "git",
+    "hook",
+    "code-review",
+    "ai",
+    "qwen",
+    "pre-commit",
+    "automated-review",
+    "code-quality",
+    "frontend"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "log-symbols": "^5.1.0",
+    "minimatch": "^8.0.4",
+    "async-retry": "^1.3.3",
+    "dotenv": "^16.4.5",
+    "ora": "^5.4.1"
+  },
+  "devDependencies": {
+    "lefthook": "^1.7.0",
+    "prettier": "^3.3.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "src",
+    "bin",
+    "config",
+    "templates",
+    "lefthook.yml",
+    "README.md",
+    ".env.example"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/cli/index.js

@@ -0,0 +1,193 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const path = require('path');
+const fs = require('fs').promises;
+require('dotenv').config();
+
+const ConfigLoader = require('../core/config-loader');
+const CodeReviewer = require('../core/reviewer');
+
+program
+  .name('ai-review')
+  .description('AI 驱动的代码审查工具 - 基于 Gemini 2.5')
+  .version('1.0.0');
+
+program
+  .command('review')
+  .description('执行代码审查')
+  .option('-c, --config <path>', '配置文件路径')
+  .option('-m, --mode <mode>', '运行模式 (manual|pre-commit)', 'manual')
+  .option('--fail-on-error', '有错误时退出码为 1')
+  .action(async (options) => {
+    try {
+      // 加载配置
+      const config = await ConfigLoader.load(options.config);
+      ConfigLoader.validate(config);
+
+      // 执行审查
+      const reviewer = new CodeReviewer(config);
+      const result = await reviewer.review();
+
+      // 根据结果决定退出码
+      if (options.failOnError && !result.success) {
+        process.exit(1);
+      }
+
+      if (!result.success) {
+        process.exit(1);
+      }
+
+      process.exit(0);
+    } catch (error) {
+      console.error('❌ 审查失败:', error.message);
+      if (process.env.DEBUG) {
+        console.error(error.stack);
+      }
+      process.exit(1);
+    }
+  });
+
+program
+  .command('init')
+  .description('初始化配置文件')
+  .action(async () => {
+    try {
+      const templatePath = path.join(
+        __dirname,
+        '../../templates/.ai-reviewrc.json'
+      );
+      const targetPath = path.join(process.cwd(), '.ai-reviewrc.json');
+
+      // 检查是否已存在配置文件
+      try {
+        await fs.access(targetPath);
+        console.log('⚠️  配置文件已存在: .ai-reviewrc.json');
+        console.log('💡 如需重新生成,请先删除现有配置文件');
+        return;
+      } catch {
+        // 文件不存在,继续创建
+      }
+
+      await fs.copyFile(templatePath, targetPath);
+      console.log('✅ 配置文件已创建: .ai-reviewrc.json');
+      console.log('\n💡 提示:');
+      console.log('   1. 请根据项目需求修改配置');
+      console.log('   2. 确保 .env 文件包含 GEMINI_API_KEY');
+      console.log('   3. 运行 `ai-review review` 测试配置');
+    } catch (error) {
+      console.error('❌ 创建配置文件失败:', error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('config')
+  .description('显示当前配置')
+  .option('-c, --config <path>', '配置文件路径')
+  .action(async (options) => {
+    try {
+      const config = await ConfigLoader.load(options.config);
+      console.log(JSON.stringify(config, null, 2));
+    } catch (error) {
+      console.error('❌ 加载配置失败:', error.message);
+      process.exit(1);
+    }
+  });
+
+program
+  .command('check')
+  .description('检查环境配置')
+  .action(async () => {
+    console.log('🔍 检查环境配置...\n');
+
+    const checks = [];
+
+    // 检查 Node 版本
+    const nodeVersion = process.version;
+    const minNodeVersion = '18.0.0';
+    const isNodeValid = nodeVersion >= 'v' + minNodeVersion;
+    checks.push({
+      name: 'Node.js 版本',
+      status: isNodeValid ? '✅' : '❌',
+      value: nodeVersion,
+      message: isNodeValid
+        ? `满足要求 (>= ${minNodeVersion})`
+        : `需要 >= ${minNodeVersion}`
+    });
+
+    // 检查 Git 仓库
+    const { execSync } = require('child_process');
+    let isGitRepo = false;
+    try {
+      execSync('git rev-parse --is-inside-work-tree', {
+        encoding: 'utf-8',
+        stdio: 'pipe'
+      });
+      isGitRepo = true;
+    } catch {}
+    checks.push({
+      name: 'Git 仓库',
+      status: isGitRepo ? '✅' : '⚠️ ',
+      value: isGitRepo ? '是' : '否',
+      message: isGitRepo ? '可以正常使用' : '某些功能可能不可用'
+    });
+
+    // 检查环境变量
+    const hasApiKey = !!process.env.GEMINI_API_KEY;
+    checks.push({
+      name: 'GEMINI_API_KEY',
+      status: hasApiKey ? '✅' : '❌',
+      value: hasApiKey
+        ? process.env.GEMINI_API_KEY.substring(0, 10) + '...'
+        : '未设置',
+      message: hasApiKey ? 'API Key 已配置' : '请在 .env 文件中设置'
+    });
+
+    // 检查配置文件
+    const configFiles = [
+      '.ai-reviewrc.json',
+      '.ai-reviewrc.js',
+      'ai-review.config.js'
+    ];
+    let configFile = null;
+    for (const file of configFiles) {
+      try {
+        await fs.access(path.join(process.cwd(), file));
+        configFile = file;
+        break;
+      } catch {}
+    }
+    checks.push({
+      name: '配置文件',
+      status: configFile ? '✅' : '⚠️ ',
+      value: configFile || '未找到',
+      message: configFile
+        ? '使用自定义配置'
+        : '将使用默认配置(运行 ai-review init 创建)'
+    });
+
+    // 显示检查结果
+    checks.forEach(check => {
+      console.log(`${check.status} ${check.name}`);
+      console.log(`   ${check.value}`);
+      console.log(`   ${check.message}\n`);
+    });
+
+    // 总结
+    const hasErrors = checks.some(c => c.status === '❌');
+    if (hasErrors) {
+      console.log('❌ 环境检查失败,请修复上述问题');
+      process.exit(1);
+    } else {
+      console.log('✅ 环境检查通过!');
+    }
+  });
+
+// 解析命令行参数
+program.parse(process.argv);
+
+// 如果没有参数,显示帮助
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}