Перейти к содержанию

Локализация CLI и конфигурации

CLI

1
lit-localize command [--flags]

Команды

Команда Описание
extract Извлечение вызовов msg из всех входных файлов и создание или обновление файлов XLIFF (.xlf).
build Включите переводы обратно в ваше приложение, используя настроенный режим.

Флаги

Флаг Описание
--help Отображение справки об использовании.
--config Путь к файлу JSON config. По умолчанию ./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": Внутренний XML-формат Google

Настройки режима выполнения

output.outputDir

string

Обязательно

Выходной каталог для сгенерированных модулей. Для каждой targetLocale генерируется файл <locale>.[js|ts]. Каждый файл представляет собой модуль, экспортирующий переводы для данной локали, с ключом по ID сообщения.

output.language

"js" | "ts"

По умолчанию "js", или "ts", если указан `tsConfig.

Язык, на котором будут генерироваться модули.

Настройки режима преобразования

output.outputDir

string

Требуется, если не указан tsConfig, в этом случае по умолчанию используется outDir этого файла. Если оба поля указаны, приоритет имеет это поле.

Выходной каталог для сгенерированных модулей. Для каждой локали в этой директории создается поддиректория, каждая из которых содержит полную сборку проекта для этой локали.

Настройки режима XLIFF

interchange.xliffDir

string

Необходимо с "mode": "xliff"

Каталог на диске для чтения/записи XML-файлов .xlf. Для каждой целевой локали будет использоваться путь <xliffDir>/<locale>.xlf.

interchange.placeholderStyle

"x" | "ph"

По умолчанию "x"

Как представлять заполнители, содержащие HTML-разметку и динамические выражения. Различные инструменты и сервисы локализации по-разному поддерживают синтаксис placeholder.

Настройки режима XLB

interchange.outputFile

string

Требуется с "mode": "xlb"

Выходной путь для XLB XML-файла, который будет создан, содержащий все сообщения, извлеченные из источника. Например, "data/localization/en.xlb"..

interchange.translationsGlob

string

Требуется с "mode": "xlb"

Glob шаблон XML-файлов XLB для чтения с диска, содержащих переведенные сообщения. Например, "data/localization/*.xlb".

Комментарии