CodeGuard Tutor 进度更新:原型打通、团队同步开发与接口契约落地丨项目博客第二篇
继上一篇项目启动与整体规划后,我们正式进入第一阶段开发:插件原型与基础链路。目前项目已完成最小可行闭环(MVP),团队成员均已拉取代码、成功运行、并基于统一框架开始各自模块的初步开发。
本篇记录项目当前进度、团队分工落地、前后端契约对齐、环境验证、下一步计划。
一、当前整体进度
项目当前处于第 1~3 周:插件原型与基础链路阶段,核心目标是完成:
- VS Code 插件可启动、可运行
- 两条核心命令可触发
- 插件与本地 FastAPI 后端成功通信
- 前后端接口契约固定,形成可扩展基线
目前已全部达成。
二、团队开发环境验证:全员成功拉取代码并运行
项目代码仓库:https://gitee.com/celinaN/code-guard-tutor.git
截至目前,三位成员均已:
- 克隆 Gitee 仓库代码
- 完成 VS Code 插件开发环境配置(Node.js、TypeScript、yo、generator-code)
- 成功安装依赖、编译插件
- 在 Extension Development Host 中正常启动插件
- 成功连接本地后端服务,完成端到端请求 / 响应测试
三、核心进展:最小闭环已打通(插件 ↔ 后端)
根据队友发布的技术博客《面向可解释安全复核的 VS Code 扩展原型构建》,我们已完成项目最关键的工程底座:
1. 插件两条核心命令已实现
CodeGuard Tutor: Analyze Selection—— 分析选中代码CodeGuard Tutor: Analyze CurrentFile—— 分析当前文件
两条命令均可正常触发、无报错、可正确获取编辑器内代码内容。
2. 插件生命周期与激活机制稳定
插件通过 activationEvents 实现按需激活,保证轻量、不占用资源。
3. 前后端接口契约(Contract-First)已固定
我们采用契约优先的工程思路:
- 先定义请求 / 响应格式
- 再实现业务逻辑
- 确保插件与后端始终对齐、不出现联调灾难
当前后端接口 /analyze 已支持:
- mode: selection / file
- language: 语言类型
- file_path: 文件路径
- code: 代码内容
- workspace_root: 工作区路径
后端返回结构化 JSON,插件可稳定接收。
4. 端到端流程验证通过
插件触发 → 读取代码 → 发送请求 → 后端接收 → 返回结果 → 插件展示通道输出全链路无报错。
四、各成员当前开发任务及进度
在统一原型底座之上,团队三人已按分工进入各自模块的初步开发:
1. 成员A —— 插件交互与结果展示模块
- 基于现有插件框架继续完善命令逻辑
- 实现代码读取、文本选取、编辑器信息获取
- 准备接入
Diagnostics实现代码高亮与 Problems 面板 - 规划 Webview 解释面板结构与数据流向
当前状态:环境正常、命令可触发、通信链路稳定。
2. 成员B —— 核心风险分析引擎(后端服务)
- 基于 FastAPI 完成后端服务脚手架
- 实现
/analyze接口与请求模型 - 准备接入 AST 解析、规则检测、source/sink 识别
- 与插件保持契约对齐,保证后续无缝扩展
当前状态:服务可启动、接口可调用、数据结构初步确定。
3. 成员C —— 上下文增强与 AI 解释模块
- 与成员A、B交流明确前后端通信流程与接口契约
- 准备实现结构化 AI 分析包构造
- 调研 GPT-5.4-mini 接入方式与调用规范
- 设计漏洞解释、两类修复建议的输出格式
- 制定 Prompt 工程与标准化输出约束
当前状态:环境正常、流程跑通,学习制定 AI 模块输入输出规范。
五、当前遇到的问题与解决方案
-
插件首次编译较慢解决:使用
npm run watch自动监听文件变化,增量编译。 -
不同系统路径格式不一致解决:统一使用相对路径 + 工作区根路径拼接。
目前所有问题均已解决,不影响开发进度。
六、下一阶段计划(第 1~3 周剩余任务)
在当前原型基础上,我们将继续推进:
- 完善插件输出日志通道,便于调试与抽查
- 后端增加简单规则占位,为第二阶段规则引擎做准备
- 插件实现基础结果展示(OutputChannel)
- 团队完成第一次全流程联调,并录制演示片段
- 各自输出阶段性开发博客
七、总结
CodeGuard Tutor 项目已从规划阶段正式进入稳定开发阶段,最小闭环打通、团队环境统一、接口契约落地、三人并行开发顺利。
我们严格按照创新实训要求,保持公开透明、可复现的开发流程,每周同步博客、更新代码、保证进度可控。
更多推荐

所有评论(0)