** Gulp JSON Translator

An easy way to translate json strings from one language to another.

Why

If you've dealt with internationalization in the front end before you know that waiting to get translations can result in many problems. Use this tool in order to get rough approximations of how verbose languages or very foreign characters look within your app's components. Also for those on a budget, this gives you some level of internationalization without having to pay anyone.

Requirements

You will need to register with Microsoft for a free Azure account and add the translator text api to your account in order to get your free clientId and secret which are needed to access the api. https://azure.microsoft.com/en-us/services/cognitive-services/translator-text-api/

Notes

Despite the name, this could be used without gulp. The initial intention was to use gulp streams to accomplish the translations but I never got around to it. If you have time and want to put up a PR I gladly welcome it. Please note that the microsoft API will be changing soon so I will likely transition this tool to use the Yandex API: https://tech.yandex.com/translate/

Please also note that the module allows for name spacing, but must not have sub name spaces.

This module was originally built to be used with angular-translate, and works seamlessly with it.

Example Usage

1{
2    "sentence": "This is a sentence",
3    "namespace": {
4        "sentenceTwo": "This is a name spaced sentence"
5    }
6}

1
2var translateJson = require('gulp-json-translate');
3
4var configuration = {
5  // Can accept any number of client accounts and will choose
6  // one at random for each translation.
7  clientIds: [
8    {
9      clientId: 'clientId1',
10      secret: 'clientSecret1'
11    },
12    {
13      id: 'clientId2',
14      secret: 'clientSecret2'
15    },
16    {
17      id: 'clientId2',
18      secret: 'clientSecret2'
19    }
20  ],
21  // This will determine the languages that the source file get translated to.
22  locales: [
23      {
24        langCode: 'ar_EG',
25        lang: 'ar'
26      },
27      {
28        langCode: 'de_DE',
29        lang: 'de'
30      }
31  ],
32  masterLanguage: 'en',
33  src: '/app/languages/strings.json',
34  dest: '/app/languages/languages/'
35};
36
37translateJson(configuration);
38

This will result in two files: /app/languages/language-ar_AG containing:

1{
2    "sentence": "وهذا حكم",
3    "namespace": {
4        "sentenceTwo": "وهذا حكم باسم متباعدة"
5    }
6}

and

/app/languages/language-de_DE containing:

1{
2    "sentence": "Dies ist ein Satz",
3    "namespace": {
4        "sentenceTwo": "Dies ist ein Name Abstand Satz"
5    }
6}