AI Code Reviewer

一个用于GitLab/GitHub或通用代码托管平台的自动化代码审查工具，旨在提升代码质量，提供智能反馈，并通过灵活配置实现高效的审查流程。

特性

• 🤖 自动代码审查: 对合并请求和提交进行自动化审查，提供差异分析
• 🧠 智能反馈: 通过AI模型提供代码质量评估、最佳实践建议和性能优化建议
• 🔔 通知集成: 支持通过GitLab评论和企业微信进行通知
• ⚙️ 灵活配置: 支持多种AI模型和自定义审查规则，管理配置优先级

项目架构

项目采用模块化设计，支持多平台和多AI提供者，核心组件包括：

graph TD
    CLI[CLI入口] --> Config[配置管理]
    CLI --> Platform[平台服务]
    CLI --> AIProvider[AI提供者]
    CLI --> Logger[日志系统]
    CLI --> Core[代码审查核心]

    Config --> ENV[环境变量]
    Config --> File[配置文件.aireviewrc.yml]
    Config --> Args[命令行参数]

    Platform --> GitHub[GitHub]
    Platform --> GitLab[GitLab]
    Platform --> Local[本地文件]

    GitHub --> PRs[拉取请求]
    GitHub --> Comments[评论]
    GitHub --> Diffs[差异获取]

    GitLab --> MRs[合并请求]
    GitLab --> GLComments[评论]
    GitLab --> GLDiffs[差异获取]

    AIProvider --> OpenAI[OpenAI]
    AIProvider --> OpenRouter[OpenRouter]
    AIProvider --> Ollama[Ollama]

    OpenAI --> Review[代码审查]
    OpenAI --> Summary[总结生成]

    Ollama --> OllamaReview[代码审查]
    Ollama --> OllamaSummary[总结生成]

    Core --> DiffParser[差异解析]
    Core --> FileFilter[文件过滤]
    Core --> Reviewer[审查处理]

    Notification[通知系统] --> WeChat[企业微信]
    Notification --> PlatformComment[平台评论]
    Notification --> FileOutput[文件输出]

    CLI --> Notification
    CLI --> Commands[命令处理]

    Commands --> GithubPR[GitHub PR命令]
    Commands --> GitLabMR[GitLab MR命令]
    Commands --> LocalReview[本地审查命令]
    Commands --> FileReview[单文件审查]

    PromptMgr[提示词管理] --> SystemPrompt[系统提示]
    PromptMgr --> ReviewPrompt[审查提示]
    PromptMgr --> SummaryPrompt[总结提示]

    Core --> PromptMgr

Loading

主要模块

• CLI入口: 处理命令行输入和执行相应操作
• 配置管理: 处理多来源配置的加载和合并
• 平台服务: 提供与不同代码托管平台的集成
• AI提供者: 封装不同AI服务的调用逻辑
• 通知系统: 提供多渠道通知能力
• 代码审查核心: 处理代码差异分析和审查逻辑

安装

# 全局安装
npm install -g @dext7r/ai-code-reviewer

# 或使用pnpm
pnpm add -g @dext7r/ai-code-reviewer

# 或使用yarn
yarn global add @dext7r/ai-code-reviewer

配置

在项目根目录创建 .aireviewrc.yml 文件：

# AI模型配置
ai:
  provider: openai # 或 ollama
  model: gpt-4 # 或其他模型
  apiKey: your_openai_key # API密钥可直接配置在文件中
  baseUrl: https://api.openai.com/v1 # 或 https://openrouter.ai/api/v1
  temperature: 0.1
  maxTokens: 4000

# 平台配置
platform:
  type: gitlab # 或 github 或 local
  token: YOUR_TOKEN
  url: https://gitlab.com # 可选，用于自托管实例

# 通知配置
notifications:
  gitlab_comment: true
  wecom:
    enabled: false
    webhook: YOUR_WEBHOOK_URL

