Config

gt.config.json

gt.config.json ファイル

概要

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

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

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


フィールド

フィールド説明
projectIdstringGT システム内のプロジェクトを一意に識別する ID
localesstring[]プロジェクトでサポートするロケールコードの配列
defaultLocalestring翻訳が見つからない場合のフォールバックとして使用する主要なロケールコード
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"
    }
  },
}

CLI ツールの設定ドキュメントで、files フィールドの使用方法の詳細をご確認ください。


対応ロケールの指定方法

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

注意事項

  • gt.config.json ファイルは、プロジェクトの設定を定義するためのものです。
  • withGTConfig コンポーネントと gtx-cli translate コマンドの双方で読み込まれます。

次の手順

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

gt.config.json