コードレビューでReactのローカライゼーションを確認する

抽出、カタログのチェック、TypeScript、アプリケーションのビルドを組み合わせ、マージ前にさまざまなローカライゼーションの不具合を検出します。

Reactのメッセージの変更は、ソースコード、抽出、翻訳先カタログ、アプリケーションのローダーを経て、読み手に届きます。文言だけでなく、この一連の流れもレビューしてください。識別情報が古いままでは、翻訳が正しくても表示されません。また、原文へのフォールバックにより、画面は使えていても翻訳の欠落が見えなくなることがあります。

この方法は、CLIで抽出したJSONCカタログを使用する現行のReactパッケージを対象としています。CLIによる抽出チェックに加え、プロジェクト自体のビルドと描画のチェックも実行してください。

まずソースの変更を確認する #

新しい原文メッセージを、ユーザーへの指示や説明として読んでください。続いて、そのコンテキストを読みます。「ボタン」は形を示すだけですが、「送信前に支払い予約をキャンセルする」なら、翻訳でも意味を保つべき操作が伝わります。原文とコンテキストの両方が識別情報を構成するため、コンテキストだけの編集でも、新しい翻訳先エントリが必要になることがあります。

プレースホルダーは、用途が一貫した値としてレビューしてください。翻訳者が人物名や金額の位置を入れ替えても、その識別情報が変わらないようにする必要があります。リッチテキストでは、画面遷移やコンポーネントの動作はコード側で管理し、名前付きタグを含む文を翻訳します。具体的なAPIについては、メッセージとリッチテキストを参照してください。

翻訳先の確認前に抽出をチェックする #

CLIをインストールし、対象のプロジェクトディレクトリから実行します。

sh
lingo extract --check
lingo check

プロジェクトの抽出コマンドと同じ--src、--source-locale、--out、--typesのオプションを使用してください。ソースロケールの既定値はenです。ローカライゼーションの設定によって、このコマンドの既定値が変わることはありません。続いて、生成された宣言も含めて、リポジトリのTypeScriptチェックと本番用ビルドを実行します。

ローカルのレビュー用テストデータに意図的に加える不具合判定に使うチェックと期待される検出結果
カタログや宣言を再生成せずに原文メッセージを変更する。extract --checkが生成結果を比較し、古いままなら失敗する。
抽出対象のメッセージで必須のコンテキストを省略する。checkが抽出やコンテキストの問題を報告する。ソースを確認し、意味が正しく伝わるように修正する。
既存の翻訳先JSONCカタログでエントリを欠落させるか、空のままにする。checkが、見つかったカタログ内の翻訳の欠落を報告する。
生成された宣言を古いままにする。抽出やチェックで生成結果の不一致を検出する。TypeScriptは、アプリケーションでの使用方法を別途チェックする。
ロケールのインポートやフレームワークとの連携を壊す。アプリケーションの実際のビルドで、連携の不具合が明らかになるはず。

これらのチェックを初めて導入するときは、ローカルのテストデータを使用してください。extract --checkはソースファイルが見つからなくても成功するため、報告されたディレクトリに対象のコードが含まれていることを確認します。そうしないと、成功と表示されても、実際には何も検査していない可能性があります。

必要なロケールがすべて揃っているか明示的に確認する #

.lingo/config.json内のfilesパターンがソースカタログ(例:locales/en.jsonc)に一致する場合、lingo checkでは、設定されたすべての翻訳先ロケールのファイルも必要になります。lingo init --yesが書き出すパターンlocales/en.jsonは.jsoncカタログに一致しないため、そのパターンではReactのチェックだけが実行されます。キーの欠落が報告されるのは、既存の翻訳先JSONCカタログ内に限られます。レビューでは、必要なロケールの一覧をファイルやインポートと照合してください。ローカルのテストデータで翻訳先エントリを一時的に削除し、原文へのフォールバックが画面にどう表示されるかも確認します。

代表的な原文と翻訳を読み比べ、意味を確認してください。特に、ユーザーへの約束や製品用語の変更に注意します。JSONCの整合性チェックを通過しても、意味まで評価されたわけではありません。ARB、Android XML、Appleのカタログ、静的ドキュメントには、このReact固有の網羅性チェックではなく、それぞれの形式に適した検証が必要です。

レビュー済みの成果物を損なわずに差分を解消する #

lingo extractで古い成果物を再生成し、追加されたエントリや参照されなくなったエントリを確認して、必要な差分を翻訳します。レビュー済みの翻訳文とローカライゼーションのロックは保持してください。参照されなくなったエントリを削除するとカタログが変わるため、原文メッセージの変更とは別にレビューする必要があります。

翻訳をソースブランチに反映するか、翻訳専用のプルリクエストで取り込むかを選びます。継続的インテグレーションのガイドでは、取り込み方法ごとの利点と欠点、およびマネージドアプリの違いを説明しています。どちらの方法でも、マージ権限は実行権限やコンテンツの承認とは分けて管理してください。

最後に、代表的な値を使い、翻訳先ロケールで変更後の画面を開きます。リッチテキスト内のリンクをたどり、フォールバックの動作を確認して、表示されたメッセージが意図した操作を伝えているか確かめてください。プログラム内でメッセージが表示に至る経路と文言の両方を確認できたら、レビューは完了です。