CodeGuard AI PR Sentinel
CodeGuard AI PR Sentinel 是 CodeGuard AI Web 后台的 VSCode 侧入口,定位为面向 GitHub Pull Request 的 IDE 审查助手。插件不会绕过后端直接操作 GitHub,而是复用后端的登录、仓库绑定、任务、团队策略和评论流转能力。
当前能力
- 设备码登录:通过 GitHub 设备码登录 CodeGuard 后端。
- 仓库上下文:查看后端已绑定的 GitHub 仓库和分支。
- 审查任务:查看任务列表、任务详情、变更文件、Findings 和草稿评论。
- 行内诊断:把 Findings 映射为 VSCode Diagnostics,并支持跳转到本地文件。
- 评论流转:在插件内执行草稿评论的确认、忽略、发布。
- 团队策略只读:查看团队、仓库、成员、规则、技能和规范映射。
- IDE 快捷操作:复制建议、复制评论、生成修复草案、导出当前任务。
- 稳定性增强:GET 缓存、失败重试、手动刷新绕过缓存、日志导出。
- 发布工程化:发布前检查、本地 VSIX 打包、Marketplace 发布脚本和手册。
本地调试
- 启动 CodeGuard 后端,默认地址为
http://localhost:8000。
- 进入插件目录:
cd D:\codeai\vscode-extension
- 安装依赖并编译:
npm install
npm run compile
- 用 VSCode 打开
D:\codeai\vscode-extension。
- 按
F5 启动 Extension Development Host。
- 在新窗口左侧打开
CodeGuard,确认 API 地址指向后端。
- 点击
GitHub 设备码登录,按浏览器提示完成授权。
如果开发宿主窗口仍显示旧界面,执行 Developer: Reload Window 后重新打开 CodeGuard 面板。
本地安装 VSIX
- 生成安装包:
cd D:\codeai\vscode-extension
npm run package:vsix:release
- 在 VSCode 命令面板执行
Extensions: Install from VSIX...。
- 选择生成的
codeguard-ai-pr-sentinel-*.vsix。
- 安装后重载 VSCode,并配置
codeguard.apiBaseUrl。
每次插件代码有变更,都需要重新生成并安装新的 .vsix 才能看到安装态效果。
发布前检查
执行:
npm run check:release
该检查会验证:
package.json 的名称、版本、publisher、repository 是否完整。
codeguard.sidebarView 是否声明为 type=webview。
out/extension.js 是否已编译生成。
README.md、CHANGELOG.md、LICENSE、SUPPORT.md 是否存在。
.vscodeignore 是否排除了源码、历史 .vsix、package-lock.json 等非运行时文件。
Marketplace 发布
正式发布需要先完成手工准备:
- 在 Visual Studio Marketplace 创建或确认 publisher。
- 创建 Azure DevOps Personal Access Token,并授予 Marketplace 发布所需权限。
- 在当前终端设置
VSCE_PAT 环境变量。
- 确认
package.json 中的 publisher 与 Marketplace publisher 一致。
准备完成后执行:
cd D:\codeai\vscode-extension
$env:VSCE_PAT="<你的 Marketplace PAT>"
npm run publish:marketplace
如果只是试发布预览版本:
npm run publish:marketplace:pre-release
使用限制
- 插件必须连接一个可用的 CodeGuard 后端。
- 插件不会自动创建仓库绑定;仓库和任务来自后端已有数据。
- 本地联调可以继续使用
localhost 后端;给其他用户使用时,需要提供公网可访问的 CodeGuard 后端。
- 插件保存的是 CodeGuard 后端会话令牌,不直接保存 GitHub Token。
| |