ローカライゼーション CLI と設定

CLI

lit-localize command [--flags]

コマンド

「コマンド」へのパーマリンク

コマンド	説明
`extract`	すべての入力ファイルから `msg` 呼び出しを抽出し、XLIFF (`.xlf`) ファイルを作成または更新します。
`build`	設定されたモードを使用して、翻訳をアプリに組み込みます。

フラグ

「フラグ」へのパーマリンク

フラグ	説明
`--help`	使用方法に関するヘルプを表示します。
`--config`	JSON 設定ファイルへのパス。デフォルトは `./lit-localize.json` です。

設定ファイル

「設定ファイル」へのパーマリンク

一般設定

「一般設定」へのパーマリンク

すべてのファイルパスは、設定ファイルの場所からの相対パスです。

sourceLocale

文字列

必須

ソースコード内のテンプレートが記述されているロケールコード。

targetLocales

文字列[]

必須 (空にすることができます)

テンプレートがローカライズされるロケールコード。

inputFiles

文字列[]

tsConfig が指定されていない限り必須

メッセージを抽出する JavaScript または TypeScript ファイルと一致するファイル名または glob パターンの配列。

tsConfig と inputFiles の両方が指定されている場合、inputFiles が優先されます。

tsConfig

文字列

inputFiles が指定されていない限り必須

メッセージが抽出される JavaScript または TypeScript ファイル、および変換モードでビルドするときに使用されるコンパイラオプションを記述した tsconfig.json または jsconfig.json ファイルへのパス。

tsConfig と inputFiles の両方が指定されている場合、inputFiles が優先されます。

output.mode

"transform" | "runtime"

必須

生成される出力の種類。モードを参照してください。

output.localeCodesModule

文字列

オプション

設定ファイルのロケールコードを使用して、sourceLocale、targetLocales、および allLocales をエクスポートする、生成された JavaScript または TypeScript モジュールのファイルパス。設定ファイルとクライアント設定を同期するために使用します。

このパスは、".js" または ".ts" で終わる必要があります。 ".js" で終わる場合は、JavaScript モジュールとして出力されます。 ".ts" で終わる場合は、TypeScript モジュールとして出力されます。

interchange.format

"xliff" | "xlb"

必須

ローカライズプロセスによって使用されるデータ形式。オプション:

"xliff": XLIFF 1.2 XML 形式
"xlb": Google 内部 XML 形式

ランタイムモード設定

「ランタイムモード設定」へのパーマリンク

output.outputDir

文字列

必須

生成されたモジュールの出力ディレクトリ。各 targetLocale ごとに <locale>.[js|ts] ファイルが生成されます。各ファイルは、メッセージ ID をキーとする、そのロケールの翻訳をエクスポートするモジュールです。

output.language

"js" | "ts"

デフォルトは "js"、または tsConfig が指定されている場合は "ts" です。

モジュールを生成する言語。

変換モード設定

「変換モード設定」へのパーマリンク

output.outputDir

文字列

tsConfig が指定されていない限り必須です。指定されている場合は、そのファイルの outDir がデフォルトになります。両方が指定されている場合、このフィールドが優先されます。

生成されたモジュールの出力ディレクトリ。このディレクトリ内に各ロケールごとのサブディレクトリが作成され、それぞれにそのロケールのプロジェクトの完全なビルドが含まれます。

XLIFF モード設定

「XLIFF モード設定」へのパーマリンク

interchange.xliffDir

文字列

"mode": "xliff" の場合必須

.xlf XML ファイルを読み書きするディスク上のディレクトリ。各ターゲットロケールについて、パス <xliffDir>/<locale>.xlf が使用されます。

interchange.placeholderStyle

"x" | "ph"

デフォルトは "x"

HTML マークアップと動的式を含むプレースホルダーを表す方法。ローカライゼーションツールとサービスによって、プレースホルダー構文のサポートが異なります。

XLB モード設定

「XLB モード設定」へのパーマリンク

interchange.outputFile

文字列

"mode": "xlb" の場合必須

ソースから抽出されたすべてのメッセージを含む、作成される XLB XML ファイルの出力パス。例: "data/localization/en.xlb"。

interchange.translationsGlob

文字列

"mode": "xlb" の場合必須

翻訳されたメッセージを含む、ディスクから読み取る XLB XML ファイルの Glob パターン。例: "data/localization/*.xlb"。

このページを編集

前へ変換ローカライゼーションモード次へローカライゼーションのベストプラクティス