常用脚本
为了保持 Monorepo 的一致性,所有脚本必须在项目根目录执行。
核心脚本 (g)
g (Generator) 是 VSeed 开发中最关键的辅助脚本。
功能说明:
该命令是 build:test、build:docs 、build:api 的组合,用于确保开发环境的资源同步:
- 生成测试用例: 解析
tests/integrations下的 JSON Spec,生成对应的.test.ts文件。 - 生成文档: 解析 TypeScript 类型定义,更新
apps/website中的 API 文档。
使用场景:
- 修改了图表逻辑或添加了新图表类型后。
- 修改了 TypeScript 类型定义后。
- 提交代码前。
开发与构建
启动开发环境
同时启动 VSeed 监听与文档站点。
构建项目
构建 VSeed 核心库。
测试相关
运行所有测试
运行单元测试
运行集成测试
更新测试快照
当你的代码变更导致快照变化(且符合预期)时运行: