Config

gt.config.json

gt.config.json ファイル

概要

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

このファイルは、(1) withGTConfig() コンポーネントおよび (2) gtx-cli translate コマンドによって読み込まれます。 そのため、設定は withGTConfig() コンポーネントにプロップとして渡すのではなく、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"
    }
  },
}

files フィールドの使い方については、CLIツールの設定ドキュメントをご覧ください。


ロケールの指定

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

注意事項

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

次のステップ

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