DiAL/openspec/specs/frontend-development-workflow/spec.md

Purpose

定义 Vite + React + TypeScript 前端开发工作流、开发期 API 代理、共享契约和端到端 demo 的行为要求。

Requirements

Requirement: Vite React 开发服务器

系统 SHALL 提供基于 Vite + React + TypeScript 的前端开发工作流，并支持热模块替换。

Scenario: 启动前端开发服务器

• WHEN 开发者启动前端开发命令
• THEN 前端 SHALL 由 Vite 提供服务，并启用 React 热模块替换

Scenario: 构建前端静态资源

• WHEN 开发者运行前端生产构建命令
• THEN 系统 SHALL 产出可由 Bun 后端服务的前端静态资源

Requirement: 前端开发期 API 代理

前端开发服务器 SHALL 在本地开发期间将 /api/* 请求代理到 Bun 后端服务。

Scenario: 前端开发期调用 API

• WHEN 浏览器从 Vite 开发源请求 /api/demo
• THEN Vite SHALL 将请求转发到 Bun 后端服务，且不需要浏览器 CORS 配置

Scenario: 开发期访问非 API 前端路由

• WHEN 浏览器从 Vite 开发源请求非 API 前端路由
• THEN Vite SHALL 将该请求作为前端应用流量处理，而不是转发到后端

Requirement: 开发期后端端口一致性

项目 SHALL 保证文档化的全栈开发命令中，Vite proxy 目标端口与 Bun 后端监听端口来自同一配置来源。

Scenario: 使用默认开发端口

• WHEN 开发者未提供端口覆盖并运行文档化的全栈开发命令
• THEN Bun 后端 SHALL 监听默认端口，且 Vite SHALL 将 /api/* 代理到同一端口

Scenario: 使用 PORT 覆盖开发端口

• WHEN 开发者通过 PORT 覆盖后端端口并运行文档化的全栈开发命令
• THEN Bun 后端 SHALL 监听该端口，且 Vite SHALL 将 /api/* 代理到同一端口

Scenario: 避免代理端口与后端端口分叉

• WHEN 开发期脚本需要向 Vite 传递后端端口
• THEN 该代理端口 MUST 从文档化的后端端口配置派生，而不是作为独立对外配置导致分叉

Requirement: 前端使用相对 API 路径

除非有文档化的部署配置覆盖该行为，前端代码 MUST 通过相对 /api/* URL 调用后端 API。

Scenario: 前端获取后端数据

• WHEN 前端代码调用后端 API
• THEN 请求 URL 默认 MUST 使用相对 /api/* 路径

Scenario: 运行环境变化

• WHEN host 或 port 在开发环境和生产环境之间变化
• THEN 前端 API 调用 SHALL 无需修改源码即可继续工作

Requirement: 端到端开发 demo

项目 SHALL 提供一个可见的开发 demo，用于证明 React 前端可以通过 Vite 代理调用 Bun 后端。

Scenario: Demo 页面展示后端响应

• WHEN 开发者启动文档化的开发命令并打开前端 URL
• THEN 页面 SHALL 调用 /api/demo 并展示 Bun 后端返回的数据

Scenario: 开发期后端不可用

• WHEN 前端 demo 无法访问 /api/demo
• THEN 页面 SHALL 展示清晰的错误状态，而不是静默显示为成功

Requirement: 集成开发命令

项目 SHALL 提供一个文档化命令，用于在 demo 开发期间同时运行前端和后端。

Scenario: 启动全栈开发

• WHEN 开发者运行文档化的全栈开发命令
• THEN 系统 SHALL 启动 Vite 前端开发服务器和 /api/demo 所需的 Bun 后端服务器

Requirement: 开发质量命令文档化

项目 SHALL 在前端开发工作流文档中说明日常检查和完整验证命令。

Scenario: 查阅开发命令

• WHEN 开发者阅读 README 的开发或测试章节
• THEN 文档 SHALL 说明 check 用于日常开发检查，verify 用于提交前或发布前完整验证

Requirement: 共享 TypeScript 契约

项目 SHALL 为前端和后端共同使用的请求与响应类型提供共享 TypeScript 边界。

Scenario: 定义 API 响应结构

• WHEN 前端和后端都需要某个 API 响应类型
• THEN 该类型 SHALL 定义在 shared 模块中，而不是在两端重复定义

Scenario: 前端导入共享类型

• WHEN 前端代码导入共享 API 类型
• THEN 该导入 SHALL 不要求将后端运行时实现打包进前端