Config

gt.config.json

gt.config.json ファイルについて

概要

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

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

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


フィールド

FieldTypeDescription
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"
    }
  },
}

files フィールドの使い方の詳細は、CLI(コマンドラインインターフェース)ツールの設定ドキュメントをご覧ください。


対応ロケールの指定方法

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

注意事項

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

次のステップ

このガイドはいかがですか?