hong-review-cli 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# hong-review-cli
+
+`hong-review-cli` 是一个基于命令行界面的智能代码审查工具。它通过结合大语言模型的能力与 GitLab 代码库的 MR（Merge Request）审查场景集成，旨在帮助开发者快速在终端实现交互式的高质量代码审核审查和自动化 MR 合并。
+
+## 🌟 核心特性
+
+- **终端直接审查**：无需离开编写代码的终端环境。
+- **智能分析**：使用类似 ChatGPT 这样的强 AI 模型分析所有的文件增删改查。
+- **全键盘操作**：直观的下钻式命令选项与带颜色的排版，不再枯燥。
+- **集成 Hooks 挂钩**：与 CI/CD 轻易相连，审查前后触发定制脚本流程。
+
+## 🚀 安装
+
+要全局安装此命令行工具，您需要环境中已安装 Node.js > 14+。
+
+在终端中执行以下命令进行全局安装：
+
+```bash
+npm install -g hong-review-cli
+```
+
+## 🛠️ 开始使用
+
+### 第一步：初始化登录配置
+安装成功后，请在任何终端目录输入该命令绑定您的资源：
+
+```bash
+hong-review login
+```
+*根据向导提示填写您的 GitLab 服务器域名，GitLab 令牌（Token）与模型（API Key）。配置会保存在您的本地安全目录中。*
+
+### 第二步：一键智能审查
+这是这个程序最强大的功能部分，只需要在任何地方运行：
+
+```bash
+hong-review ls
+```
+系统将自动为您拉取目前分配到你身上的待处理 MR。通过方向键选择之后，工具将在后台呼唤 AI 进行高强度的深度审查与建议反馈。
+
+或者，若您确切知道 GitLab 项目下的 MR 数字 ID，您也可以直接运行：
+```bash
+hong-review mr <mr_id>
+```
+
+> **自动化特性支持**
+> - 增加参数 `-R`（--report）可额外生成本地 Markdown 文件报告。
+> - 增加参数 `-c`（--comment）可自动在 GitLab Merge Request 发送一条包含排版的 Markdown 代码评论。
+> - 增加参数 `-m`（--merge）可以在 AI 判断通过/极低风险时执行静默合并代码！
+
+### 其他指令
+
+你可以随时执行 `hong-review` 或带上 `--help` 查看说明书：
+- `hong-review comment <mr_id> "<评论文本>"` 快捷留言
+- `hong-review merge <mr_id>` 快捷请求远端合并
+- `hong-review view <mr_id>` 终端内分页展示代码 Diff 变动详情
+- `hong-review config list` 列出所有系统配置的状态
+
+---
+
+## 🪝 流水线生命周期 (Hooks)
+
+作为现代化的工具，它可以绑定到第三方系统的事件提醒中。通过命令写入系统全局 Hooks 来进行拦截事件：
+```json
+  "hooks": {
+    "onReviewStart": "curl -X POST http://xxx",
+    "onReviewSuccess": "bash ./scripts/notify-slack.sh",
+    "onReviewFailed": "node ./scripts/error.js",
+    "onMerged": "..."
+  }
+```
+
+## 📄 协议
+
+本项目基于 MIT 协议开发开源。

