Configurations

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
`extract.keygenStrategy`	`slug`	Strategy of generating the keypath. Can be `slug`, `random` or `empty`
`extract.keyPrefix`	''	String prepend to the extracting key.
`extract.targetPickingStrategy`	none	Strategy dealing with situation that more than one locale files found. `none`: User manually select which file to write extracted text to. `most-similar`: Automatically extract text to the file which path most matches to current file's path. `file-previous`: Extract text to current file's previous selected locale file. `global-previous`: Extract text to (current or other) file 's previous selected locale file.

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
`regex.key`	`[\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

Maintained by

^{Lokalise is the fastest growing language cloud technology made by developers, for developers.

As a collaborative productivity platform, it helps structure and automate the translation and localization process for any company in the world.

Learn more}