code-gate 0.1.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 鸡斯拉
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,118 +1,226 @@
-# code-gate
-
-AI 助力的提交时代码 Review 工具，支持本地 Ollama 或 DeepSeek API，审查 `git commit` 的 `staged diff`，并以 GitHub Diff 风格在本地页面展示结果。
-
-## 安装
-- `npm i -D code-gate`
-
-## 初始化与集成
-- 推荐使用 `init` 命令，选择初始化方式并自动生成配置文件：
-  - 原生 Git Hooks：`npx code-gate init -m git`
-  - Husky：`npx code-gate init -m husky`
-  - simple-git-hooks：`npx code-gate init -m simple`
-  - 跳过配置文件生成：`npx code-gate init --no-config`
-- 仍支持旧方式：
-  - 原生 Git Hooks 快速安装：`npx code-gate setup`
-  - 该命令会创建 `.githooks/pre-commit` 并设置 `core.hooksPath`
-
-## 手动初始化（不覆盖现有钩子）
-- Husky：
-  - 编辑 `.husky/pre-commit`，在原有内容后追加一行：
-    - `npx code-gate hook`
-  - 确认 `git config core.hooksPath` 输出 `.husky`
-- 原生 Git Hooks：
-  - 在项目根创建 `.githooks/pre-commit`，内容示例：
-    - `#!/usr/bin/env sh`
-    - `npx code-gate hook`
-  - 设置 `core.hooksPath`：
-    - `git config core.hooksPath .githooks`
-- 配置文件生成：
-  - 在项目根新建 `code-gate.config.json`（可从下文示例复制并按需调整）
-  - 如使用 DeepSeek，请在环境变量设置 `DEEPSEEK_API_KEY`
-
-## 命令
-- `npx code-gate init` 交互式初始化（可选择 git/husky/simple，并生成配置文件）
-- `npx code-gate setup` 快速安装原生 Git Hook
-- `npx code-gate hook` 在 Hook 中执行交互式 Review
-
-## 本地开发（link 调试）
-- 在 `code-gate` 仓库：
-  - `npm install`
-  - `npm run build:watch`
-  - `npm link`
-- 在目标项目：
-  - `npm link code-gate`
-  - `npx code-gate init -m git`（或 `husky`/`simple`）
-  - `git add` + `git commit` 时触发审查流程
-
-## 配置文件
-- 推荐使用 `.codegate.js`（支持注释与更灵活的写法），兼容旧的 `code-gate.config.json/.yaml`、`.code-gaterc.{json,yaml}`。
-- 示例（`.codegate.js`）：
-```js
-// provider: 选择使用的 AI 审查引擎，可选值: 'ollama' | 'deepseek'
-// review: 审查相关设置
-//   - enabled: 是否启用审查
-//   - provider: 覆盖顶层 provider，支持按需切换，可选值: 'ollama' | 'deepseek'
-//   - mode: 审查展示模式，可选值: 'aggregate'（整合输出）| 'per_file'（按文件 Tab 展示）
-// ollama: 本地 Ollama 设置
-//   - baseURL: Ollama 服务地址，默认 'http://localhost:11434'
-//   - model: 模型名称，例如 'qwen3:8b'、'deepseek-r1:14b'
-// deepseek: DeepSeek 云端设置
-//   - baseURL: API 地址，默认 'https://api.deepseek.com'
-//   - apiKeyEnv: 存放密钥的环境变量名，默认 'DEEPSEEK_API_KEY'
-//   - model: 模型名称，默认 'deepseek-chat'
-// fileTypes: 需要审查的文件类型扩展名列表
-// scope: 审查范围，可选值: 'staged' | 'allChanged' | { include?: string[], exclude?: string[] }
-// ui: 页面与交互设置
-//   - openBrowser: 是否自动打开浏览器
-//   - theme: 主题，目前仅 'github'
-//   - port: 预览服务端口
-// limits: 限制项
-//   - maxDiffLines: 最大 diff 行数
-//   - maxFiles: 最大审查文件数
-// rules: 审查关注点，可选值: 'security' | 'performance' | 'style' | 'tests'
-// prompt: 通用提示词
-// output: 输出目录配置
-//   - dir: 本地输出目录
+<div align="center">
+  <img src="assets/logo.png" alt="Code Gate Logo" width="120" />
+</div>
+
+[English](./README.md) | [简体中文](./README_ZH.md)
+
+# Code Gate
+
+**Your Lightweight Local AI Code Review Assistant**
+
+Code Gate is an intelligent code review tool seamlessly integrated into your Git workflow. When you run `git commit`, it automatically analyzes staged code changes, utilizing local LLMs (Ollama) or cloud AI services to provide instant feedback on code quality, security suggestions, and optimization plans.
+
+## ✨ Features
+
+- **🔒 Privacy First**: Native support for Ollama local models. 
+- **☁️ Multi-Model Support**: Seamlessly integrates with DeepSeek, OpenAI, Anthropic, Aliyun Qwen, Doubao, and more.
+- **🌍 Multi-Language**: Built-in support for English, Chinese (Simplified & Traditional), Japanese, Korean, German, and French.
+- **⚡️ High Performance**: Intelligent concurrent processing for faster reviews across multiple files.
+- **🛠️ Highly Customizable**: Custom prompts, file filtering rules, and review strategies.
+- **📊 Visual Reports**: Generates intuitive HTML review reports with clear diffs and AI suggestions.
+
+## 🚀 Quick Start
+
+### 1. Installation
+
+Install `code-gate` as a development dependency:
+
+```bash
+npm i -D code-gate
+```
+
+### 2. Initialization
+
+We provide a one-click initialization command to configure Git Hooks.
+
+**Automatic Init (Recommended)**
+
+```bash
+# Interactive selection for Git Hooks or Husky
+npx code-gate init
+```
+
+You can also specify arguments if you prefer a specific hook manager:
+
+- **Native Git Hooks**: `npx code-gate init -m git`
+- **Husky**: `npx code-gate init -m husky`
+
+> After initialization, you can choose to add the generated config file to `.gitignore`.
+
+### 3. Usage
+
+Just commit your code as usual:
+
+```bash
+git add .
+git commit -m "feat: new feature"
+```
+
+Code Gate intercepts the commit:
+1. Analyzes code changes.
+<div align="left" style="margin-left: 20px">
+   <img src="assets/step1.png" width="300" />
+</div>
+
+2. Starts a local server and generates a review report.
+
+3. Automatically opens the report in your browser.
+<div align="left">
+   <img src="assets/step2.png" width="600" />
+</div>
+
+4. You choose to **Confirm Commit** or **Cancel** in the terminal.
+<div align="left" style="margin-left: 20px">
+   <img src="assets/step3.png" width="300" />
+</div>
+
+---
+
+## ⚙️ Configuration
+
+The `code-gate.config.js` in your project root controls all behaviors.
+
+### Basic Configuration
+
+```javascript
+export default {
+  provider: 'ollama',
+  providerOptions: {
+    ollama: {
+      baseURL: 'http://localhost:11434',
+      model: 'qwen2.5-coder',
+      concurrencyFiles: 1
+    },
+    deepseek: {
+      baseURL: 'https://api.deepseek.com',
+      apiKeyEnv: 'DEEPSEEK_API_KEY',
+      model: 'deepseek-chat',
+      concurrencyFiles: 4
+    }
+    // openai: { baseURL: 'https://api.openai.com/v1', apiKeyEnv: 'OPENAI_API_KEY', model: 'gpt-4o-mini' },
+    // anthropic: { baseURL: 'https://api.anthropic.com', apiKeyEnv: 'ANTHROPIC_API_KEY', model: 'claude-3-5-sonnet' },
+    // azureOpenAI: { endpoint: 'https://your-endpoint.openai.azure.com', apiKeyEnv: 'AZURE_OPENAI_KEY', deployment: 'gpt-4o-mini', apiVersion: '2024-08-01-preview' },
+    // aliyun: { baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', apiKeyEnv: 'DASHSCOPE_API_KEY', model: 'qwen-plus' },
+    // volcengine: { baseURL: 'https://ark.cn-beijing.volces.com/api/v3', apiKeyEnv: 'VOLCENGINE_API_KEY', model: 'doubao-pro-32k' },
+    // zhipu: { baseURL: 'https://open.bigmodel.cn/api/paas/v4', apiKeyEnv: 'ZHIPU_API_KEY', model: 'glm-4' }
+  },
+  language: 'en',
+  fileTypes: ['ts', 'tsx', 'css'],
+  ui: {
+    openBrowser: true,
+    port: 5175
+  },
+  limits: {
+    maxDiffLines: 10000,
+    maxFiles: 100
+  },
+  prompt: 'as a senior code reviewer, please review the code changes and provide feedback on security, performance, code style, and test coverage. Highlight any issues or areas for improvement, and offer concrete suggestions with code examples if possible.',
+  output: {
+    dir: '.review-logs'
+  },
+}
+```
+
+### API Key Configuration
+
+Choose the appropriate configuration scheme based on your project needs. Taking deepseek as an example.
+For security, avoid hardcoding API Keys in the config file.
+
+**Option A: Config File**
+
+Set in `.code-gate.js`:
+
+```javascript
 export default {
-  provider: 'deepseek',
-  review: { enabled: true, mode: 'aggregate' },
-  deepseek: { baseURL: 'https://api.deepseek.com', apiKeyEnv: 'DEEPSEEK_API_KEY', model: 'deepseek-chat' },
-  ollama: { baseURL: 'http://localhost:11434', model: 'qwen3:8b' },
-  fileTypes: ['ts', 'tsx', 'js', 'jsx', 'json', 'md', 'py', 'go', 'rs'],
-  scope: 'staged',
-  ui: { openBrowser: true, theme: 'github', port: 5175 },
-  limits: { maxDiffLines: 10000, maxFiles: 100 },
-  rules: { focus: ['security', 'performance', 'style', 'tests'] },
-  prompt: '作为资深代码审查工程师，从安全、性能、代码风格与测试覆盖角度审查本次变更，指出问题与改进建议，并给出必要的示例补丁。',
-  output: { dir: '.code-gate' }
+  providerOptions: {
+    deepseek: {
+      // ...other config
+      apiKey: 'your-deepseek-api-key'
+    }
+  }
 }
 ```
 
-## 使用流程
-- 运行 `git commit` 时会询问是否进行 Review：
-  - 选择否：正常提交。
-  - 选择是：抓取 `staged diff` 调用 AI 审查，生成本地页面并打印预览 URL，再询问是否继续提交。
-  - 非交互环境会自动跳过。
-  - 如需在非交互环境强制执行，可在 `.husky/pre-commit` 中使用：`npx code-gate hook -f`
-  - 页面顶部会显示 AI 状态（是否参与、Provider、Model、错误信息）
-  - 支持按文件 Tab 展示：在配置中设置 `"review": { "mode": "per_file" }`，每个文件一个 Tab，Tabs 超出视野时横向滚动，每个文件顶部展示该文件的审查内容
-
-## 故障排查
-- 页面只有 diff、没有 AI 审查内容：
-  - DeepSeek：确保设置了环境变量 `DEEPSEEK_API_KEY`，并且 `provider` 为 `deepseek`；可在 shell 中 `export DEEPSEEK_API_KEY="your_key"`
-  - Ollama：确保本地 Ollama 正在运行（默认 `http://localhost:11434`），并且模型已安装；例如 `ollama list` 查看，`ollama pull qwen2.5-coder`
-  - 可在 `code-gate.config.json` 中切换 `provider`，调整 `prompt` 与 `ui.port`
-  - 出错时页面顶部会显示原因与解决建议
-
-## DeepSeek 集成
-- 使用 OpenAI 兼容接口 `https://api.deepseek.com`，需在环境变量设置密钥：`DEEPSEEK_API_KEY`。
-  - 参考文档：https://api-docs.deepseek.com/
-
-## Ollama 集成
-- 通过本地 HTTP 接口调用，不内置安装；需用户自行安装与启动 Ollama。
-  - 默认地址：`http://localhost:11434`
-
-## 注意
-- 不会将密钥写入仓库；配置建议走环境变量。
-- 大 Diff 会消耗模型 token，可通过 `limits` 控制。
+**Option B: Git Hook Injection**
+
+Export temporarily in `.githooks/pre-commit` or `.husky/pre-commit`:
+
+```bash
+#!/bin/sh
+export DEEPSEEK_API_KEY=[your-deepseek-api-key]
+./node_modules/.bin/code-gate-hook
+```
+
+**Option C: Environment Variables (Recommended)**
+
+Set in your `.env` file or system environment:
+
+```bash
+export DEEPSEEK_API_KEY=[your-deepseek-api-key]
+```
+
+## 📖 Configuration Details
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `provider` | `string` | `'ollama'` | AI Provider. Supports `ollama`, `deepseek`, `openai`, `anthropic`, `aliyun`, `volcengine`, `zhipu`, etc. |
+| `providerOptions` | `object` | `{}` | Specific configurations for each Provider (see table below) |
+| `fileTypes` | `string[]` | `[]` | List of file extensions to review (whitelist). Reviews all files if empty or undefined. |
+| `exclude` | `string[]` | `['**/package-lock.json', '**/yarn.lock', '**/pnpm-lock.yaml']` | List of files or directories to ignore (blacklist), supports glob patterns (e.g., `node_modules/**`). Higher priority than `fileTypes`. |
+| `ui.openBrowser` | `boolean` | `true` | Auto-open browser for report preview |
+| `ui.port` | `number` | `5175` | Preview server port |
+| `limits.maxDiffLines` | `number` | `10000` | Max diff lines per review. Exceeding may cause incomplete review or excessive token usage. |
+| `limits.maxFiles` | `number` | `100` | Max number of files to review |
+| `reviewMode` | `string` | `'files'` | Review Mode: `'summary'` (summary only), `'files'` (file details only), `'both'` (both) |
+| `language` | `string` | `'en'` | UI & Prompt Language. Options: `'en'`, `'zh-CN'`, `'zh-TW'`, `'ja'`, `'ko'`, `'de'`, `'fr'` |
+| `prompt` | `string` | `...` | Universal system prompt sent to AI |
+| `output.dir` | `string` | `'.review-logs'` | Output directory for local reports and static assets |
+
+### providerOptions Configuration
+
+Each Provider supports the following fields, with `request` option for timeout and retry control.
+
+**Key Parameters:**
+- `baseURL`: API base URL (e.g., `https://api.deepseek.com` or `http://localhost:11434`)
+- `apiKey`: API Key (specified directly in config, not recommended for committing)
+- `apiKeyEnv`: Environment variable name storing the API Key (Recommended, e.g., `DEEPSEEK_API_KEY`)
+- `model`: Model name to use (e.g., `deepseek-chat`, `qwen2.5-coder`)
+- `concurrencyFiles`: Number of concurrent file reviews (Recommended: Cloud API 4-8, Local Model 1)
+- `request`: Advanced request configuration (see "Advanced Configuration" below)
+
+| Provider | Configurable Parameters |
+| :--- | :--- |
+| **deepseek** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `concurrencyFiles`, `request` |
+| **ollama** | `baseURL`, `model`, `concurrencyFiles`, `request` |
+| **openai** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **anthropic** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **aliyun** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **volcengine** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **zhipu** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **azureOpenAI** | `endpoint`, `apiKey`, `apiKeyEnv`, `deployment`, `apiVersion`, `request` |
+
+#### Advanced Configuration (request)
+
+Configure in `providerOptions.<provider>.request` to control request behavior:
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `timeout` | `number` | `undefined` | Request timeout (ms). Recommended to set higher for Ollama (e.g., 15000+) |
+| `retries` | `number` | `0` | Number of retries on request failure |
+| `backoffMs` | `number` | `300` | Retry interval (ms) |
+
+> **Note**: `concurrencyFiles` controls the number of concurrent file reviews (Default: DeepSeek=4, Ollama=1, Others=4).
+
+## ❓ FAQ
+
+**Q: Report shows diffs but no AI suggestions?**
+- Check `provider` configuration.
+- If using Ollama, ensure local service is running (`ollama serve`) and model is pulled (`ollama pull qwen2.5-coder`).
+- If using Cloud API, check API Key validity and network connection.
+
+**Q: How to skip review in CI/CD?**
+Code Gate detects non-interactive environments and skips automatically. To force skip, use `git commit --no-verify`.
+
+## 📄 License
+
+MIT