package/bin/hong-review.js

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const figlet = require('figlet');
+
+const path = require('path');
+// 命令实现
+const loginCmd = require(path.join(__dirname, '../src/commands/login'));
+const configCmd = require(path.join(__dirname, '../src/commands/config'));
+const mrCmd = require(path.join(__dirname, '../src/commands/mr'));
+const actionsCmd = require(path.join(__dirname, '../src/commands/actions'));
+const listCmd = require(path.join(__dirname, '../src/commands/list'));
+
+console.log(
+    chalk.cyan(
+        figlet.textSync('AI Review', { horizontalLayout: 'full' })
+    )
+);
+
+program
+    .version('1.0.0')
+    .description('AI Code Reviewer - 基于 GitLab 智能代码审查终端系统');
+
+// --- 基础配置 ---
+program
+    .command('login')
+    .alias('init')
+    .description('初始化登录或引导式设置全局配置')
+    .action(loginCmd);
+
+const configGroup = program
+    .command('config')
+    .description('管理全局配置');
+
+configGroup
+    .command('set <key> <value>')
+    .description('设置单个配置项 (如 aiKey, gitlabToken 等)')
+    .action(configCmd.set);
+
+configGroup
+    .command('list')
+    .description('列出当前所有的全局配置')
+    .action(configCmd.list);
+
+// --- 审查核心功能 ---
+program
+    .command('mr <mr_id>')
+    .description('智能审查指定的 GitLab Merge Request')
+    .option('-R, --report', '生成本地 Markdown 审查报告文件')
+    .option('-c, --comment', '审查完成后，自动将结果作为评论发至 MR 讨论区')
+    .option('-m, --merge', '审查通过且无明显问题时，自动合并该 MR')
+    .action((mr_id, options) => {
+        mrCmd(mr_id, options);
+    });
+
+program
+    .command('list')
+    .alias('ls')
+    .description('查看分配给我或待我处理的 MR 列表')
+    .action(listCmd);
+
+// --- 单独动作 ---
+program
+    .command('comment <mr_id> <text>')
+    .description('给指定的 MR 快捷留言/评论')
+    .action((mr_id, text) => {
+        actionsCmd.comment(mr_id, text);
+    });
+
+program
+    .command('merge <mr_id>')
+    .description('检查权限并快捷合并指定的 MR')
+    .action((mr_id) => {
+        actionsCmd.merge(mr_id);
+    });
+
+program
+    .command('view <mr_id>')
+    .description('在终端直接查看一个 MR 的文件差异 (Diff) 详情')
+    .action((mr_id) => {
+        actionsCmd.view(mr_id);
+    });
+
+program.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}

package/index.js

