Config

gt.config.json

gt.config.json ファイル

概要

gt.config.json ファイルは、プロジェクトの設定を保存する役割を担います。 プロジェクトの projectId、対応ロケールなどの重要な情報を保持します。 また、プロジェクトの versionId といった内部的に重要な情報も保持します。

このファイルは、(1) <GTProvider> コンポーネントと (2) gtx-cli translate コマンドによって読み込まれます。 そのため、<GTProvider> コンポーネントに props で渡すのではなく、設定は gt.config.json ファイルに保存することを推奨します。

一般的に、アンダースコアで始まるもの(例: _versionId)は内部プロパティであり、変更しないでください。 それ以外は編集して問題ありません。


フィールド

FieldTypeDescription
projectIdstringGT システム内のプロジェクトを一意に識別する ID
localesstring[]プロジェクトでサポートするロケールコードの配列
defaultLocalestring翻訳が不足している場合に [object Object] として使用される既定のロケールコード
cacheUrlstring翻訳データをキャッシュするための URL エンドポイント
runtimeUrlstringランタイム翻訳サービスの URL エンドポイント
stageTranslationsbooleanステージング/プレビュー用の翻訳機能の設定
filesobject開発・テスト用のローカル翻訳ファイルへのパス
_versionIdstringプロジェクトのバージョンを追跡するための内部プロパティ(変更しないでください)

cacheUrlruntimeUrl

翻訳をクラウドに保存している場合、cacheUrl はキャッシュ用のベースURLです。 runtimeUrl はランタイム用のベースURLで、開発時の翻訳にのみ適用されます。

stageTranslations

stageTranslations は、翻訳を「レビューが必要」としてマークするために gtx-cli ツールで使用されるフラグです。 これは、gtx-cli translate コマンドで本番環境にデプロイする前に、手動で承認する必要があることを意味します。

files

files フィールドは、(クラウドに保存するのとは対照的に)ローカルに保存された翻訳へのパスを指定します。 具体的には、output フィールドで翻訳を書き出す場所を指定します。

{
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  },
}

詳細については、files フィールドの使い方を CLI ツールの設定ドキュメントをご覧ください。


対応ロケールの指定方法

gt.config.json
{
  "defaultLocale": "en", // 既定のロケールは英語
  "locales": ["fr", "es"] // 対応ロケールはフランス語とスペイン語
}

注意事項

  • gt.config.json ファイルは、プロジェクトの設定を指定するために使用します。
  • このファイルは、<GTProvider> コンポーネントと gtx-cli translate コマンドの双方によって読み込まれます。

次の手順

このガイドはどうでしたか?

gt.config.json