概览

gtx-cli 可用于自动翻译你项目中的 JavaScript（js）和 TypeScript（ts）文件。

我们将按以下 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": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}

将 defaultLocale 和 locales 修改为与你项目使用的 locales 相匹配的值。

如果你的文件是 JavaScript 文件，可以使用 js 键替代 ts。include 键中的字符串数组应为匹配所有 JS 文件的 glob 模式。

应使用 [locale] 占位符来匹配文件的 locale。

参见 configuration 文档，了解有关 gt.config.json 的更多信息。

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

在执行构建命令之前，将 gtx-cli translate 命令加入你的构建或 CI 流程，以自动把翻译注入到项目中。

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

这将为你所有的 locales 生成翻译，并保存到你的项目中。 如果你想把这些 files 提交到仓库，可以在提交前改为运行此命令。

完成！现在，每当你的项目发生变更时，所有 Markdown files 都会自动更新。

注意事项

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

后续步骤

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