gt.config.json

概要

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

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

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

フィールド

| フィールド | タイプ | 説明 | |-------|-------------| | projectId | string | GT システム内のプロジェクトの一意の識別子 | | 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ファイルはプロジェクトの設定を指定するために使用されます。
• これは<GTProvider>コンポーネントとgtx-cli translateコマンドの両方によって読み込まれます。

次のステップ

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