Files
persionalBrand/packages/template-contract/README.md
T

24 lines
2.2 KiB
Markdown

# Template Contract
模板包是构建期输入。模板必须声明 runtime contract、页面入口、导航、行业兼容性和能力依赖;不得在模板包中实现数据库访问、鉴权或业务状态机。
## 新增模板
1. 在 `packages/template-<key>/` 创建 `template.json` 和 `miniapp/`。
2. 在 manifest 中声明 `entrypoints`、`pages`、`navigation`、`requiredCapabilities`、数据槽位、媒体槽位和面向管理员的 `admin.sections`。
3. 将模板自己的页面、组件、tab 图标和 `miniapp/app.json` 放入模板包。页面必须提供 `.js`、`.json`、`.wxml`、`.wxss` 四个文件。
4. 如果需要替换运行时或能力包页面,必须在 `overrides` 中声明目录;未声明的同路径文件会被 compiler 拒绝。
5. 执行 `pnpm generate:template-catalog --write` 和 `pnpm template:check`。
## 模板完成门槛
- 每个 `entrypoints` 页面里由品牌编辑者提供的标题、说明、信任资料、业务详情和视觉文案,都必须由 Runtime 数据驱动,不能只在 WXML 中写成固定业务事实。
- 每个可编辑字段必须在 `admin.sections` 声明,并把 `page` 指向实际显示它的页面;测试会按页面检查 `presentation`、hero、profile、trust 和 offering 绑定,不能只在其他页面存在同名绑定。
- 每个 `trustContentTypes` 都必须声明至少一个实际展示页面;模板测试会检查 renderer 是否消费该类型,也会检查 renderer 使用的类型是否已声明在对应页面。
- `pnpm validate:templates` 会自动发现所有 `packages/template-*` 并运行上述绑定回归。模板不能在未通过该检查时标记完成。
- 通过自动检查后,还要用 `pnpm template:dev <key> --brand <slug>` 生成产物,检查真实内容、空状态和窄屏视觉;自动绑定测试不能替代微信开发者工具中的视觉验收。
最小可编译模板可参考 `packages/template-compiler/test/fixtures/template-drill-consultant`。
使用 `pnpm template:dev <key> --brand <slug>` 生成微信开发者工具项目。生产构建还必须提供 `--appid` 和 HTTPS `--api`。模板在构建时选择,运行时不会下载或解释模板代码。