JSON

概述

gtx-cli 可用于自动翻译你项目中的 JSON 文件，无论你使用的是哪种 i18n 库。

注意： 我们目前支持以下 i18n 库的自定义字符串语法和格式：next-intl、i18next、gt-next、gt-react。

如果你使用的是其他 i18n 库，对于带有自定义语法和格式的字符串（例如 ICU 消息），翻译结果可能不够准确。没有看到你喜欢的库？请告诉我们，我们会尽快添加支持！

我们将按照以下四个步骤进行操作：

添加你的环境变量

创建一个 gt.config.json 文件

提示： 使用 <T> 组件可避免繁琐的翻译文件操作。

将你的生产 API 密钥和项目 ID 添加到环境变量中。这是使用 gtx-cli 工具所必需的。你可以在 General Translation 控制台获取这些信息。

.env

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

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

npm i --save-dev gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

在你的项目根目录下创建一个 gt.config.json 文件。

gt.config.json

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

你可以根据需要自定义 gt.config.json 文件。更多信息请参阅配置文档。

请更新 json 文件格式，使 include 路径与你的项目结构相匹配。

翻译将保留原始字符串语法。

在构建或 CI 流程中，在构建命令之前添加 gtx-cli translate 命令，以便自动为你的项目添加翻译。

package.json

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

这将为你所有的语言环境生成翻译，并将其保存到你的项目中。如果你希望将这些文件提交到你的仓库，可以在提交之前运行此命令。

你已经完成了！现在，每当你的项目发生变化时，所有的翻译 JSON 文件都会自动更新。