Skip to content

Configurations

Anthony Fu edited this page Apr 14, 2020 · 11 revisions

Common Configurations

All fields must be prefixed with "i18n-ally." in settings.

Field Default Description
sourceLanguage en The primary locale for the project. It will also be the source language when translating
displayLanguage en Display language in annotations and tree views
localesPaths auto Locales directory path, relative to the root of your project. It can also be an array of paths. Glob patterns are acceptable
sortKeys false Sort keys alphabetically when saving
keystyle auto Key style in your locale files. Can be flat({"a.b.c": "..."}) or nested({"a": {"b": {"c": "..."}}})
annotations true Enable inline annotations
keepFulfilled false Always keep all keys fulfilled with empty strings
enabledFrameworks auto Specify the supported framework(s) to enable. If no value is set, the extension will detect frameworks automatically
enabledParsers auto Locale file format parsers. By default, It will be handled by activated frameworks
indent 2 Indentation size for your locale files
tabStyle space Tab style for your locale files

Advanced Configurations

Field Default Description
namespace false Enable namespacing of keys by filename/directory structure. More details
pathMatcher null Allows you to map the custom filename/namespace. More details.
keyMatchRegex [\w\d\. \-\[\]]*? Regex for keypath matching. Set it to .*? to allow Unicode
promptTranslatingSource false Prompt to select the source locale on translating every time. If set to false, the source language in the config will be used
disablePathParsing false Enable this if you use natural languages as the key of your locale messages
encoding utf-8 File encoding for reading and writing locale files. Set to auto to let it decide for you.
readonly false Work on read-only mode. Translating and editing will be disabled