Localization CLI and config - Lit

CLI

lit-localize command [--flags]

Commands

Command	Description
`extract`	Extract `msg` calls from all input files and create or update XLIFF (`.xlf`) files.
`build`	Incorporate translations back into your app using the configured mode.

Flags

Flag	Description
`--help`	Display help about usage.
`--config`	Path to JSON config file. Defaults to `./lit-localize.json`

Config file

General settings

All file paths are relative to the location of the config file.

</div> <dl class="params"> <dt class="paramName">sourceLocale</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required Locale code that templates in the source code are written in. </dd> <dt class="paramName">targetLocales</dt> <dd class="paramDetails"> <code class="paramType">string[]</code> Required (can be empty) Locale codes that templates will be localized to. </dd> <dt class="paramName">inputFiles</dt> <dd class="paramDetails"> <code class="paramType">string[]</code> Required unless <code>tsConfig</code> is specified Array of filenames or <a href="https://github.com/mrmlnc/fast-glob#pattern-syntax" target="_blank" rel="noopener"> glob</a> patterns matching the JavaScript or TypeScript files to extract messages from. If both <code>tsConfig</code> and <code>inputFiles</code> are specified, then <code>inputFiles</code> takes precedence. </dd> <dt class="paramName">tsConfig</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required unless <code>inputFiles</code> is specified Path to a <code>tsconfig.json</code> or <code>jsconfig.json</code> file that describes the JavaScript or TypeScript files from which messages will be extracted, and also the compiler options that will be used when building for transform mode. If both <code>tsConfig</code> and <code>inputFiles</code> are specified, then <code>inputFiles</code> takes precedence. </dd> <dt class="paramName">output.mode</dt> <dd class="paramDetails"> <code class="paramType">"transform" | "runtime"</code> Required What kind of output should be produced. See <a href="/docs/localization/overview/#output-modes">modes</a>. </dd> <dt class="paramName">output.localeCodesModule</dt> <dd class="paramDetails"> <code class="paramType">string</code> Optional Filepath for a generated JavaScript or TypeScript module that exports <code>sourceLocale</code>, <code>targetLocales</code>, and <code>allLocales</code> using the locale codes from your config file. Use to keep your config file and client config in sync. This path should end with either <code>".js"</code> or <code>".ts"</code>. If it ends with <code>".js"</code> it will be emitted as a JavaScript module. If it ends with <code>".ts"</code> it will be emitted as a TypeScript module. </dd> <dt class="paramName">interchange.format</dt> <dd class="paramDetails"> <code class="paramType">"xliff" | "xlb"</code> Required Data format to be consumed by your localization process. Options: <ul> <li><code>"xliff"</code>: <a href="https://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html" target="_blank" rel="noopener">XLIFF 1.2</a> XML format</li> <li><code>"xlb"</code>: Google-internal XML format</li> </ul> </dd> </dl>

Runtime mode settings

<dl class="params"> <dt class="paramName">output.outputDir</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required Output directory for generated modules. A <code><locale>.[js|ts]</code> file is generated for each <code>targetLocale</code>. Each file is a module that exports the translations for that locale, keyed by message ID. </dd> <dt class="paramName">output.language</dt> <dd class="paramDetails"> <code class="paramType">"js" | "ts"</code> Defaults to <code>"js"</code>, or <code>"ts"</code> if <code>tsConfig</code> was specified. Language to generate modules in. </dd> </dl>

Transform mode settings

<dl class="params"> <dt class="paramName">output.outputDir</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required unless <code>tsConfig</code> is specified, in which case it defaults to that file's <code>outDir</code>. If both are specified, this field takes precedence. Output directory for generated modules. A subdirectory is created for each locale within this directory, each containing a full build of the project for that locale. </dd> </dl>

XLIFF mode settings

<dl class="params"> <dt class="paramName">interchange.xliffDir</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required with <code>"mode": "xliff"</code> Directory on disk to read/write <code>.xlf</code> XML files. For each target locale, the path <code><xliffDir>/<locale>.xlf</code> will be used. </dd> <dt class="paramName">interchange.placeholderStyle</dt> <dd class="paramDetails"> <code class="paramType">"x" | "ph"</code> Defaults to <code>"x"</code> How to represent placeholders containing HTML markup and dynamic expressions. Different localization tools and services have varying support for placeholder syntax. </dd> </dl>

XLB mode settings

<dl class="params"> <dt class="paramName">interchange.outputFile</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required with <code>"mode": "xlb"</code> Output path for XLB XML file that will be created containing all messages extracted from the source. E.g. <code>"data/localization/en.xlb".</code> </dd> <dt class="paramName">interchange.translationsGlob</dt> <dd class="paramDetails"> <code class="paramType">string</code> Required with <code>"mode": "xlb"</code> <a href="https://github.com/mrmlnc/fast-glob#pattern-syntax" target="_blank" rel="noopener">Glob</a> pattern of XLB XML files to read from disk containing translated messages. E.g. <code>"data/localization/*.xlb"</code>. </dd> </dl>