本地化 CLI 和配置
lit-localize command [--flags]
命令 | 描述 |
---|---|
extract | 从所有输入文件中提取 msg 调用,并创建或更新 XLIFF (.xlf ) 文件。 |
build | 使用配置的模式将翻译整合回你的应用程序。 |
标志 | 描述 |
---|---|
--help | 显示使用帮助信息。 |
--config | JSON 配置文件的路径。默认为 ./lit-localize.json |
所有文件路径都相对于配置文件的位置。
- sourceLocale
string
必填
源代码中模板编写所用的区域设置代码。
- targetLocales
string[]
必填(可以为空)
模板将被本地化的区域设置代码。
- inputFiles
string[]
除非指定了
tsConfig
,否则为必填文件名或 glob 模式数组,匹配要从中提取消息的 JavaScript 或 TypeScript 文件。
如果同时指定了
tsConfig
和inputFiles
,则inputFiles
优先。- tsConfig
string
除非指定了
inputFiles
,否则为必填tsconfig.json
或jsconfig.json
文件的路径, 该文件描述了将从中提取消息的 JavaScript 或 TypeScript 文件,以及在构建转换模式时将使用的编译器选项。如果同时指定了
tsConfig
和inputFiles
,则inputFiles
优先。- output.mode
"transform" | "runtime"
必填
应该产生什么类型的输出。参见 模式。
- output.localeCodesModule
string
可选
用于生成 JavaScript 或 TypeScript 模块的文件路径,该模块使用配置文件中的区域设置代码导出
sourceLocale
、targetLocales
和allLocales
。 用于保持配置文件和客户端配置同步。该路径应以
".js"
或".ts"
结尾。如果以".js"
结尾,将作为 JavaScript 模块发出。如果以".ts"
结尾,将作为 TypeScript 模块发出。- interchange.format
"xliff" | "xlb"
必填
本地化过程将使用的数据格式。选项:
"xliff"
: XLIFF 1.2 XML 格式"xlb"
:Google 内部 XML 格式
运行时模式设置
Permalink to "运行时模式设置"- output.outputDir
string
必填
生成模块的输出目录。为每个
targetLocale
生成一个<locale>.[js|ts]
文件。每个文件都是一个模块,导出该区域设置的翻译,以消息 ID 为键。- output.language
"js" | "ts"
默认为
"js"
,如果指定了tsConfig
,则默认为"ts"
。生成模块的语言。
转换模式设置
Permalink to "转换模式设置"- output.outputDir
string
除非指定了
tsConfig
,否则为必填,在指定了tsConfig
的情况下,默认为该文件的outDir
。如果两者都指定了,此字段优先。生成模块的输出目录。在此目录中为每个区域设置创建一个子目录,每个子目录包含该区域设置的项目完整构建。
XLIFF 模式设置
Permalink to "XLIFF 模式设置"- interchange.xliffDir
string
在
"mode": "xliff"
时必填读取/写入
.xlf
XML 文件的磁盘目录。对于每个目标区域设置,将使用路径<xliffDir>/<locale>.xlf
。- interchange.placeholderStyle
"x" | "ph"
默认为
"x"
如何表示包含 HTML 标记和动态表达式的占位符。 不同的本地化工具和服务对占位符语法的支持各不相同。
XLB 模式设置
Permalink to "XLB 模式设置"- interchange.outputFile
string
在
"mode": "xlb"
时必填将创建的 XLB XML 文件的输出路径,其中包含从源代码提取的所有消息。 例如
"data/localization/en.xlb".
- interchange.translationsGlob
string
在
"mode": "xlb"
时必填Glob 模式,用于从磁盘读取包含已翻译消息的 XLB XML 文件。例如
"data/localization/*.xlb"
。