CLI バージョン0の対応形式

インストール済みの従来のパーサーにロケール構成を合わせ、再構築されたネイティブファイルを検証します。

抽出したいデータと、出力として必要なファイルに応じてバケットを選びます。バージョン0では、バケットの種類に基づいてパーサーが選択され、拡張子によってその選択が変わることはありません。そのため、JSONカタログと複数ロケールを含むXcodeカタログでは、どちらもメッセージを格納していても、それぞれ異なる設定が必要です。

まず出力モデルを選ぶ #

ほとんどのバケットは、パスに[locale]を使ってロケールごとに個別のファイルを出力します。CSV、Xcode文字列カタログ、JSON辞書、Vue i18nブロックは、複数のロケールを1つのファイルに格納できます。共有ファイルに出力する場合は、翻訳後に翻訳先と翻訳元の両方のセクションを確認してください。

バケットコンテンツドキュメント上の出力モデル
json, json5, jsonc構造化JSONの各種形式ロケールごとの個別ファイル
json-dictionaryロケールをキーとするオブジェクトを含むJSON値共有ファイル
yamlYAMLカタログロケールごとの個別ファイル
yaml-root-key出力ロケールのルートキーでラップされたYAMLロケールごとの個別ファイル
markdown, mdx, markdocマークダウン系の文書ロケールごとの個別ファイル
html, mjmlHTMLとメールのマークアップロケールごとの個別ファイル
androidAndroidのXMLリソースロケールごとの個別ファイル
xcode-strings, xcode-stringsdictAppleの文字列リソースと複数形リソースロケールごとの個別ファイル
xcode-xcstringsXcode文字列カタログ共有ファイル
flutterARBカタログロケールごとの個別ファイル
poGettextのPOファイルロケールごとの個別ファイル
propertiesJavaプロパティファイルロケールごとの個別ファイル
csv複数ロケールを含むCSV共有ファイル
csv-per-localeロケールごとに1つのCSVロケールごとの個別ファイル
xml, xliffXMLとXLIFFロケールごとの個別ファイル
srt, vtt字幕ロケールごとの個別ファイル
phpPHPのローカライゼーション配列ロケールごとの個別ファイル
typescriptTypeScriptのローカライゼーションコンテンツロケールごとの個別ファイル
vue-jsonロケールをキーとするVue i18nのJSONブロック共有ファイル
txtプレーンテキストロケールごとの個別ファイル

この一覧は従来のバケット群を示すもので、他のツールの互換性一覧ではありません。バージョン0の初期リリースには、一部の項目がまだ追加されていない場合があります。TypeScript、PHP、Vueのパーサーが処理するのは、それぞれが対応するローカライゼーション構造です。これらのパーサーが存在するからといって、実行可能なソースコードを自由に書き換えてよいわけではありません。

0.138.10のディスパッチャーには、ail、ejs、twig、dato、xcode-xcstrings-v2も含まれています。導入済みのプロジェクトで使われているパーサーは、入力と出力を確認するまで変更しないでください。スキーマの列挙型に含まれているだけでは、対応しているとは判断できません。従来のスキーマにはcompilerも記載されていますが、このディスパッチ経路には対応するローダーがありません。

yaml-root-keyが再構築するのは、選択したロケールのルートだけです。翻訳元と翻訳先に同じ共有YAMLファイルを指定しないでください。書き込みによって、ほかのルートが上書きされるおそれがあります。locales/[locale].ymlのように、ロケールごとに異なるパスを使用してください。これは、元の構造に新しいロケールを明示的に統合するJSON辞書やVueブロックとは異なる動作です。

代表的なファイルを設定する #

JSONでは、同じパターンで翻訳元ファイルと個別の翻訳先ファイルを指定します。

json
{
  "buckets": {
    "json": { "include": ["src/locales/[locale].json"] }
  }
}

共有のXcodeカタログと、Androidのロケール別リソースを併用する場合は、次のように設定します。

json
{
  "buckets": {
    "xcode-xcstrings": { "include": ["ios/Localizable.xcstrings"] },
    "android": {
      "include": ["android/app/src/main/res/values-[locale]/strings.xml"]
    }
  }
}

Androidのロケール表記とリソースディレクトリは、アプリケーションに合わせて調整してください。初回の実行後は、両方のネイティブ形式をそれぞれのビルドツールで検証し、選択した翻訳先ロケールをアプリケーションが読み込むことを確認してください。設定が受け付けられただけでは、そのパスが正しく機能することの確認にはなりません。

生成された出力を対象に含めずにファイルを検出する #

パスはi18n.jsonを基準に解決されます。*は同じ階層内で一致する項目を探します。再帰検索に使う**は0.135.0で導入されました。既定ではnode_modules、.git、dist、build、.next、.turboが除外されます。それ以外の生成コンテンツも明示的に除外してください。

json
{
  "buckets": {
    "markdown": {
      "include": ["docs/[locale]/*.md"],
      "exclude": ["docs/[locale]/drafts/*.md"]
    }
  }
}

複数のパッケージがある場合は、言語とローカライゼーションエンジンの管理主体に応じて、共有設定またはパッケージごとの設定を選びます。パスの対象範囲を絞ることで、生成された出力が意図せず翻訳元として取り込まれるのを防げます。

形式ごとの保護機能を確認する #

キーと値で構成されるカタログでは、各値の管理主体に応じてキーの制御を適用してください。JSONCとXcodeカタログのコメントには、翻訳者向けのメモを記載できます。自由形式の文書や字幕では、これらの機能を同じように使えるとは限りません。

カタログのキーと値、文書のマークアップとリンク、字幕のタイミング情報、ネイティブリソースの識別子など、パーサーが再構築した内容を確認してください。出力を利用する側のパーサーやビルドで使えることを確認してから、その出力を採用してください。移行時は、この従来の対応表がそのまま当てはまると考えず、現在の形式マニュアルと、呼び出し元ツールの対応形式一覧を参照してください。