By name: demo-i18n-workflow
description: Adds or updates component demo, I18n (example/i18n/strings.json), and README/README.en. When adding new demo blocks or new API props, README must tag new demo titles and new API table rows with version (e.g. v2.10.0). Use when adding demo blocks, changing demo copy, adding or editing multilingual keys, updating strings.json, or syncing README for SmartUI demos.
Demo 与多语言维护
为组件新增/修改 demo 时，同步维护多语言与测试。
文案与 I18n
- Demo 中所有用户可见文案使用
I18n.t('key')，例如：title="{{I18n.t('basicUsage')}}"。 - 不在 wxml 中写死中文或英文。
维护 strings.json
- 文件路径：
example/i18n/strings.json。 - 结构：顶层为
en、zh，其下为 key → 文案。 - 新增或修改文案时，在同一 key 下同时维护：
en[key]：英文zh[key]：中文
维护 README 和 README.en
- 如果有新增 demo 需要同步书写到 README 和 README.en 内
- README 内的示例按中/英区块书写，不调用 I18n。
- 每一个新增的 demo 都需要带上一段描述文字
- 版本号：仅 README/README.en 需要带版本号，strings.json 不需要。
- 新增 demo 区块：该 demo 的标题后面加空格和版本号，例如：
### 文字颜色 \v2.10.0``。 - API/Props 表格新增属性或参数：在该行「说明」列末尾或参数名列后加版本号，例如：
| my-text-color \v2.11.0` | 按钮文字颜色 | _string_ | - |`。 - 版本号以当前开发版本为准（可从项目根目录
package.json的version获取，或询问用户）。
- 新增 demo 区块：该 demo 的标题后面加空格和版本号，例如：
流程
- 改 demo：在对应
packages/<组件名>/demo/下改 wxml/ts/less，所有展示文案用I18n.t('key')。 - 改多语言：在
example/i18n/strings.json的en、zh中补全或修改该 key。 - 更新 README / README.en：同步增加或检查 demo 代码与说明，标题与
packages/<组件名>/demo/内 demo 标题对应的多语言文案一致。若本次有新增 demo 或新增 API 属性：在 README/README.en 中为新增 demo 的标题、以及 API 表格中新增属性/参数行补充版本号（见上文「版本号（必须执行）」）。 - 跑测试：执行
yarn test；若 demo 结构或文案变了，执行npx jest -u更新快照。若更新快照报错，先修正测试直到快照可正常生成。
检查清单
- Demo 中无硬编码中文/英文，均通过 I18n.t('key') 展示
- 所用 key 在 strings.json 的 en、zh 中均有对应文案
- 所有 README 内 demo 的标题以及内容均和
packages/<组件名>/demo/内代码一一对应 - 新增 demo 或新增 API 属性时：README/README.en 中已为新增 demo 标题、新增 API 行补充版本号
-
yarn test通过，必要时已更新快照