ステージ
レビューのために翻訳をステージ環境に用意する方法
概要
gtx-cli stage は、プロジェクトの翻訳を生成し、レビューに備えてステージングするコマンドです。
このコマンドは、プロジェクトで人によるレビューを有効化している場合にのみ有用です。
現在、このコマンドは gt-next または gt-react を使用するアプリでのみサポートされています。
使い方
本番ビルドの前に、CI パイプラインでこれを実行してください。
npx gtx-cli stage注意: このコマンドには本番用の APIキー が必要です。プラットフォームで取得してください。
gtx-cli stage コマンドは translate コマンドと同様に動作しますが、完了した翻訳をダウンロードしたり、CDN（コンテンツ配信ネットワーク）に公開したりするのではなく、レビュー用にステージングするだけです。
gtx-cli stage を実行した後は、処理を完了し、（設定されていれば）翻訳をダウンロードするために gtx-cli translate を実行してください。
本番環境でのみ使用してください！
このコマンドは本番ビルドを想定しており、開発環境では使用しないでください。
実行前に、本番に使用するブランチに切り替わっていることを確認してください。
また、環境変数に本番用の APIキー（GT_API_KEY）とプロジェクトID（GT_PROJECT_ID）を指定することも忘れないでください。
フラグ
| Parameter | Description | Type | Optional | Default |
|---|---|---|---|---|
--api-key | 本番用のAPIキーを指定します | string | true | |
--project-id | プロジェクトIDを指定します | string | true | |
--version-id | バージョンIDを指定します（デフォルトはコンテンツのハッシュ） | string | true | |
--config <path> | GTの設定ファイルへのパスを指定します | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | TSまたはJSの設定ファイルへのパスを指定します | string | true | |
--src <paths> | ソースファイルにマッチするglobパターンのスペース区切りリスト。ルートディレクトリからの相対パスで指定してください。 | [string] | true | [ 'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ] |
--dictionary <path> | dictionaryファイルへのパスを指定します | string | true | |
--inline | dictionaryに加えてインラインの<T>タグを含めます | boolean | true | true |
--timeout | 翻訳リクエストのタイムアウト（秒） | number | true | 600 |
--new, --locales <locales> | プロジェクトを翻訳する対応ロケール | [string] | true | |
--default-locale <locale> | プロジェクトのソースlocale | string | true | en |
--ignore-errors | Errorを無視して有効なコンテンツの翻訳を強行します | flag | true | false |
--dry-run | コマンドをドライランします | flag | true | false |
これらのパラメータはすべて任意です。
APIキーを gt.config.json ファイルに追加しないでください！
代わりに環境変数として設定してください。CLIは、設定されている場合は自動的に GT_API_KEY を読み込みます。
いくつかの主要なパラメータがあります:
| Parameter | Description |
|---|---|
--dry-run | このフラグを指定すると、CLIはプロジェクトを解析・検証しますが、GT APIとは通信しません。コードベースの検証に有用です。 |
--api-key | --dry-run を使用していない場合は、本番用のAPIキーを必ず指定してください。 |
--project-id | 同様に、--dry-run を使用していない場合は、プロジェクトIDを必ず指定してください。 |
--new, --locales <locales> | プロジェクトを翻訳する対応ロケール。gt.config.json で指定した対応ロケールに追加されます。 |
設定ファイル
gtx-cli stage を実行すると、CLI は自動的に gt.config.json ファイルに stageTranslations: true プロパティを追加します。
このプロパティにより、特定のデプロイメントバージョンに対して先に stage を実行せずに translate を実行した場合、CLI ツールはエラーを出して終了します。
このガイドはいかがですか?