CLIツール

概要

これは、General Translation CLIツールに関するリファレンスドキュメントです。 gtx-cliについての詳細はこちらを参照してください。

ステップバイステップガイドについては、本番環境へのデプロイガイドをチェックしてください。

インストール

npm i gtx-cli --save-dev

CLIツールは何をしますか？

CLIツールは、プロジェクトと翻訳を管理するために使用されます。 知っておくべき主なコマンドは2つあります：translateとsetupです。

• translateコマンドはCDパイプラインに追加することを目的としています。 プロジェクト内の翻訳対象のコンテンツをスキャンするために使用されます。 コンテンツはCDNにアップロードされるか、実行時に使用するためにアプリバンドルに追加されます。
• setupコマンドは、General Translationライブラリをプロジェクトに自動的に統合するために使用されます。 プロジェクトをスキャンし、すべてのJSXコンテンツを<T>コンポーネントでラップします。

翻訳

CLIツールを使用するには、プロジェクトのルートから次のコマンドを実行します：

npx gtx-cli translate

フラグ

CLIツールを初めて実行すると、プロジェクトのルートにgt.config.jsonファイルを作成しようとします。 このファイルには、コンテンツを翻訳するために使用されるプロジェクトに関するメタデータが含まれています。

セットアップ

さらに、CLIツールは自動的にプロジェクトをスキャンし、翻訳のためのセットアップを行うことができます。 General Translationを初めて使用する場合は、セットアップを実行して開始することをお勧めします。

npx gtx-cli setup

このコマンドを実行すると、翻訳可能なコンテンツを含むJSX要素の最上位に<T>コンポーネントが配置されます。

また、静的でないコンテンツは<Var>コンポーネントでラップされます。

以下はスキャンが変換する例です：

<div>Hello, World!</div>

<T id="">Hello, World!</T>

CLIはJSX要素内の直接の子要素のみをラップします。他のJSX要素は個別に独自の<T>コンポーネントでラップされます。

フラグ