package/README_ZH.md

@@ -0,0 +1,224 @@
+<div align="center">
+  <img src="assets/logo.png" alt="Code Gate Logo" width="120" />
+</div>
+
+[English](./README.md) | [简体中文](./README_ZH.md)
+
+# Code Gate
+
+**您的轻量级本地 AI 代码审查助手**
+
+Code Gate 是一款无缝集成到 Git 工作流中的智能代码审查工具。在您执行 `git commit` 时，它会自动分析暂存区（Staged）的代码变更，利用本地 LLM (Ollama) 或云端 AI 服务为您提供即时的代码质量反馈、安全建议和优化方案。
+
+## ✨ 核心特性
+
+- **🔒 数据隐私优先**：原生支持 Ollama 本地模型。
+- **☁️ 多模型支持**：无缝对接 DeepSeek, OpenAI, Anthropic, 阿里云 Qwen, 豆包等主流 AI 服务。
+- **🌍 多语言界面**：内置中（简/繁）、英、日、韩、德、法等多语言支持。
+- **⚡️ 高效并发**：智能并发处理多文件审查，提升 Review 速度。
+- **🛠️ 高度可定制**：支持自定义 Prompt、文件过滤规则及审查策略。
+- **📊 可视化报告**：生成直观的 HTML 审查报告，提供清晰的 Diff 对比与 AI 建议。
+
+## 🚀 快速开始
+
+### 1. 安装
+
+在项目中安装 `code-gate` 作为开发依赖：
+
+```bash
+npm i -D code-gate
+```
+
+### 2. 初始化
+
+提供一键初始化命令，自动配置 Git Hooks。
+
+**自动初始化（推荐）**
+
+```bash
+# 交互式选择 Git Hooks 或 Husky
+npx code-gate init
+```
+
+如果您已明确使用某种 Hook 管理方式，可以指定对应参数：
+
+- **原生 Git Hooks**: `npx code-gate init -m git`
+- **Husky**: `npx code-gate init -m husky`
+
+> 初始化完成后，您可选择将生成的配置文件添加到 `.gitignore` 中。
+
+### 3. 开始使用
+
+只需像往常一样提交代码：
+
+```bash
+git add .
+git commit -m "feat: new feature"
+```
+
+Code Gate 会自动拦截提交：
+1. 分析代码变更。
+<div align="left" style="margin-left: 20px">
+  <img src="assets/step1_cn.png" width="300" />
+</div>
+
+2. 启动本地服务并生成审查报告。
+
+3. 自动打开浏览器展示报告。
+<div align="left">
+  <img src="assets/step2_cn.png" width="600" />
+</div>
+
+4. 您可以在终端选择 **继续提交** 或 **取消修改**。
+<div align="left" style="margin-left: 20px">
+  <img src="assets/step3_cn.png" width="300" />
+</div>
+
+---
+
+## ⚙️ 配置指南
+
+在项目根目录下 `.code-gate.js` 配置
+
+### 基础配置示例
+
+```javascript
+export default {
+  provider: 'ollama',
+  providerOptions: {
+    ollama: {
+      baseURL: 'http://localhost:11434',
+      model: 'qwen2.5-coder',
+      concurrencyFiles: 1
+    },
+    deepseek: {
+      baseURL: 'https://api.deepseek.com',
+      apiKeyEnv: 'DEEPSEEK_API_KEY',
+      model: 'deepseek-chat',
+      concurrencyFiles: 4
+    }
+    // openai: { baseURL: 'https://api.openai.com/v1', apiKeyEnv: 'OPENAI_API_KEY', model: 'gpt-4o-mini' },
+    // anthropic: { baseURL: 'https://api.anthropic.com', apiKeyEnv: 'ANTHROPIC_API_KEY', model: 'claude-3-5-sonnet' },
+    // azureOpenAI: { endpoint: 'https://your-endpoint.openai.azure.com', apiKeyEnv: 'AZURE_OPENAI_KEY', deployment: 'gpt-4o-mini', apiVersion: '2024-08-01-preview' },
+    // aliyun: { baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', apiKeyEnv: 'DASHSCOPE_API_KEY', model: 'qwen-plus' },
+    // volcengine: { baseURL: 'https://ark.cn-beijing.volces.com/api/v3', apiKeyEnv: 'VOLCENGINE_API_KEY', model: 'doubao-pro-32k' },
+    // zhipu: { baseURL: 'https://open.bigmodel.cn/api/paas/v4', apiKeyEnv: 'ZHIPU_API_KEY', model: 'glm-4' }
+  },
+  language: 'zh-CN',
+  fileTypes: ['ts', 'tsx', 'css'],
+  ui: {
+    openBrowser: true,
+    port: 5175
+  },
+  limits: {
+    maxDiffLines: 10000,
+    maxFiles: 100
+  },
+  prompt: '作为资深代码审查工程师，从安全、性能、代码风格与测试覆盖角度审查本次变更，指出问题与改进建议，并给出必要的示例补丁。',
+  output: {
+    dir: '.review-logs'
+  }
+}
+```
+
+### API Key 配置方案
+
+根据自己项目需要，选择合适的配置方案。这里以deepseek为例。
+为了安全起见，建议不要将 API Key 暴露到公共仓库中。
+
+**方案 A：配置文件中**
+
+在 `.code-gate.js` 中设置：
+
+```javascript
+export default {
+  providerOptions: {
+    deepseek: {
+      // ...其他配置
+      apiKey: 'your-deepseek-api-key'
+    }
+  }
+}
+```
+
+**方案 B：Git Hook 注入**
+
+在 `.githooks/pre-commit` 或 `.husky/pre-commit` 中临时导出：
+
+```bash
+#!/bin/sh
+export DEEPSEEK_API_KEY=[your-deepseek-api-key]
+./node_modules/.bin/code-gate-hook
+```
+
+**方案 C：环境变量**
+
+在 `.env` 文件或系统环境变量中设置：
+
+```bash
+export DEEPSEEK_API_KEY=[your-deepseek-api-key]
+```
+
+## 📖 配置详解
+
+| 参数 | 类型 | 默认值 | 说明 |
+| :--- | :--- | :--- | :--- |
+| `provider` | `string` | `'ollama'` | 选择使用的 AI 审查引擎。可选值: `'ollama'`, `'deepseek'`, `'openai'`, `'anthropic'`, `'aliyun'`, `'volcengine'`, `'zhipu'` 等 |
+| `providerOptions` | `object` | `{}` | 各 Provider 的具体配置集合（见下表） |
+| `fileTypes` | `string[]` | `[]` | 需要审查的文件类型扩展名列表（白名单）。若为空数组或未配置，则审查所有文件。 |
+| `exclude` | `string[]` | `['**/package-lock.json', '**/yarn.lock', '**/pnpm-lock.yaml']` | 不需要审查的文件或目录列表（黑名单），支持 glob 模式匹配（如 `node_modules/**`）。优先级高于 `fileTypes`。 |
+| `ui.openBrowser` | `boolean` | `true` | 是否自动打开浏览器预览 |
+| `ui.port` | `number` | `5175` | 预览服务端口 |
+| `limits.maxDiffLines` | `number` | `10000` | 最大 diff 行数，超出限制可能导致审查不完整或消耗过多 Token |
+| `limits.maxFiles` | `number` | `100` | 最大审查文件数 |
+| `reviewMode` | `string` | `'files'` | 审查模式：`'summary'` (仅汇总), `'files'` (仅文件详情), `'both'` (两者都有) |
+| `language` | `string` | `'en'` | 界面与 Prompt 语言。可选值：`'en'`, `'zh-CN'`, `'zh-TW'`, `'ja'`, `'ko'`, `'de'`, `'fr'` |
+| `prompt` | `string` | `...` | 发送给 AI 的通用系统提示词 |
+| `output.dir` | `string` | `'.review-logs'` | 本地生成报告和静态资源的输出目录 |
+
+### providerOptions 配置
+每个 Provider 可配置以下字段，支持 `request` 选项控制请求超时与重试。
+
+**关键参数说明：**
+- `baseURL`: API 基础地址（如 `https://api.deepseek.com` 或 `http://localhost:11434`）
+- `apiKey`: API 密钥（直接在配置中指定，不推荐提交到仓库）
+- `apiKeyEnv`: 存储 API 密钥的环境变量名称（推荐方式，如 `DEEPSEEK_API_KEY`）
+- `model`: 使用的模型名称（如 `deepseek-chat`, `qwen2.5-coder`）
+- `concurrencyFiles`: 并发审查的文件数量（建议云端 API 设置 4-8，本地ollama模型设置 1）
+- `request`: 高级请求配置（见下表“高级配置”）
+
+| Provider | 可配置参数 |
+| :--- | :--- |
+| **ollama** | `baseURL`, `model`, `concurrencyFiles`, `request` |
+| **deepseek** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `concurrencyFiles`, `request` |
+| **openai** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **anthropic** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **aliyun** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **volcengine** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **zhipu** | `baseURL`, `apiKey`, `apiKeyEnv`, `model`, `request` |
+| **azureOpenAI** | `endpoint`, `apiKey`, `apiKeyEnv`, `deployment`, `apiVersion`, `request` |
+
+#### 高级配置 (request)
+在 `providerOptions.<provider>.request` 中配置，用于控制请求行为：
+
+| 参数 | 类型 | 默认值 | 说明 |
+| :--- | :--- | :--- | :--- |
+| `timeout` | `number` | `undefined` | 请求超时时间（毫秒）。Ollama 默认建议设大一些（如 15000+） |
+| `retries` | `number` | `0` | 请求失败重试次数 |
+| `backoffMs` | `number` | `300` | 重试间隔时间（毫秒） |
+
+> **注意**：`concurrencyFiles` 控制并发审查的文件数（默认 DeepSeek=4, Ollama=1, 其他=4）。
+
+## ❓ 常见问题
+
+**Q: 页面显示 Diff 但没有 AI 建议？**
+- 检查 `provider` 配置是否正确。
+- 若使用 Ollama，请确保本地服务已启动 (`ollama serve`) 且模型已下载 (`ollama pull qwen2.5-coder`)。
+- 若使用云端 API，请检查 API Key 是否有效及网络连接。
+
+**Q: 如何在 CI/CD 中跳过审查？**
+Code Gate 会自动检测交互式环境。在 CI 环境中通常会自动跳过。如需强制跳过，可使用 `git commit --no-verify`。
+
+## 📄 License
+
+MIT

