vue-i18n-poeditor (short named VIP)

This is a suite of direct and simple helper commands to keep your POEditor project synced with your VueJS component translations.

It currently only supports i18n tags inside .vue files. Feel free to send me any pull requests for additional functionality or fixes.

Installation

npm install vue-i18n-poeditor --save

Configuration

Start by copying the poeditor-sample.json file to poeditor.json like this:

cp poeditor-sample.json poeditor.json

Then edit it's content with your own values:

{
	"id": "",
	"api_token": "",
	"root": "./src",
	"locales": [
		"en",
		"fr"
	]
}

• id: The POEditor project ID which you can find in your Account Settings in the API Access section.
• api_token: Your private POEditor API token which you can find in your Account Settings in the API Access section.
• root: The root folder into which VIP will look for .vue files.
• locales: Enter the list of translations locales you have in your VueJS project as specified in POEditor.

Commands

Synchronize terms in POEditor

Should only be ran when new i18n terms are created or removed.

Warning, you can lose translations if some tags are renamed or deleted. The master of synced tags is the VueJS code. Any tag gone from the code will be removed from POEditor. If unsure, use the backup script first.

node node_modules/vue-i18n-poeditor/sync.js

Send translations to POEditor

This will send and create or update translations in POEditor from your VueJS code.

node node_modules/vue-i18n-poeditor/send.js

Receive translations from POEditor

This will update your VueJS code with updated transalations made in POEditor. Warning, this will overwrite your i18n tags inside all of your components.

node node_modules/vue-i18n-poeditor/receive.js

Backup POEditor project

This will output the full data of the configured POEditor project. You can use this to backup POEditor and avoid any loss.

node node_modules/vue-i18n-poeditor/backup.js

Restore POEditor project

This will restore a previous backup.

Coming soon...