JSONファイル

General Translationを使用してプロジェクトのJSONファイルの自動翻訳を設定する方法

概要

gtx-cliは、どのi18nライブラリを使用しているかに関わらず、プロジェクトのJSONファイルを自動的に翻訳するために使用できます。

注意: 現在、以下のi18nライブラリのカスタム文字列構文とフォーマットをサポートしています: next-intl、i18next、gt-next、gt-react。

異なるi18nライブラリを使用している場合、カスタム構文とフォーマットを持つ文字列（例えば、ICUメッセージ）の翻訳結果は正確でない可能性があります。お気に入りのライブラリが見つかりませんか？ぜひお知らせください。できるだけ早く追加します！

以下の4つのステップに従います：

環境変数を追加する

gtx-cliをインストールする

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

プロジェクトのルートに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ファイルが自動的に更新されます。