Config
gt.config.json
gt.config.json 文件
概述
gt.config.json
文件负责存储你项目的配置信息。
它包含了诸如你项目的 projectId
、支持的语言环境等重要信息。
同时,它还包含了一些内部的重要信息,比如你项目的 versionId
。
该文件会被 (1) 你的 withGTConfig()
组件 和 (2) gtx-cli translate
命令读取。
因此,我们建议你将配置信息存储在 gt.config.json
文件中,而不是作为 prop 传递给 withGTConfig()
组件。
通常,任何以下划线开头的属性(例如 _versionId
)都是内部属性,不应修改。
其他内容则可以根据需要进行更改。
字段
字段 | 类型 | 描述 |
---|---|---|
projectId | string | GT 系统中项目的唯一标识符 |
locales | string[] | 项目支持的语言区域代码数组 |
defaultLocale | string | 当翻译缺失时使用的主语言区域代码 |
cacheUrl | string | 用于缓存翻译数据的 URL 端点 |
runtimeUrl | string | 用于运行时翻译服务的 URL 端点 |
stageTranslations | boolean | 配置用于预发布/预览翻译功能 |
files | object | 用于开发和测试的本地翻译文件路径 |
_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 工具的配置文档。
示例
指定你的语言环境
{
"defaultLocale": "en", // 主要语言环境为英语
"locales": ["fr", "es"] // 次要语言环境为法语和西班牙语
}
注意事项
gt.config.json
文件用于指定你项目的配置。- 它会被
withGTConfig()
组件和gtx-cli translate
命令读取。
下一步
- 了解如何将你的翻译添加到项目的 bundle 中。
这份指南怎么样?