スキャン

使用方法

npx gtx-cli scan

概要

gtx-cli scanコマンドは、翻訳可能なコンテンツをプロジェクトでスキャンします。 これはプロジェクトのファイルツリーを解析し、babelを使用して静的コンテンツを<T>コンポーネントで囲むことで行われます。 動的コンテンツは自動的に<Var>コンポーネントで囲まれます。

import { T, Var } from 'gt-next'; 
 
export default function Home({ user }) {
  return (
    <div>
      <T id="app.home.0">
        Hello, World! My name is <Var>{ user.name }</Var>
      </T>
    </div>
  );
}

パラメータ

動作

設定ファイル

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

gt.config.jsonファイルについての詳細はこちらをご覧ください。

idプロパティ

scanコマンドは、<T>コンポーネントに自動的に一意のIDを生成します。 これは、多くの<T>コンポーネントを使用し、各コンポーネントに手動で一意のIDを割り当てる必要を避けたいプロジェクトに役立ちます。

このIDは、翻訳エディタやコンソールで特定の翻訳を参照するのに役立ちます。

この動作を無効にするには、--disable-idsフラグを使用できます。

<T>注入の動作

基本的なケース

CLIは可能な限り最上位のレベルでJSX要素を囲みます。 これは、すでに囲まれていない場合、コンポーネント全体を<T>コンポーネントで囲むことを意味します。

<div>Hello, World!</div> -> <T id="SOME_ID"><div>Hello, World!</div></T>

<T>コンポーネントがどのように囲まれるかの詳細については、リファレンスをご覧ください。

自動フォーマット

scanコマンドは、プロジェクトの設定に応じて、Prettier、Biome、またはESLintを使用して、コードベースに加えた変更を自動的にフォーマットします。

この動作を無効にするには、--disable-formattingフラグを使用できます。