翻訳

プロジェクトを翻訳する方法

使用方法

これは本番用のNext.jsアプリをビルドする前に、CIパイプラインで実行してください。

npx gtx-cli translate

注意: このコマンドには本番用APIキーが必要です!プラットフォームで取得してください。

概要

gtx-cli translateコマンドはプロジェクトを翻訳します。プロジェクトのファイルツリーを走査し、<T>コンポーネントでラップされたコンテンツを翻訳します。

さらに、辞書ファイル(提供されている場合)からのコンテンツも含まれます。

このコマンドはGeneral Translation APIおよび関連サービスを使用する主要な方法です。

本番環境での使用のみ!

このコマンドは本番ビルド用であり、開発環境では使用すべきではありません。 このコマンドを実行する前に、本番環境で使用されるブランチにいることを確認してください。 また、環境変数に本番用APIキー(GT_API_KEY)とプロジェクトID(GT_PROJECT_ID)を指定することも忘れないでください。

使用方法

translate コマンドを使用する方法は4つあります。方法1と2は本番用APIキーが必要です。

セットアップウィザード npx gtx-cli configure を実行して、translate コマンドを実行する前にプロジェクトの設定を行うことをおすすめします。 プロジェクトの設定方法によって、translateコマンドの挙動が変わる場合があります。

方法1: プロジェクトのJSONファイルを翻訳する

next-intlreact-i18nextnext-i18next などの他のi18nライブラリを使用している場合、この方法でプロジェクトのJSONファイルを翻訳できます。

翻訳は自動的にコードベースに保存されます。

CLIツールを使ってプロジェクトのJSONファイルを翻訳するには、gt.config.json ファイルの files プロパティに json を追加してください。 詳細は CLI設定ドキュメント をご覧ください。

npx gtx-cli translate

CLIツールは package.json ファイルを読み込むことで自動的にi18nライブラリを検出し、i18nライブラリの構文に従ってJSONを翻訳します。

方法2: GTプロジェクトを翻訳する

プロジェクトで gt-next または gt-react を使用している場合、この方法でプロジェクトの翻訳を生成できます。

npx gtx-cli translate

デフォルトでは、翻訳はGT CDNに保存されます。

ただし、翻訳をコードベースに保存したい場合は、gt.config.json ファイルの files オブジェクトに gt プロパティを追加してください。

gt-nextgt-react は、翻訳をローカルで提供することも、General TranslationのパブリックCDNを利用することもサポートしています。 レイテンシの低減、パフォーマンス向上、バンドルサイズの縮小のためにCDNの利用を推奨します。

詳細は CLI設定ドキュメント をご覧ください。

方法3: プロジェクトの <T> コンポーネントと辞書ファイルを検証する

この方法は、プロジェクトの <T> コンポーネントと辞書ファイルを検証するのに便利です。

これにより、プロジェクトが正しく設定されており、翻訳が有効かつ正確であることを確認できます。

--dry-run フラグを指定した場合、翻訳は生成されません。

npx gtx-cli translate --dry-run

フラグ

パラメータ説明タイプオプションデフォルト
--api-keyプロダクションAPIキーを指定stringtrue
--project-idプロジェクトIDを指定stringtrue
--version-idバージョンIDを指定(デフォルトでは、コンテンツのハッシュ)stringtrue
--config <path>GT設定ファイルへのパスを指定stringtrue"gt.config.json"
--tsconfig, --jsconfig <path>TSまたはJS設定ファイルへのパスを指定stringtrue
--src <paths>スキャンするソースディレクトリを指定[string]true./src && ./app && ./pages && ./components
--dictionary <path>辞書ファイルへのパスを指定stringtrue
--inline辞書に加えてインライン<T>タグを含めるbooleantruetrue
--timeout翻訳リクエストのタイムアウト(秒)numbertrue600
--new, --locales <locales>プロジェクトを翻訳するロケール[string]true
--default-locale <locale>プロジェクトのソースロケールstringtrueen
--ignore-errorsエラーを無視し、有効なコンテンツの翻訳を強制flagtruefalse
--dry-runコマンドのドライランflagtruefalse
--no-wait翻訳が完了するのを待たずに終了flagtruefalse
--publish翻訳をCDNに公開flagtruefalse

これらのパラメータはすべてオプションであり、代わりにgt.config.jsonファイルで提供することもできます。

APIキーをgt.config.jsonファイルに追加しないでください! 代わりに環境変数として設定してください。CLIは設定されている場合、自動的にGT_API_KEYを読み取ります。

このページについて