gt.config.json
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"
}
},
}
files
フィールドの使い方については、CLIツールの設定ドキュメントをご覧ください。
例
ロケールの指定
{
"defaultLocale": "en", // Primary locale is English
"locales": ["fr", "es"] // Secondary locales are French and Spanish
}
注意事項
gt.config.json
ファイルは、プロジェクトの設定を指定するために使用されます。- このファイルは、
withGTConfig()
コンポーネントとgtx-cli translate
コマンドの両方によって読み込まれます。
次のステップ
- 翻訳をプロジェクトのバンドルに追加する方法を学びましょう。
このガイドはいかがですか?