ステージ
翻訳をレビュー用にステージする方法
概要
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）とProject ID（GT_PROJECT_ID）も指定することを忘れないでください。
Flags
| 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> | 辞書ファイルへのパスを指定 | string | true | |
--inline | 辞書に加えてインライン<T>タグを含める | boolean | true | true |
--timeout | 翻訳リクエストのタイムアウト（秒） | number | true | 600 |
--new, --locales <locales> | プロジェクトを翻訳する対象のロケール | [string] | true | |
--default-locale <locale> | プロジェクトのソースロケール | string | true | en |
--ignore-errors | エラーを無視して有効なコンテンツの翻訳を強制実行 | 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は自動的にstageTranslations : trueプロパティをgt.config.jsonファイルに追加します。
このプロパティにより、特定のデプロイメントバージョンに対して最初にstageを実行せずにtranslateを実行した場合、
CLIツールはエラーを出力して終了します。
さらに、このプロパティにより、translateコマンドがstageコマンドで行われた翻訳を重複させないことが保証されます。
このガイドはいかがですか？