@@ -0,0 +1,166 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+const ora = require('ora');
+const figlet = require('figlet');
+
+// 延时函数用于模拟网络请求
+const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+
+// 伪造数据
+const mockMRs = [
+  { name: 'MR !102: [特性] 首页支持国际化切换', value: '102' },
+  { name: 'MR !108: [修复] 解决页面滚动回弹失效问题', value: '108' },
+  { name: 'MR !113: [重构] 抽离核心请求逻辑到 utils 模块', value: '113' }
+];
+
+const mockReviewResults = [
+  {
+    file: 'src/pages/index/index.vue',
+    type: 'warning',
+    line: 45,
+    message: '国际化文案键值 `header.title` 未在 en.json 中定义，但在页面中被使用了，可能导致渲染为原神键。'
+  },
+  {
+    file: 'src/utils/request.ts',
+    type: 'error',
+    line: 112,
+    message: '直接在代码中硬编码了 Token，建议通过环境变量或统一配置传入，存在安全隐患。'
+  },
+  {
+    file: 'src/utils/request.ts',
+    type: 'success',
+    line: 80,
+    message: '请求异常拦截器处理得很完善，符合团队规约。'
+  }
+];
+
+// CLI 入口
+async function main() {
+  console.log(
+    chalk.cyan(
+      figlet.textSync('AI Review', { horizontalLayout: 'full' })
+    )
+  );
+
+  program
+    .version('1.0.0')
+    .description('AI Code Review 命令行工具 (Demo)');
+
+  program
+    .command('init')
+    .description('初始化全局配置 (模拟)')
+    .action(async () => {
+      console.log(chalk.bold.blue('\n⚙️  初始化 AI Code Reviewer 配置'));
+      const answers = await inquirer.prompt([
+        {
+          type: 'input',
+          name: 'gitlabUrl',
+          message: '请输入 GitLab 的地址:',
+          default: 'https://gitlab.example.com'
+        },
+        {
+          type: 'password',
+          name: 'gitlabToken',
+          message: '请输入 GitLab Private Token:',
+          mask: '*'
+        },
+        {
+          type: 'password',
+          name: 'aiKey',
+          message: '请输入 AI 大模型的 API Key:',
+          mask: '*'
+        }
+      ]);
+
+      const spinner = ora('正在保存并校验配置...').start();
+      await sleep(1500);
+      spinner.succeed('配置保存成功！您可以开始使用 review 命令进行代码审查了。');
+    });
+
+  program
+    .command('review')
+    .description('审查 GitLab 上的合并请求 (Merge Request)')
+    .action(async () => {
+      console.log(chalk.bold.blue('\n🔍 进入代码审查模式\n'));
+      
+      const { target } = await inquirer.prompt([
+        {
+          type: 'list',
+          name: 'target',
+          message: '请选择您要审查的 Merge Request (示例列表):',
+          choices: mockMRs,
+        }
+      ]);
+
+      // 阶段 1：拉取代码
+      const fetchSpinner = ora('正在从 GitLab 拉取 MR 代码变更数据...').start();
+      await sleep(2000);
+      fetchSpinner.succeed(`成功拉取 MR !${target}，共包含 12 个文件修改，合计新增 154 行，删除 32 行。`);
+
+      // 阶段 2：AI 审查
+      console.log();
+      const aiSpinner = ora({
+        text: 'AI 正在深度审查代码 (思考中...) \n',
+        spinner: 'dots12' // 一个比较好看的加载动画
+      }).start();
+      await sleep(3500);
+      aiSpinner.succeed('AI 审查完成！已生成诊断报告。\n');
+
+      // 结段 3：输出报告
+      console.log(chalk.bold.inverse(` ====== 📋 审查报告：MR !${target} ====== \n`));
+      
+      let errorCount = 0;
+      let warningCount = 0;
+
+      mockReviewResults.forEach((issue) => {
+        let prefix = '';
+        if (issue.type === 'error') {
+          prefix = chalk.bgRed.black(' ERROR ') + chalk.red(' 严重');
+          errorCount++;
+        } else if (issue.type === 'warning') {
+          prefix = chalk.bgYellow.black(' WARN ') + chalk.yellow(' 建议');
+          warningCount++;
+        } else if (issue.type === 'success') {
+          prefix = chalk.bgGreen.black(' PASS ') + chalk.green(' 规范');
+        }
+
+        console.log(`${prefix}  ${chalk.underline(issue.file)}:${issue.line}`);
+        console.log(chalk.gray(`       💡 ${issue.message}\n`));
+      });
+
+      console.log('--------------------------------------------------');
+      const sumText = `审查总结：发现 ${chalk.red(errorCount + ' 个严重问题')}，${chalk.yellow(warningCount + ' 个优化建议')}。`;
+      console.log(sumText);
+      console.log('--------------------------------------------------\n');
+
+      const { autoComment } = await inquirer.prompt([
+        {
+          type: 'confirm',
+          name: 'autoComment',
+          message: '是否将此报告结果自动推送到 GitLab 作为 MR 评论？',
+          default: true
+        }
+      ]);
+
+      if (autoComment) {
+        const commentSpinner = ora('正在向 GitLab 发送评论...').start();
+        await sleep(1500);
+        commentSpinner.succeed('推送成功！已在此 MR 开启相应的讨论线程 (Thread)。\n');
+      } else {
+        console.log(chalk.green('操作已取消。感谢使用。\n'));
+      }
+    });
+
+  program.parse(process.argv);
+
+  if (!process.argv.slice(2).length) {
+    program.outputHelp();
+  }
+}
+
+main().catch(err => {
+  console.error(err);
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "hong-review-cli",
+  "version": "1.0.0",
+  "main": "index.js",
+  "bin": {
+    "hong-review": "bin/hong-review.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "code-review",
+    "gitlab",
+    "ai",
+    "chatgpt"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "description": "基于 AI 和 GitLab 的智能代码审查终端系统",
+  "dependencies": {
+    "axios": "^1.13.5",
+    "chalk": "^4.1.2",
+    "cli-spinners": "^3.4.0",
+    "commander": "^14.0.3",
+    "figlet": "^1.10.0",
+    "inquirer": "^8.2.7",
+    "ora": "^5.4.1"
+  }
+}

package/src/commands/actions.js

@@ -0,0 +1,122 @@
+const inquirer = require('inquirer');
+const storage = require('../utils/storage');
+const logger = require('../utils/logger');
+const GitLabClient = require('../core/gitlab');
+
+function getClient() {
+    const config = storage.getAll();
+    if (!config.gitlabToken) {
+        throw new Error('缺少 GitLab Token 配置，请运行 hong-review login');
+    }
+    return new GitLabClient({ host: config.gitlabUrl, token: config.gitlabToken });
+}
+
+async function getProjectId() {
+    let projectId = storage.get('defaultProjectId');
+    if (!projectId) {
+         const answer = await inquirer.prompt([{
+             type: 'input',
+             name: 'pid',
+             message: '请输入当前 Git 仓库对应的 GitLab Project ID:'
+         }]);
+         projectId = answer.pid;
+         storage.set('defaultProjectId', projectId);
+    }
+    return projectId;
+}
+
+module.exports = {
+    async comment(mrId, text) {
+        if (!text) {
+             logger.error('请输入评论内容。用法: hong-review comment <mr_id> "您的评论"');
+             return;
+        }
+        try {
+             const projectId = await getProjectId();
+             const gitlab = getClient();
+             
+             logger.startSpinner('comment', `正在向 MR !${mrId} 发送评论...`);
+             await gitlab.addMergeRequestNote(projectId, mrId, { body: text });
+             logger.stopSpinner('comment', true, '评论发送成功！');
+
+        } catch (e) {
+             logger.stopSpinner('comment', false, `评论发送失败: ${e.message}`);
+        }
+    },
+
+    async merge(mrId) {
+        try {
+             const projectId = await getProjectId();
+             const gitlab = getClient();
+             
+             logger.startSpinner('merge-check', `正在检查 MR !${mrId} 合并权限...`);
+             const check = await gitlab.canMergeMR(projectId, mrId);
+             
+             if (!check.canMerge) {
+                 logger.stopSpinner('merge-check', false, `无法合并: ${check.reason}`);
+                 return;
+             }
+             logger.stopSpinner('merge-check', true, '权限检查通过。');
+
+             const answer = await inquirer.prompt([{
+                 type: 'confirm',
+                 name: 'confirmMerge',
+                 message: `即将自动合并 MR !${mrId}，是否确认？`,
+                 default: false
+             }]);
+
+             if (answer.confirmMerge) {
+                 logger.startSpinner('merge', '合并中...');
+                 await gitlab.merge(projectId, mrId);
+                 logger.stopSpinner('merge', true, '合并成功！');
+             } else {
+                 logger.info('已取消合并。');
+             }
+
+        } catch (e) {
+             if (spinners && spinners.has('merge')) logger.stopSpinner('merge', false);
+             logger.error(`合并失败: ${e.message}`);
+        }
+    },
+
+    async view(mrId) {
+        try {
+             const projectId = await getProjectId();
+             const gitlab = getClient();
+             
+             logger.startSpinner('view', `拉取 MR !${mrId} 的文件变更...`);
+             const changes = await gitlab.getMergeRequestChanges(projectId, mrId);
+             logger.stopSpinner('view', true, `共拉取到 ${changes.length} 个文件的变更:\n`);
+
+             if (changes.length === 0) {
+                 logger.info('该 MR 无文件变更。');
+                 return;
+             }
+
+             const choices = changes.map((c, i) => ({
+                 name: `[${c.new_file ? '新增' : (c.deleted_file ? '删除' : '修改')}] ${c.new_path}`,
+                 value: i
+             }));
+
+             const answer = await inquirer.prompt([{
+                 type: 'list',
+                 name: 'fileIndex',
+                 message: '选择要查看 diff 的文件:',
+                 choices: [...choices, new inquirer.Separator(), { name: '退出', value: -1 }]
+             }]);
+
+             if (answer.fileIndex !== -1) {
+                 const selectedFile = changes[answer.fileIndex];
+                 console.log('\n--- Diff 开始 ---');
+                 console.log(selectedFile.diff);
+                 console.log('--- Diff 结束 ---\n');
+                 
+                 // 如果有需求可以加个无限循环，看完一个文件还能选另一个。
+                 // 但为了 CLI 简洁，目前设计看完即退
+             }
+
+        } catch (e) {
+             logger.error(`拉取变更失败: ${e.message}`);
+        }
+    }
+};

package/src/commands/config.js

@@ -0,0 +1,49 @@
+const storage = require('../utils/storage');
+const logger = require('../utils/logger');
+const chalk = require('chalk');
+
+module.exports = {
+    list() {
+        const config = storage.getAll();
+        logger.divider();
+        logger.info('当前全局配置 (存储在 ~/.hong-review-config.json)');
+        logger.divider();
+        
+        for (const [key, value] of Object.entries(config)) {
+            if (typeof value === 'object') {
+                console.log(`${chalk.bold(key)}:`);
+                for (const [subKey, subValue] of Object.entries(value)) {
+                     console.log(`  ${chalk.gray('-')} ${subKey}: ${subValue ? chalk.green('已配置') : chalk.gray('未配置')}`);
+                }
+            } else {
+                let displayValue = value;
+                if ((key.toLowerCase().includes('token') || key.toLowerCase().includes('key')) && value) {
+                    displayValue = value.substring(0, 4) + '*'.repeat(value.length - 8) + value.substring(value.length - 4);
+                } else if (!value) {
+                    displayValue = chalk.gray('(未提供)');
+                }
+                console.log(`${chalk.bold(key)}: ${displayValue}`);
+            }
+        }
+        logger.divider();
+    },
+
+    set(key, value) {
+        if (!key || value === undefined) {
+             logger.error('参数错误。用法: hong-review config set <key> <value>');
+             return;
+        }
+
+        // 处理嵌套对象赋值，如 hooks.onReviewStart
+        if (key.includes('.')) {
+             const [parentKey, subKey] = key.split('.');
+             const currentParent = storage.get(parentKey) || {};
+             currentParent[subKey] = value;
+             storage.set(parentKey, currentParent);
+        } else {
+             storage.set(key, value);
+        }
+        
+        logger.success(`配置项 ${chalk.bold(key)} 已更新。`);
+    }
+};

package/src/commands/list.js

@@ -0,0 +1,65 @@
+const storage = require('../utils/storage');
+const logger = require('../utils/logger');
+const GitLabClient = require('../core/gitlab');
+const chalk = require('chalk');
+
+module.exports = async function() {
+    const config = storage.getAll();
+    if (!config.gitlabToken) {
+        logger.error('缺少 GitLab Token 配置，请运行 hong-review login');
+        return;
+    }
+
+    const gitlab = new GitLabClient({ host: config.gitlabUrl, token: config.gitlabToken });
+    
+    logger.startSpinner('list', '正在向 GitLab 拉取您需要处理的 Merge Requests...');
+    
+    try {
+        const mrs = await gitlab.getMyReviewMergeRequests();
+        logger.stopSpinner('list', true, `成功拉取！共分配给您或待您审核的 MR 有 ${mrs.length} 个。\n`);
+        
+        if (mrs.length === 0) {
+            logger.info('暂时没有需要您处理的 Merge Request。喝杯咖啡休息一下吧 ☕️\n');
+            return;
+        }
+
+        const inquirer = require('inquirer');
+        const mrCmd = require('./mr');
+
+        const choices = mrs.map((mr) => {
+            const titleStr = mr.title;
+            const refStr = chalk.dim(`(Project: ${mr.project_id} - !${mr.iid})`);
+            const branchStr = chalk.blue(`${mr.source_branch} -> ${mr.target_branch}`);
+            return {
+                name: `${titleStr} ${refStr} | ${branchStr}`,
+                value: mr
+            };
+        });
+
+        choices.push(new inquirer.Separator());
+        choices.push({ name: '退出 (Exit)', value: null });
+
+        const answer = await inquirer.prompt([
+            {
+                type: 'list',
+                name: 'selectedMr',
+                message: '请选择您要直接发起的代码审查 (按上下方向键选择):',
+                choices: choices,
+                pageSize: 10
+            }
+        ]);
+
+        if (answer.selectedMr) {
+            console.log('');
+            // 自动配置 projectId 避免下一次询问
+            storage.set('defaultProjectId', String(answer.selectedMr.project_id));
+            // 启动智能审查流程
+            await mrCmd(answer.selectedMr.iid, {});
+        } else {
+            logger.info('已退出。');
+        }
+        
+    } catch (e) {
+        logger.stopSpinner('list', false, `拉取 MR 列表失败: ${e.message}`);
+    }
+};

package/src/commands/login.js

@@ -0,0 +1,69 @@
+const inquirer = require('inquirer');
+const storage = require('../utils/storage');
+const logger = require('../utils/logger');
+const AIClient = require('../core/ai');
+
+module.exports = async function() {
+    logger.info('欢迎使用 AI Code Reviewer 命令行工具 👋');
+    logger.logRaw('下面将引导您完成基础配置信息的初始化。\n');
+
+    const config = storage.getAll();
+
+    const answers = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'gitlabUrl',
+            message: '1. 请输入 GitLab 服务器地址:',
+            default: config.gitlabUrl || 'https://gitlab.example.com',
+            validate: (input) => input.startsWith('http') ? true : '请输入有效的 URL (包含 http/https)'
+        },
+        {
+            type: 'password',
+            name: 'gitlabToken',
+            message: '2. 请输入您的 GitLab 个人访问令牌 (Private Token):',
+            mask: '*',
+            validate: (input) => input.length > 0 ? true : 'Token 不能为空'
+        },
+        {
+            type: 'password',
+            name: 'aiKey',
+            message: '3. 请输入您的大模型 API Key (如 OpenAI Key):',
+            mask: '*',
+            validate: (input) => input.length > 0 ? true : 'API Key 不能为空'
+        },
+        {
+            type: 'input',
+            name: 'aiBaseUrl',
+            message: '4. (可选) 大模型的自定义 baseUrl:',
+            default: config.aiBaseUrl || 'https://api.openai.com/v1'
+        },
+        {
+            type: 'input',
+            name: 'aiModel',
+            message: '5. (可选) 指定审查使用的大模型名称:',
+            default: config.aiModel || 'gpt-4o'
+        }
+    ]);
+
+    // 测试 AI 连通性
+    logger.startSpinner('ai-test', '正在验证 API Key 和大模型连通性...');
+    const aiClient = new AIClient({
+        apiKey: answers.aiKey,
+        baseURL: answers.aiBaseUrl,
+        model: answers.aiModel
+    });
+
+    const testResult = await aiClient.testConnection();
+
+    if (testResult.success) {
+        logger.stopSpinner('ai-test', true, `API Key 验证通过! (${testResult.responseTime}ms)`);
+        
+        // 保存配置
+        storage.saveConfig(answers);
+        logger.success('✅ 所有配置已成功保存！');
+        logger.logRaw('\n💡 提示: 您随时可以运行 `hong-review config list` 查看当前配置，或者再次运行 `hong-review login` 重新配置。');
+    } else {
+        logger.stopSpinner('ai-test', false, `API 验证失败: ${testResult.message}`);
+        logger.error('配置并未保存。请检查您的网络环境、URL 或者 API Key。');
+    }
+};