gt.config.json
gt.config.json 文件
概览
gt.config.json 文件用于存储项目的配置。
它包含关键信息,如项目的 projectId、受支持的 locales 等。
它还包含重要的内部信息,如项目的 versionId。
该文件会被 (1) 你的 withGTConfig 组件和 (2) gtx-cli translate 命令读取。
因此,我们建议将配置放在 gt.config.json 中,而不要作为 prop 传递给 withGTConfig 组件。
通常,任何以下划线开头的项(例如 _versionId)都是内部属性,不应修改。
除此之外,其余内容可按需配置。
字段
| 字段 | 类型 | 描述 |
|---|---|---|
projectId | string | 在 GT 系统中用于标识项目的唯一标识符 |
locales | string[] | 项目支持的语言代码数组 |
defaultLocale | string | 当缺少翻译时用作 fallback 的主要语言代码 |
cacheUrl | string | 缓存翻译数据的 URL 端点 |
runtimeUrl | string | 运行时翻译服务的 URL 端点 |
stageTranslations | boolean | 预发布/预览翻译功能的配置 |
files | object | 开发和测试使用的本地翻译 files 路径 |
_versionId | string | 用于跟踪项目版本的内部属性(请勿修改) |
cacheUrl 和 runtimeUrl
如果你将翻译存放在云端,cacheUrl 是缓存的基准 URL。
runtimeUrl 是运行时的基准 URL,仅适用于开发阶段的翻译。
stageTranslations
stageTranslations 是 gtx-cli 工具使用的一个标志,用于将你的翻译标记为需要审核。
这意味着在通过 gtx-cli translate 命令部署到生产环境之前,它们必须先经过人工批准。
files
files 字段用于指定本地存放翻译的路径(相对于将其存储在云端)。
具体而言,output 字段用于指定写入翻译的目标位置。
{
"files": {
"gt": {
"output": "public/_gt/[locale].json"
}
},
}有关如何使用 files 字段的更多信息,请参阅 CLI 工具的配置文档。
示例
指定你的 locale
{
"defaultLocale": "en", // 主语言为英语
"locales": ["fr", "es"] // 次要语言为法语和西班牙语
}注意事项
gt.config.json文件用于指定项目的配置。- 该文件会被
withGTConfig组件和gtx-cli translate命令读取。
下一步
本指南如何?