Vue i18n Ally

🌍 Better Vue i18n experiences with VSCode

⚡ Features

• Inline annotation
• i18n key autocomplete
• Friendly UI for managing locales
• One-click machine translation
• Extract text from code
• JSON and YAML supported
• Multi-root workspace
• Translating progress
• Supporting both vue-i18n, vuex-i18n and vue-i18next

⚙ Installation

1. Install vue-i18n package if you haven't yet. npm i vue-i18n or yarn add vue-i18n
2. Install this extension
3. locales path will be detected automatically. You can also configure it manually. There are two ways to do that:
   • Open Command Palette (Ctrl-Shift-P or ⌘⇧P), type Vue i18n Ally: Manual configure locales path then press enter and follow the guide.
   • Modify the settings.json file of your VSCode, adding vue-i18n-ally.localesPath manually.

📂 Directory structure

You can have locales directory structured like this

  locales         # you can specify the folder path in the settings
  ├── en.json
  ├── de-DE.json
  ├── zh-CN.yaml  # YAML is also supported
  ├── zh-TW.yaml
  ├── ...
  └── <contry-code>.json

or

  locales
  ├── en
  |   ├── common.json
  |   ├── buttons.json
  |   ├── ...
  |   └── <filenames>.json
  ├── de-DE
  |   ├── common.json
  |   ├── buttons.json
  |   └── ...
  └── <contry-code>
      ├── common.json
      ├── buttons.json
      └── ...

Currently we support json or yaml as your locales file type.

If you would like use different file formats or directory structures, it welcome to open an issue or pull request.

📅 TODO

• Machine translating
• Locales Tree
• Translating progress
• Workspace support
• Underscore for i18n keys?
• YAML support
• $tc, $d, $n, v-t support
• Hide/Show specific locales
• Screenshots
• Language flags
• Vue inlined locales support
• Source language indicator
• Analysis report
• JSON/YAML file annonation & hint
• Annoation config (on/off, maxlength)
• Force enabled on non-vue-i18n project
• i18n for the plugin itself
• .js locales
• tests

👨‍💻 Credits

This extension is original forked from think2011/vscode-vue-i18n, it can't be existed without @think2011's great work.

License

MIT License © 2019 Anthony Fu

MIT License © 2018-2019 think2011