gt.config.json
gt.config.json 文件
概览
gt.config.json 文件用于存储你的项目配置。
其中包含项目的 projectId、受支持的 locales 等关键信息。
它还包含诸如项目 versionId 等重要的内部信息。
该文件会被 (1) 你的 <GTProvider> 组件 和 (2) gtx-cli translate 命令读取。
因此,我们建议将配置放在 gt.config.json 文件中,而不要作为 prop 传递给你的 <GTProvider> 组件。
通常,任何以下划线开头的项(例如 _versionId)都是内部属性,不应修改。
其他项均可按需配置。
字段
| 字段 | 类型 | 描述 |
|---|---|---|
projectId | string | GT 系统中用于标识你项目的唯一标识符 |
locales | string[] | 你项目支持的语言代码数组 |
defaultLocale | string | 在缺少翻译时用作 fallback 的主语言代码 |
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)工具的配置文档。
示例
指定你的 locale
{
"defaultLocale": "en", // 主语言环境为英语
"locales": ["fr", "es"] // 次要语言环境为法语和西班牙语
}注意
gt.config.json文件用于指定项目的配置。- 该文件会被
<GTProvider>组件和gtx-cli translate命令读取。
下一步
本指南如何?