epoint-project-rules 插件
把老师傅的经验喂给 AI，让它像熟练工一样写代码。
一、快速开始
1.1 环境要求
| 依赖 |
版本要求 |
检查方式 |
| Node.js |
≥ 20.x |
node -v |
| 项目依赖 |
- |
cd vscode插件-projectrules/mcp_tools && npm install |
MCP 服务器运行在独立线程中，必须先安装依赖。
1.2 配置 MCP
- 激活插件 → 侧边栏 "政务BG规范助手" → "⚙️ 管理配置" → "复制配置信息"
- 粘贴到 AI 客户端（Cursor / Trae / Claude Desktop 等）的 MCP 设置中
- 插件升级后无需重新配置（使用稳定路径
~/.epoint-rules/start-mcp.js）
二、三阶段施工系统
插件通过 MCP 协议承载需求、设计和批量骨架阶段；骨架完成后由 Coder 用本地提示词和工程工具完成整需求编码。主流程为三个 Skill 串联：
epoint-requirement-analyzer → epoint-requirement-design → epoint-design-tdd-coder
(需求分析) (设计) (编码)
在 AI 对话中用自然语言描述需求即可推进，无需手动切换工具。
2.1 需求分析
Skill：epoint-requirement-analyzer
| 步骤 |
工具 |
产出 |
| 入口锁定 |
req_prepare_context |
.active-demand + fixedPaths |
| Story 提交 |
req_stories_submit |
stories.json |
| 规则池 |
req_rule_pool_build_rule_draft → req_rule_decision_submit |
已确认规则别名 |
| 表候选 |
req_rule_pool_build_table_draft → req_table_decision_submit |
复用表白名单 |
| 封存 |
req_finalize_artifacts |
需求阶段凭证 |
需求分析只输出业务事实（Actor / User Story / 验收标准 / 不变量），不输出实现方案。
2.2 设计
Skill：epoint-requirement-design
| 步骤 |
工具 |
产出 |
| 入口锁定 |
design_prepare_context |
loadedArtifacts + fixedPaths |
| 规则与表确认 |
design_prepare_context 分步提交 |
规则快照 + 表消费决策 |
| 页面组成确认 |
design_prepare_context 分步提交 |
页面组成与交互合同 |
| 自动封存 |
design_prepare_context 末相 |
设计文档.json + 设计阶段凭证 |
设计阶段将 Story 归纳为业务对象（entity）、表承载（linkedTable.kind）和交互面意图（needsPage），不决定页面/组件/API 的具体实现形态。
2.3 编码
Skill：epoint-design-tdd-coder
| 步骤 |
工具 |
产出 |
| 施工计划 |
design_tdd_build_plan |
design-tdd-plan.json + business-facts.json |
| 骨架物化（一次批量） |
design_tdd_skeleton_materialize |
Java/HTML/CSS 骨架文件 |
| 整需求 Vibe Coding |
epoint-design-tdd-coder 本地提示词 |
按当前任务读取完整 Story/骨架/规则，维护 demand-implementation-tasks.md 并展示 TodoList，连续完成业务代码 |
| 业务验证 |
本地工程工具 |
测试、编译、前后端闭合和计划中的验证记录 |
技术栈锁定：
- 后端：Epoint Java，
@Component / extends BaseController / ICommonDao / SqlConditionUtil
- 前端：MiniUI + epoint API
施工红线：禁止 MyBatis / JPA / Lombok / Vue / React / axios / @Transactional；骨架后可以按 Story、对象键和现有绑定检索相近工程实现，按业务连续性修改需求相关源码；不调用会改变编码运行态的 Epoint MCP。
2.4 MCP 核心工具一览
| 工具 |
用途 |
project_scan |
项目勘测，生成 scan baseline |
req_prepare_context |
需求入口上下文锁定 |
req_stories_submit |
提交结构化 Story |
req_rule_pool_build_rule_draft |
规则召回草案 |
req_rule_decision_submit |
规则决策提交 |
req_rule_pool_build_table_draft |
表候选草案 |
req_table_decision_submit |
表决策提交 |
req_finalize_artifacts |
需求阶段封存 |
design_prepare_context |
设计入口上下文锁定 |
design_tdd_build_plan |
生成施工计划 |
design_tdd_skeleton_materialize |
骨架文件物化 |
rule_expert |
规则检索与读取（统一入口） |
list_rules |
列出所有可用规范文档 |
create_rule |
规范沉淀，自动生成 .md |
scan_reuse_index_refresh |
刷新复用索引 |
gate_contract |
上游需求/设计合同查询；骨架后编码不调用 |
batch_audit_task |
通用批量审计 |
compatibility_audit_task |
国产化适配（Oracle → PostgreSQL） |
security_audit_task |
脱敏安全整改 |
三、核心门禁
3.1 Owner 边界
| 角色 |
职责 |
禁止 |
| LLM |
需求业务判断；骨架后的完整 Story 理解、代码编写和验证 |
不写 Builder-owned 真值文件；不把实现细节反塞需求阶段 |
| Builder |
机械派生产物路径、骨架结构、文件坐落 |
不做业务决策、不生成问题卡 |
| Gate/Builder |
需求、设计和骨架阶段的结构产物与合同校验 |
不进入骨架后的连续编码循环 |
| Runtime Guard |
工具越权拦截、读写范围控制 |
不参与业务逻辑 |
3.2 上游结构校验
- 需求、设计和批量骨架阶段仍由 Builder 校验 JSON 结构、路径、字段和骨架合同。
- Coder 进入骨架后的连续编码后，不再通过逐 Story 状态工具逐条放行；以本地实施计划和真实验证记录为准。
- Coder 依据本地规则小抄、真实工程实例和验证命令自行完成代码质量检查。
- 编码完成 — Coder 对照整组 Story、验收和真实验证结果更新
demand-implementation-tasks.md；不依赖编码 finalize 工具
3.3 国产化适配
国产化适配是独立的专项流程，不经过三阶段主线：
输入"国产化适配" → 全仓库扫描 → 生成适配清单 → 逐文件/自动连跑修改 → 验证
- 原逻辑通过环境判断分支（
if (baseDao.isPostgresql())）隔离保全
- 改完代码必须同步清单打勾
- 支持单步确认和自动连跑两种模式
四、侧边栏功能
4.1 规范管理
- 📚 规范列表：分组展示所有
.mdc/.md 文件，支持一键复制提示词
- 🛠️ 快捷操作：内置模板快速创建自定义规范
- ⚙️ 管理配置：可视化引导配置及 Git 稀疏检出同步
4.2 VS Code 命令
| 命令 ID |
说明 |
epoint-project-rules.listRules |
列出所有规范文档 |
epoint-project-rules.searchRules |
搜索关键词 |
epoint-project-rules.restartMcp |
重启 MCP 服务 |
4.3 可视化页面
| 页面 |
打开方式 |
用途 |
| 项目资料驾驶舱 |
侧边栏按钮 |
表结构、业务关系、API 资产、工程导航 |
| 全链路流水线监控 |
浏览器打开 |
流水线进度、阻断诊断、产物概览 |
4.4 个性化配置
| 配置项 ID |
说明 |
epointProjectRules.rulesPath |
全局覆盖规范根路径 |
epointProjectRules.rulesGitUrl |
Git 仓库地址 |
epointProjectRules.userRulesPath |
个人/项目组扩展规范 |
五、规范文件体系
规范文件位于 projectrules/，遵循 [业务领域]-[场景].md 或 .mdc 范式：
projectrules/
├── backend/ # 后端：Action / Service / Entity / 数据层 / 定时任务
├── frontend/ # 前端：MiniUI / ePage / 表单 / 弹窗 / 附件
├── database/ # 数据库
└── global/ # 全局
支持 globs 自动扫描匹配文件。
六、仓库结构
vscode插件-projectrules/
├── mcp_tools/ # MCP 服务器 + Builder/Gate/Runtime Service
│ ├── modules/pipeline-support/ # 施工链路核心服务
│ └── test_suite/ # 回归测试套件
├── src/ # VS Code 插件前端源码
├── skills/ # （运行时由 Skill 安装器同步）
└── README.md # 本文件
更新日志
