本地化 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，否则为必需

描述要从中提取消息的 JavaScript 或 TypeScript 文件以及在构建转换模式时将使用的编译器选项的 tsconfig.json 或 jsconfig.json 文件的路径。

如果同时指定了 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"。

编辑此页面