localazy.json
Localazy CLI configuration file. Documentation: https://localazy.com/docs/cli
| Type | object |
|---|---|
| File match |
localazy.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/localazy-json/latest.json |
| Source | https://raw.githubusercontent.com/localazy/cli-schema/master/localazy.json |
Validate with Lintel
npx @lintel/lintel checkSchema definition for Localazy CLI configuration file.
Properties
Schema definition for Localazy CLI configuration file.
Your project's write key. It can be found in Settings -> Access keys.
Your project's read key. It can be found in Settings -> Access keys.
The branch to perform the operation on. If not specified, the operation is performed on the project corresponding to write/read key.
Define community settings for sharing your configuration with other users. https://localazy.com/docs/cli/community-sharing
6 nested properties
The name of the author of the script.
The email of the author of the script. It's not available publicly.
Company name if applicable.
Website name if applicable.
A set of tags to help other users find your script. Please tag your technology stack, framework, library, programming language, etc.
The description of the script. Please describe what the script does and how it works.
The transformations property allows defining rules for string transformations. Using transformations, you can, e.g., obtain locale code from its file path or build the specific path where to write translated files. https://localazy.com/docs/cli/transformations
The upload section defines how to collect files that you want to upload to the Localazy platform for localization and what metadata to include. It also defines how to process uploaded data. https://localazy.com/docs/cli/upload-reference
16 nested properties
Tells the server to deprecate any phrase missing in this upload batch. Deprecated phrases are still available but are not visible to translators.
Tells the server to deprecate any phrase missing in this upload batch. Deprecated phrases are still available but are not visible to translators.
Tells the server to import new phrases as unverified. Unverified phrases need to go through the review process. This option allows you to check translations using our unique review process if you are not sure of their quality. This option doesn’t apply to the source language.
By default, you can have phrases with the same key in different files. For specific situations like using libraries and string overriding, it’s necessary to disable this option. You can find more on this topic in 'Modules, libraries, product flavors' article.
When set to true files that use auto-detection are skipped if the auto-detection is not possible. When set to false an exception is raised.
When set to true, strings that are the same as in the source langauge are not imported. This is important for platforms like iOS where localizable files contain the source phrase where the translation is not available. This option doesn’t apply to the source language.
Tells the server to promote changes in translated files as approved and current translations for phrases that are already translated. If set to false, such changes go to the review process.
Tells the server to promote changes from uploaded source language files even if there are different versions on Localazy.
Tells the server the version of the app in which the phrases where deprecated. It only makes sense with deprecateMissing switched to true. It allows for automatic versioning of deprecated phrases. This option can be provided on the command-line with -v option.
Type of files you are about to upload. You can also define the type separately for each file. For more info about supported file formats check out the documentation.
The base folder all operations are relative to. It can be relative or absolute path.
The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats
The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys
A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys
A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys
The files contains a list of rules for collecting files for upload. You can include files by their exact path or by using standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators). You can control files that you want to upload with exclusion rules and conditions.
The conversion property describes how to convert localizable files between different formats. https://localazy.com/docs/cli/format-conversions#full-configuration
3 nested properties
The base folder all operations are relative to. It can be relative or absolute path.
The list of languages to exclude from processing.
The download property describes how to process translated files and where to write them. https://localazy.com/docs/cli/download-reference
10 nested properties
By default, the source language is not downloaded. Set it to true to include source files as well.
Base folder for the download action. It can be relative or absolute path.
Path where JSON language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file
Path where JavaScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file
Path where TypeScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file
By default, export oldest metadata format. Set it to 2 to export the newest metadata format.
Maps languages to different ones.
Adds additional languages to output; the same file will be saved several time.
The list of languages to exclude from processing.
The rules to apply to all translated files. It can be either array object or a pattern string.
Definitions
The name of the newly created variable. It will be accessible as ${name}. https://localazy.com/docs/cli/variables
The source of the variable. Usually, it's a string consisting of other variables. https://localazy.com/docs/cli/variables
The operations to perform on the source string to get the new variable. https://localazy.com/docs/cli/transformations#operations
Type of files you are about to upload. For more info about supported file formats check out the documentation. https://localazy.com/docs/cli/upload-reference
The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats
The language of the file being uploaded (format: ll-Scrp-RR). Special default value inherited from the project’s base language.
Allows to assign files to groups and run their rules separately.
The custom build type for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#build-type
The custom product flavors for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#product-flavors
The module the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#module
The library the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#library
The path to be used for upload.
The file name to be used for upload.
The pattern to use for collecting files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported.
The list of patterns used for excluding files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported.
With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions
The remap property allows you to remap the structure of the file. https://localazy.com/docs/cli/remap
5 nested properties
The target type of the file to be uploaded data remapped to.
A separator to be used for flattening structured/nested keys.
A separator to be used for nesting flatten keys.
A type of plural to be used for remapping plurals.
A type of arrays to be used for remapping arrays.
Allows to assign files to groups and run their rules separately.
With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions
The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys
A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys
A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys
Define rules for text changes and placeholder replacements.
Maps languages to different ones.
Adds additional languages to output; the same file will be saved several time.
If true, no more rules are processed for the given file. Only makes sense if more output rules are defined. By default, the first matching rule stops processing for the file.
If defined, change the extension of the output file. Applied to the final output after resolving all variables.
The pattern for generating output path and file. Use variables to build the pattern. https://localazy.com/docs/cli/variables
The type of the conversion to be performed with files. See docs for available types and their parameters. https://localazy.com/docs/cli/format-conversions#available-conversions
If the type supports more formats for string arrays, you can select the desired one with this parameter.
If the type supports more formats for plurals, you can select the desired one with this parameter.
If the conversion is made between types that support the same format for string arrays, the format is retained unless you explicitly set this parameter to true to force change.
If the conversion is made between types that support the same format for plurals, the format is retained unless you explicitly set this parameter to true to force change.
If the conversion type allows filtering, you can enable this option to filter strings out of the output file.
If the conversion type allows filtering, you can enable this option to filter string arrays out of the output file.
If the conversion type allows filtering, you can enable this option to filter plurals out of the output file.
Some of the conversion types support additional parameters. See documentation for details.
Allows to assign files to groups and run their rules separately.
With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions
If true, no more rules are processed for the given file. Only makes sense if more output rules are defined. By default, the first matching rule stops processing for the file.
The pattern for generating output path and file. Use variables to build the pattern.