lingo extract
明示的な翻訳呼び出しから、ソースのJSONCとTypeScriptの型宣言を生成します。
lingo extractは、明示的に指定されたReactメッセージにカタログ上の識別情報を付与します。TypeScript/TSXの呼び出しをスキャンし、ソースのJSONCと型宣言をローカルに書き込み、各エントリとソースを結び付けるメタデータを保持します。任意のJSXを書き換えたり、翻訳をリクエストしたりすることはありません。
設定済みのReactコンポーネントでは、次のような呼び出しに対応しています。
const l = useLingo();
const label = l.text("Place order", { context: "Checkout submit button" });プロジェクトルートから抽出を実行します。
lingo extract --src src --source-locale en既定のパスを使用している場合は、locales/en.jsoncとlingo.d.tsを確認してください。ソースカタログには、メッセージの値、コンテキスト、ソース内の位置が記録されます。コンポーネントに必要なインポートとプロバイダーの設定は、Reactクイックスタートで紹介しています。
オプション #
| オプション | 既定値または動作 |
|---|---|
--src <path> | スキャン対象のディレクトリ。既定値はsrcです。 |
--source-locale <locale> | 出力するソースロケール。既定値はenです。 |
--out <path> | 設定済みのi18n.messagesPathより優先されます。どちらも未指定の場合は、既定値のlocalesを使用します。 |
--types <path> | 設定済みのi18n.typesPathより優先されます。どちらも未指定の場合は、既定値のlingo.d.tsを使用します。 |
--check | 書き込みを行わず、生成したバイト列をディスク上の内容と比較します。 |
パスは最も近いプロジェクトルートを基準に解決されます。ソースロケールはローカライズ設定のsourceLocaleを継承しません。別の言語を使用する場合は、明示的に指定してください。通常の書き込み時には、型宣言用のディレクトリが作成されます。
スキャナーの認識対象 #
スキャナーは、useLingoまたはcreateLingoから代入された変数に対するtext、rich、plural、selectの呼び出しに加え、慣例的なレシーバーであるlと.lも認識します。文字列リテラル、式を含まないテンプレート、静的なフォームオブジェクトに対応しています。
動的なメッセージには、安定して抽出できるソースがありません。ファクトリーの戻り値を分割代入すると、追跡対象のレシーバー構造が失われ、警告が表示されます。型宣言ファイル、ドットで始まるファイルやディレクトリ、およびnode_modulesは対象外です。TS/TSXファイルが存在しない場合、抽出処理はその旨を報告し、結果を返さずに終了します。プロセスが正常終了しても、メッセージが見つかったとは限りません。
識別情報とマージの動作をレビューする #
キーはソースとコンテキストから生成されます。文言やコンテキストが変わると、新しい識別情報が作成されることがあります。一方、実行時に置き換えられる値は識別情報に影響しません。キーが衝突すると抽出に失敗するため、区別できるコンテキストを指定する必要があります。
抽出結果は既存のソースカタログにマージされます。現在の値を保持し、コンテキストとソースのメタデータを更新し、新しいエントリを追加します。見つからなくなったメッセージには、孤立した状態であることを示すマークを付けます。出力は並べ替えられ、同じ入力からは常に同じ結果が得られます。孤立したメッセージをアプリケーションから意図的に削除されたものと判断する前に、警告を確認してください。
カタログをチェックまたは翻訳する #
lingo extract --checkは書き込みを行わず、カタログと型宣言の両方をバイト単位で比較します。lingo checkでは、さらにコンテキスト、孤立したエントリ、検出されたターゲットも確認します。
翻訳するには、実際の.jsoncのパスをfiles[]に追加し、認証とリンクを済ませて、初回用のlingo push --backfill-missing --waitを使用します。それ以降の変更には通常のプッシュを使用します。抽出先のパスを変更しても、ファイル設定は自動では更新されません。
JSONC対応のローダーを使い、カタログのメタデータポリシーに従って結果を読み込みます。プロバイダーが受け取るのは文字列マップです。ファイルパスをそのまま渡したり、通常のJSONインポートを使用したりするだけでは、この変換は完了しません。