Skip to content

Add or Improve Language Support

YunChaoTsai edited this page Sep 2, 2019 · 3 revisions

Where are the language files?

All language files should be placed at the extension root folder. They should also follow the following naming scheme: package.nls.<language>.json

Currently supported languages:

  • English (en)
  • Simplified Chinese (zh-CN)
  • Traditional Chinese (zh-TW)
  • French (fr)
  • German (de)
  • Italian (it)
  • Spanish (es)
  • Japanese (ja)
  • Korean (ko)
  • Russian (ru)
  • Bulgarian (bg)
  • Hungarian (hu)
  • Portuguese (pt-br)
  • Turkish (tr)

package.nls.json is the default localization file if your language is not supported.

How to support my language?

  1. Find your language id here (e.g Japanese > ja, Korean > ko).

  2. Fork the Settings Sync repository and start debugging it in VSCode

  3. Copy package.nls.json and rename it to package.nls.<your-language>.json.

  4. Update the values to accommodate for your language in the new file.

  5. Restart the extension and make sure everything works properly.

  6. Follow the Localization Checklist.

  7. Open a Pull Request and let me know. I will release a new version with support for your language.

Localization Check List

  1. The language file is a single key-value JSON object.
  2. Both keys and values must be strings. No null/number/array/object.
  3. Use the camel case naming convention for keys. (e.g doSomething)
  4. Similar keys should be positioned near each other.