JSON 文件

如何使用 General Translation 为您的项目的 JSON 文件设置自动翻译

概述

无论您使用的是什么 i18n 库,gtx-cli 都可以用于自动翻译您项目的 JSON 文件。

注意: 我们目前支持以下 i18n 库的自定义字符串语法和格式:next-intli18nextgt-nextgt-react

如果您使用的是不同的 i18n 库,对于具有自定义语法和格式的字符串(例如,ICU 消息),翻译结果可能不准确。 没有看到您喜欢的库?请告诉我们,我们会尽快添加它!

我们将遵循以下 4 个步骤:

添加您的环境变量

安装 gtx-cli

使用 gtx-cli init 命令初始化您的项目

提示: 使用 <T> 组件 可以避免使用翻译文件的麻烦。


步骤 1:添加您的环境变量

将您的生产 API 密钥和项目 ID 添加到您的环境变量中。 这对于使用 gtx-cli 工具是必要的。 您可以从 General Translation 仪表板 获取这些信息。

.env
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

步骤 2:安装 gtx-cli

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

npm i --save-dev gtx-cli

步骤 3:使用 gtx-cli init 命令初始化您的项目

运行 gtx-cli init 命令来配置您的项目。

npx gtx-cli init

步骤 4:将 gtx-cli translate 命令添加到您的构建过程中

在构建命令之前,将 gtx-cli translate 命令添加到您的构建或 CI 过程中,以自动为您的项目添加翻译。

package.json
{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

这将为您的所有语言环境生成翻译并将它们保存到您的项目中。 如果您想将这些文件提交到您的代码库,您可以在提交之前运行此命令。

您已完成!现在,每当您的项目发生变化时,它将自动更新您所有的翻译 JSON 文件。


注意事项

  • 您可以使用 gtx-cli translate 命令自动为您的项目添加翻译。
  • 如果您想提交您的翻译文件,您应该在提交之前运行 gtx-cli translate 命令。
  • 要配置翻译的输出路径,请参阅配置文档。

下一步

  • 查看 cli 工具的使用指南
  • 如果您想在开发中看到实时翻译(类似热重载),请查看 <T> 组件

在本页面