@lezzhao/ai-cr

v0.0.1-beta.1

Published

7 months ago

AI驱动的代码审查工具，支持Git hooks集成和智能代码质量分析

0High
0Medium
0Low

lezzhao

ai code-review git-hooks code-analysis typescript deepseek openai moonshot automation quality linting static-analysis

🔍 AI Code Review

AI驱动的智能代码审查工具，支持Git hooks集成，提供多维度代码质量分析和友好的Web界面展示。

✨ 功能特性

🔍 智能代码分析: 使用AI模型分析代码变更，识别潜在问题
🚀 Git Hooks集成: 支持pre-commit、commit-msg、post-commit自动化分析
🌟 多AI服务支持: 支持DeepSeek、OpenAI、Moonshot等主流AI服务
📋 详细反馈报告: 提供代码质量、安全性、性能等多维度分析
📄 多种输出格式: 支持Markdown、JSON、控制台输出
🛠️ 高度可配置: 支持自定义分析规则和反馈格式
💬 中文友好: 完整的中文界面和反馈
🌐 Web界面: 现代化的Web界面，实时查看分析结果

🚀 快速开始

安装

# 全局安装（推荐用于CLI工具）
npm install -g @lezzhao/ai-cr

# 在项目中使用
npm install @lezzhao/ai-cr

配置

复制配置示例文件：

cp examples/ai-cr.config.yaml.example ai-cr.config.yaml

编辑 ai-cr.config.yaml 文件，配置AI服务API密钥：

ai:
  provider: deepseek  # deepseek, openai, moonshot, mock
  apiKey: your_api_key_here
  baseUrl: https://api.deepseek.com/v1
  model: deepseek-coder
  temperature: 0.7
  maxTokens: 2000
  timeout: 30000

基本使用

# 分析暂存区文件
ai-cr analyze --staged

# 分析工作区文件
ai-cr analyze --working

# 分析指定提交
ai-cr analyze --commit HEAD

# 指定输出格式
ai-cr analyze --staged --format markdown --output ./reports/report.md

# 使用指定AI服务
ai-cr analyze --staged --provider openai

🔧 Git Hooks 集成

安装Git Hooks

# 安装所有Git hooks
ai-cr install-hooks

# 检查hooks状态
ai-cr hooks-status

# 卸载Git hooks
ai-cr uninstall-hooks

安装后，Git hooks将自动在以下时机运行：

pre-commit: 提交前分析暂存区文件，如有问题将阻止提交
commit-msg: 分析提交信息质量
post-commit: 提交后生成详细分析报告

🌐 Web界面

启动Web服务：

# 启动Web服务
ai-cr web

# 指定端口和主机
ai-cr web --port 3000 --host 0.0.0.0

访问 http://localhost:8000 查看Web界面。

💻 编程接口

JavaScript/TypeScript 使用

import { 
  CodeAnalyzer, 
  AIProviderFactory, 
  configManager 
} from '@lezzhao/ai-cr';

// 获取配置
const config = configManager.getConfig();

// 创建AI提供者
const aiProvider = AIProviderFactory.createProvider(
  config.ai.provider, 
  config.ai
);

// 创建代码分析器
const analyzer = new CodeAnalyzer(config);

// 分析文件
const result = await analyzer.analyzeFile('./src/example.js');
console.log(result);

📊 分析报告

支持的分析维度

🐛 Bug检测: 识别潜在的代码错误和逻辑问题
🔒 安全分析: 检测安全漏洞和风险点
⚡ 性能优化: 提供性能改进建议
🎨 代码风格: 检查代码规范和风格一致性
🔧 可维护性: 评估代码的可维护性和可读性
♿ 可访问性: 检查可访问性相关问题
✅ 最佳实践: 验证是否符合编程最佳实践

输出格式

Markdown: 适合文档和报告
JSON: 适合程序化处理
控制台: 适合命令行查看

⚙️ 配置选项

环境变量

| 变量名 | 描述 | 默认值 | |--------|------|--------| | DEFAULT_AI_PROVIDER | 默认AI服务提供商 | deepseek | | MAX_FILE_SIZE | 最大文件大小(字节) | 100000 | | MAX_FILES_PER_ANALYSIS | 单次分析最大文件数 | 50 | | ANALYSIS_TIMEOUT | 分析超时时间(秒) | 300 | | OUTPUT_FORMAT | 默认输出格式 | markdown | | OUTPUT_DIR | 输出目录 | ./reports |

配置文件

创建 ai-cr.config.yaml 文件进行高级配置：

ai:
  provider: deepseek
  model: deepseek-coder
  temperature: 0.1
  maxTokens: 4000
  timeout: 30000

analysis:
  maxFileSize: 100000
  maxFilesPerAnalysis: 50
  timeout: 300
  includePatterns:
    - "**/*.{js,ts,jsx,tsx,py,java,go,rs}"
  excludePatterns:
    - "node_modules/**"
    - "dist/**"
    - "build/**"

output:
  format: markdown
  directory: ./reports
  includeSummary: true
  includeDetails: true
  groupByFile: true

web:
  host: 127.0.0.1
  port: 8000
  debug: false
  cors: true

🛠️ 开发

项目结构

ai-cr/
├── src/
│   ├── cli.ts              # 命令行接口
│   ├── config/             # 配置管理
│   ├── core/               # 核心分析引擎
│   ├── services/           # AI服务提供商
│   ├── integrations/       # Git集成
│   ├── web/                # Web服务
│   ├── utils/              # 工具函数
│   └── types/              # 类型定义
├── tests/                  # 测试文件
├── examples/               # 使用示例
└── dist/                   # 编译输出

开发命令

# 开发模式
npm run dev

# 构建
npm run build

# 测试
npm test

# 代码检查
npm run lint

# 格式化代码
npm run format

# Web开发
npm run web:dev

🤝 贡献

欢迎贡献代码！请遵循以下步骤：

Fork 项目
创建特性分支 (git checkout -b feature/AmazingFeature)
提交更改 (git commit -m 'Add some AmazingFeature')
推送到分支 (git push origin feature/AmazingFeature)
打开 Pull Request

📝 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🙏 致谢

DeepSeek - 提供优秀的AI代码分析服务
OpenAI - 提供强大的GPT模型
Moonshot - 提供高质量的中文AI服务

📞 支持

如果你遇到问题或有建议，请：

提交 Issue
查看文档
联系维护者

⭐ 如果这个项目对你有帮助，请给它一个星标！