Skip to content

Configurations

Anthony Fu edited this page May 5, 2020 · 11 revisions

To start doing configurations, you can go with VS Code built-in setting editor. Or check the detailed explanations below.

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
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

Other Configurations

Check out other sections for their related configs.

Theme

You can customize the annotation color by:

  "i18n-ally.theme.annotation": "rgba(153, 153, 153, .8)",
  "i18n-ally.theme.annotationBorder": "rgba(153, 153, 153, .8)",
  "i18n-ally.theme.annotationMissing": "#d37070",
  "i18n-ally.theme.annotationMissingBorder": "#d37070",

Advanced Configurations

Field Default Description
keyMatchRegex [\w\d\. \-\[\]]*? Regex for keypath matching. Set it to .*? to allow Unicode
disablePathParsing false Enable this if you use natural languages as the key of your locale messages
readonly false Work on read-only mode. Translating and editing will be disabled