你正在查看 Lit 的旧版本文档。点击 这里查看最新版本。

本地化 CLI 与配置

lit-localize command [--flags]

命令描述
extract从所有输入文件中提取 msg 调用并创建或更新 XLIFF(.xlf)文件。
build使用配置的模式将翻译合并回你的应用。

标志描述
--help显示使用帮助。
--configJSON 配置文件的路径。默认为 ./lit-localize.json

所有文件路径相对于配置文件的位置。

sourceLocale
string

必填

源代码中模板编写的语言区域代码。

targetLocales
string[]

必填(可以为空)

模板将被本地化为的语言区域代码。

inputFiles
string[]

除非指定了 tsConfig,否则必填

匹配要提取消息的 JavaScript 或 TypeScript 文件的文件名或 glob 模式数组。

如果同时指定了 tsConfiginputFiles, 则 inputFiles 优先。

tsConfig
string

除非指定了 inputFiles,否则必填

描述将从中提取消息的 JavaScript 或 TypeScript 文件的 tsconfig.jsonjsconfig.json 文件路径, 同时也是转换模式构建时使用的编译器选项。

如果同时指定了 tsConfiginputFiles, 则 inputFiles 优先。

output.mode
"transform" | "runtime"

必填

应产生何种输出。参见 模式

output.localeCodesModule
string

可选

生成的 JavaScript 或 TypeScript 模块的文件路径,该模块使用 配置文件中的语言区域代码导出 sourceLocaletargetLocalesallLocales。 用于保持配置文件和客户端配置同步。

此路径应以 ".js"".ts" 结尾。 如果以 ".js" 结尾,则输出为 JavaScript 模块。 如果以 ".ts" 结尾,则输出为 TypeScript 模块。

interchange.format
"xliff" | "xlb"

必填

你的本地化流程使用的数据格式。选项:

  • "xliff"XLIFF 1.2 XML 格式
  • "xlb":Google 内部 XML 格式

output.outputDir
string

必填

生成模块的输出目录。 为每个 targetLocale 生成一个 <locale>.[js|ts] 文件。每个文件是导出该语言区域翻译的模块, 以消息 ID 为键。

output.language
"js" | "ts"

默认为 "js",如果指定了 tsConfig 则默认为 "ts"

生成模块使用的语言。

output.outputDir
string

除非指定了 tsConfig(此时默认为该文件的 outDir), 否则必填。如果同时指定了两者,此字段优先。

生成模块的输出目录。在此目录中为每个语言区域创建一个子目录, 每个子目录包含该语言区域的完整项目构建。

interchange.xliffDir
string

"mode": "xliff" 时必填

磁盘上读写 .xlf XML 文件的目录。 对于每个目标语言区域,将使用路径 <xliffDir>/<locale>.xlf

interchange.placeholderStyle
"x" | "ph"

默认为 "x"

如何表示包含 HTML 标记和动态表达式的占位符。 不同的本地化工具和服务对占位符语法的支持程度不同。

interchange.outputFile
string

"mode": "xlb" 时必填

将创建的包含所有从源代码提取消息的 XLB XML 文件的输出路径。 例如 "data/localization/en.xlb"

interchange.translationsGlob
string

"mode": "xlb" 时必填

从磁盘读取包含翻译消息的 XLB XML 文件的 Glob 模式。 例如 "data/localization/*.xlb"