Config

gt.config.json

gt.config.json 文件

概览

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

该文件会被 (1) 你的 <GTProvider> 组件 和 (2) gtx-cli translate 命令读取。 因此,建议将配置写入 gt.config.json 文件,而不是作为 prop 传递给你的 <GTProvider> 组件。

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


字段

字段类型描述
projectIdstringGT 系统中用于标识项目的唯一标识符
localesstring[]项目支持的语言代码数组
defaultLocalestring当缺少翻译时用作后备的主要语言代码
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