gt.config.json

概要

gt.config.jsonファイルはプロジェクトの設定を保存する役割を担っています。 プロジェクトのprojectId、サポートされている言語ロケール、その他の重要な情報を保持しています。 また、プロジェクトのversionIdなどの重要な内部情報も保持しています。

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

一般的に、アンダースコアで始まるもの（例：_versionId）は内部プロパティであり、変更すべきではありません。 それ以外はすべて変更可能です。

フィールド

| フィールド | 型 | 説明 | |-------|-------------| | projectId | string | GTシステム内でプロジェクトを一意に識別するID | | locales | string[] | プロジェクトでサポートされているロケールコードの配列 | | defaultLocale | string | 翻訳が存在しない場合にフォールバックとして使用される主要なロケールコード | | cacheUrl | string | 翻訳データをキャッシュするためのURLエンドポイント | | runtimeUrl | string | ランタイム翻訳サービスのURLエンドポイント | | stageTranslations | boolean | ステージング／プレビュー翻訳機能の設定 | | files | object | 開発やテスト用のローカル翻訳ファイルへのパス | | _versionId | string | プロジェクトのバージョンを追跡するための内部プロパティ（変更しないでください） |

cacheUrl と runtimeUrl

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

stageTranslations

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

files

files フィールドは、（クラウドに保存するのとは対照的に）ローカルに保存された翻訳へのパスを指定します。 特に、output フィールドは翻訳が書き込まれる場所を指定します。

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

例

ロケールの指定

{
  "defaultLocale": "en", // Primary locale is English
  "locales": ["fr", "es"] // Secondary locales are French and Spanish
}

メモ

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

次のステップ

• 翻訳をプロジェクトのバンドルに追加する方法を学びましょう。