# 审查配置
review:
  # 忽略文件
  ignoreFiles:
    - '*.lock'
    - '*.min.js'
  # 忽略路径
  ignorePaths:
    - node_modules/
    - dist/
  # 自定义提示
  prompts:
    # 系统提示
    system: |
      你是一个专业的代码审查助手，擅长识别代码中的问题并提供改进建议。
    # 审查提示（支持占位符：{{language}}、{{filePath}}、{{diffContent}}）
    review: |
      请审查以下{{language}}代码...
    # 总结提示（支持占位符：{{filesCount}}、{{issuesCount}}、{{resultsSummary}}）
    summary: |
      请总结以下代码审查结果...

注意: 虽然可以在配置文件中设置API密钥，但出于安全考虑，建议敏感信息使用环境变量配置。

你也可以使用环境变量作为替代或补充：

# 仅设置API密钥，其他配置项从配置文件读取
export AI_REVIEWER_OPENAI_KEY=your_openai_key

# 或者仅通过环境变量进行配置
export AI_REVIEWER_PROVIDER=openai
export AI_REVIEWER_MODEL=gpt-4
export AI_REVIEWER_BASE_URL=https://api.openai.com/v1
export AI_REVIEWER_GITLAB_TOKEN=your_gitlab_token

配置优先级: CLI参数 > 环境变量 > 配置文件 > 默认配置

使用方法

CLI命令

# 审查GitLab合并请求
ai-review gitlab-mr --project-id 123 --mr-id 456

# 审查GitHub拉取请求
ai-review github-pr --owner user --repo project --pr-id 123

# 审查本地代码
ai-review local --path ./src

GitHub Actions集成

本项目支持通过GitHub Actions自动审查PR代码。将以下内容添加到你的仓库中：

1. 在仓库的Settings > Secrets and variables > Actions中设置以下secrets：

   • AI_REVIEWER_OPENAI_KEY: (必需) OpenAI/OpenRouter API密钥
   • AI_REVIEWER_MODEL: (可选) 使用的AI模型, 默认: gpt-3.5-turbo
   • AI_REVIEWER_BASE_URL: (可选) API基础URL, 默认: https://api.openai.com/v1
   • AI_REVIEWER_PROMPT_SYSTEM: (可选) 自定义系统提示词
   • AI_REVIEWER_PROMPT_REVIEW: (可选) 自定义审查提示词
   • AI_REVIEWER_PROMPT_SUMMARY: (可选) 自定义总结提示词
   • WECOM_ENABLED: (可选) 企业微信通知开关, 值: true/false
   • WECOM_WEBHOOK: (可选) 企业微信Webhook地址

2. 创建.github/workflows/review.yaml文件：

name: AI Code Review

on:
  pull_request:
    types: [opened, synchronize, reopened]
  workflow_dispatch:
    inputs:
      pr_number:
        description: Pull request number to review
        required: false
        type: string

permissions:
  contents: read
  pull-requests: write

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 'lts/*'

      - name: Setup pnpm
        uses: pnpm/action-setup@v4
        with:
          version: 10

      - name: Install dependencies
        run: pnpm install

      - name: Run AI code review
        run: |
          PR_NUMBER=${{ github.event.pull_request.number || inputs.pr_number }}
          if [ -z "$PR_NUMBER" ]; then
            echo "No pull request number provided"
            exit 1
          fi

          REPO_NAME=$(echo $GITHUB_REPOSITORY | cut -d'/' -f2)

          pnpm tsx src/cli.ts github-pr \
            --owner ${{ github.repository_owner }} \
            --repo $REPO_NAME \
            --pr-id $PR_NUMBER
        env:
          AI_REVIEWER_OPENAI_KEY: ${{ secrets.AI_REVIEWER_OPENAI_KEY }}
          AI_REVIEWER_MODEL: ${{ secrets.AI_REVIEWER_MODEL }}
          AI_REVIEWER_BASE_URL: ${{ secrets.AI_REVIEWER_BASE_URL }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这样设置后，当有PR创建或更新时会自动进行代码审查，也可以通过GitHub Actions界面手动触发审查。

许可证

MIT License