Config

gt.config.json

gt.config.json 文件

概览

gt.config.json 文件用于存储项目配置。 它包含关键信息,例如项目的 projectId、支持的 locales 等; 也包含内部的重要信息,例如项目的 versionId

该文件会被 (1) withGTConfig 组件和 (2) gtx-cli translate 命令读取。 因此,我们建议将配置放在 gt.config.json 中,而不是作为 prop 传递给 withGTConfig 组件。

通常,任何以下划线开头的属性(例如 _versionId)都是内部字段,不应修改。 其他内容则可按需调整。


字段

字段类型描述
projectIdstringGT 系统中用于标识项目的唯一标识符
localesstring[]项目支持的语言代码(locale code)数组
defaultLocalestring当缺少翻译时作为回退(fallback)使用的主要语言代码
cacheUrlstring用于缓存翻译数据的 URL 端点
runtimeUrlstring运行时翻译服务的 URL 端点
stageTranslationsboolean预发布/预览翻译功能的配置项
filesobject用于开发和测试的本地翻译文件路径
_versionIdstring用于跟踪项目版本的内部属性(请勿修改)

cacheUrlruntimeUrl

如果你将翻译存储在云端,cacheUrl 是缓存的基础 URL。 runtimeUrl 是运行时的基础 URL,仅适用于开发阶段的翻译。

stageTranslations

stageTranslationsgtx-cli 工具使用的一个标志,用于将你的翻译标记为需审核。 这意味着在通过 gtx-cli translate 命令部署到生产环境之前,必须先由人工审核并批准。

files

files 字段用于指定本地存放的翻译文件路径(相对于将翻译存储在云端)。 具体而言,output 字段用于指定写入翻译结果的目标位置。

{
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  },
}

请参阅 CLI 工具的配置文档,以了解如何使用 files 字段的更多信息。


示例

指定你的 locales

gt.config.json
{
  "defaultLocale": "en", // 默认语言为英语
  "locales": ["fr", "es"] // 其他语言为法语和西班牙语
}

注意

下一步

这份指南怎么样?

gt.config.json