本地化 CLI 與設定

CLI

「CLI」的永久連結

命令

「命令」的永久連結

命令描述
extract從所有輸入檔案中提取 msg 呼叫，並建立或更新 XLIFF (.xlf) 檔案。
build使用設定的模式將翻譯合併回您的應用程式。

旗標

「旗標」的永久連結

旗標描述
--help顯示關於使用方式的說明。
--configJSON 設定檔的路徑。預設為 ./lit-localize.json

設定檔

「設定檔」的永久連結

一般設定

「一般設定」的永久連結

所有檔案路徑都相對於設定檔的位置。

sourceLocale
字串

必要

原始碼中模板所使用的語系代碼。

targetLocales
字串[]

必要 (可以為空)

模板將被本地化的語系代碼。

inputFiles
字串[]

必要，除非指定 tsConfig

符合要從中提取訊息的 JavaScript 或 TypeScript 檔案的檔案名稱或 glob 模式陣列。

如果同時指定了 tsConfig 和 inputFiles，則 inputFiles 優先。

tsConfig
字串

必要，除非指定 inputFiles

tsconfig.json 或 jsconfig.json 檔案的路徑，該檔案描述將從中提取訊息的 JavaScript 或 TypeScript 檔案，以及在為轉換模式建置時將使用的編譯器選項。

如果同時指定了 tsConfig 和 inputFiles，則 inputFiles 優先。

output.mode
"transform" | "runtime"

必要

應該產生哪種輸出。請參閱模式。

output.localeCodesModule
字串

選用

產生 JavaScript 或 TypeScript 模組的檔案路徑，該模組使用您設定檔中的語系代碼匯出 sourceLocale、targetLocales 和 allLocales。用於保持設定檔和客戶端設定同步。

此路徑應以 ".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"。

編輯此頁面