概览

本教程将演示在使用 i18next 时，如何自动管理项目的翻译文件。

我们将按照以下 4 个步骤进行：

步骤 1：添加环境变量

将生产环境 API key 和项目 ID 添加到环境变量中。 这是使用 gtx-cli 工具所必需的。 这些信息可在 General Translation 仪表板 中获取。

GT_API_KEY=<你的 API 密钥>
GT_PROJECT_ID=<你的项目 ID>

步骤 2：安装 gtx-cli

在项目中安装 gtx-cli 工具。

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

步骤 3：创建 gt.config.json 文件

在项目根目录创建 gt.config.json 文件。

{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["messages/[locale]/*.json"]
    },
  },
}

您可以按需自定义 gt.config.json 文件。更多信息请参阅配置文档。

调整 json 文件设置，使 include 路径与您的项目结构匹配。

步骤 4：将 gtx-cli translate 命令加入构建流程

在构建或 CI 流程中，在运行构建命令之前加入 gtx-cli translate，即可自动将翻译内容添加到项目中。

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <你的构建命令>"
  }
}

这将为你的所有 locale 生成翻译，并将其保存到项目中。 如果你想把这些文件提交到仓库，也可以在提交之前先运行此命令。

全部完成！现在每当项目发生更改时，所有翻译用的 JSON 文件都会自动更新。

注意事项

• 你可以使用 gtx-cli translate 命令，自动为项目添加翻译。
• 如果你想将翻译文件提交到版本库，可以在提交前先运行 gtx-cli translate 命令。
• 如需配置翻译的输出路径，请参阅配置文档。

后续步骤

• 查看 CLI 工具的使用指南。