package/bin/code-gate.js

@@ -1,29 +1,22 @@
-#!/usr/bin/env node
-import('../dist/cli.js')
+#!/usr/bin/env node --no-warnings
+
+const cliPath = '../dist/cli/index.js'
+
+import(cliPath)
   .then(async (mod) => {
     if (mod && typeof mod.run === 'function') {
       await mod.run()
     } else {
-      console.error('code-gate: CLI not found in dist/cli.js')
+      console.error('code-gate: CLI entry point not found in dist/cli/index.js')
       process.exit(1)
     }
   })
-  .catch(async () => {
-    const { createRequire } = await import('module')
-    const require = createRequire(import.meta.url)
-    const path = require('path')
-    const url = require('url')
-    const fs = require('fs')
-    const dist = path.join(path.dirname(url.fileURLToPath(import.meta.url)), '..', 'dist', 'cli.js')
-    if (fs.existsSync(dist)) {
-      const mod = await import(url.pathToFileURL(dist).href)
-      if (mod && typeof mod.run === 'function') await mod.run()
-      else {
-        console.error('code-gate: CLI not found in dist/cli.js')
-        process.exit(1)
-      }
+  .catch(async (e) => {
+    if (e.code === 'ERR_MODULE_NOT_FOUND') {
+      console.error('code-gate is not built yet or path is incorrect. Run `npm run build`.')
+      console.error('Error:', e.message)
     } else {
-      console.error('code-gate is not built yet. Run `npm run build`.')
-      process.exit(1)
+      console.error('Unexpected error:', e)
     }
+    process.exit(1)
   })

package/dist/__tests__/config.test.js

@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import { loadConfig } from '../config.js';
+import { loadConfig } from '../config/index.js';
 function withTempConfig(content, ext = '.json') {
     const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'code-gate-test-'));
     const file = path.join(dir, `code-gate.config${ext}`);

package/dist/__tests__/config.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../src/__tests__/config.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,SAAS,cAAc,CAAC,OAAY,EAAE,GAAG,GAAG,OAAO;IACjD,MAAM,GAAG,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACrE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,GAAG,EAAE,CAAC,CAAA;IACrD,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACnF,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;AACtB,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC;QAC7B,QAAQ,EAAE,UAAU;QACpB,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;QACtC,MAAM,EAAE,OAAO;KAChB,CAAC,CAAA;IACF,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,GAAG,CAAC,EAAE,EAAE,IAAI,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IAClE,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;IAClE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;AAC9C,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAC,CAAA"}
+{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../src/__tests__/config.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAE/C,SAAS,cAAc,CAAC,OAAY,EAAE,GAAG,GAAG,OAAO;IACjD,MAAM,GAAG,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACrE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,mBAAmB,GAAG,EAAE,CAAC,CAAA;IACrD,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACnF,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;AACtB,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC;QAC7B,QAAQ,EAAE,UAAU;QACpB,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;QACtC,MAAM,EAAE,OAAO;KAChB,CAAC,CAAA;IACF,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,GAAG,CAAC,EAAE,EAAE,IAAI,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IAClE,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;IAClE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;AAC9C,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAC,CAAA"}