概要

gtx-cli を使用すると、利用中のどの i18n ライブラリでも、プロジェクトの JSON ファイルを自動翻訳できます。

次の4つの手順に従います：

ステップ 1: 環境変数を追加する

本番用の APIキー と プロジェクトID を環境変数に追加します。 これは gtx-cli ツールを使用するために必要です。 これらは General Translation のダッシュボード で取得できます。

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-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": ["i18n/[locale]/*.json"]
    },
  },
}

必要に応じて gt.config.json ファイルをカスタマイズしてください。詳細は 設定 ドキュメントをご参照ください。

include パスがプロジェクト構成に合うように、json のファイル形式を更新してください。

ステップ4：ビルドプロセスに gtx-cli translate コマンドを追加する

ビルドコマンドの前に、ビルドまたは CI プロセスに gtx-cli translate コマンドを追加して、翻訳を自動的にプロジェクトに取り込みます。

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

これにより、すべての対応ロケール向けの翻訳が生成され、プロジェクトに保存されます。 これらのファイルをリポジトリにコミットする場合は、コミットの前に代わりに次のコマンドを実行してください。

完了です！これで、プロジェクトに変更があるたびに、翻訳用のJSONファイルが自動的に更新されます。

注意事項

• gtx-cli translate コマンドで、プロジェクトに翻訳を自動的に追加できます。
• 翻訳ファイルをコミットする場合は、コミット前に gtx-cli translate コマンドを実行してください。
• 翻訳の出力パスを設定するには、設定 ドキュメントを参照してください。

次のステップ

• CLI（コマンドラインインターフェイス）ツールの使用ガイドをご覧ください。