本地AI代码审查工具 🔍

一个轻量级、以本地为主的代码审查工具，使用AI提供快速反馈。该工具使用TypeScript编写，并由Ollama驱动，分析git差异并提供可操作的改进建议。

特性 ✨

• 🚀 本地优先：完全在您的机器上运行，无需API密钥或互联网连接
• 📝 Git集成：自动分析未提交的更改
• 🤖 AI驱动：使用deepseek-coder模型进行智能代码审查
• 🎨 丰富的输出：清晰、彩色化的终端输出，带有可操作的建议
• ⚡ 快速：快速设置和即时反馈
• 🔒 私密：您的代码永远不会离开您的机器

先决条件 📋

开始之前，请确保您拥有：

• Windows 11
• Node.js v22.0.0 或更高版本
• npm v11.0.0 或更高版本
• 已安装的 Ollama

安装 🛠️

1. 克隆仓库：

   git clone <repository-url>
   cd code-reviewer
   

2. 安装依赖项：

   npm install
   

3. 拉取所需模型：

   ollama pull deepseek-coder:latest
   

4. 验证安装：

   ollama list   # 应显示 deepseek-coder
   

使用方法 💻

1. 在项目中做一些更改

2. 运行审查工具：

   npx tsx src/index.ts /path/to/your/project
   

3. 在终端中查看建议

示例输出：

🔍 代码审查助手
─────────────────────
正在审查项目：/path/to/your/project

📋 摘要
在您的更改中发现了3个问题...

🎯 详细分析
[app.ts]
❌ 错误（第15行）
   未使用的变量'config'
   → 影响：增加代码大小并降低可维护性
   → 解决方案：移除未使用的变量或实现预期用途

...

项目结构 🏗️

src/
  ├── index.ts      # CLI入口点
  ├── reviewer.ts   # 核心审查逻辑
  ├── git.ts        # Git操作
  ├── ollama.ts     # 模型接口
  └── types.ts      # TypeScript类型定义

配置 🔧

您可以通过在项目中添加.reviewconfig文件夹来自定义审查过程：

your-project/
  ├── .reviewconfig/
  │   ├── standards.md    # 项目编码标准
  │   └── patterns.md     # 推荐模式
  └── ...

故障排除 🔍

常见问题及解决方案：

1. Ollama无响应

   • 检查系统托盘中的Ollama是否正在运行
   • 使用ollama list验证
   • 如有必要，重新启动Ollama

2. 模型问题

   • 确保已安装deepseek-coder：ollama pull deepseek-coder:latest
   • 检查可用内存（推荐最小8GB）
   • 关闭不必要的应用程序

3. Node.js版本错误

   • 更新Node.js到v22+：node -v
   • 更新npm到v11+：npm -v

局限性 🚧

尽管对于快速代码审查非常强大，但请注意：

• 与云替代方案相比，本地模型的能力有限
• 资源使用取决于您的硬件
• 复杂分析可能需要基于云的解决方案
• 模型响应的质量可能会有所不同

最佳实践 🌟

1. 使用于：

   • 对代码更改的快速反馈
   • 个人项目
   • 学习和实验

2. 考虑使用云替代方案于：

   • 团队范围的代码审查
   • 生产部署
   • 复杂分析需求

许可证 📄

MIT许可证