GitHub - mololab/json-translator: This package & CLI will provide you to tra...
source link: https://github.com/mololab/json-translator
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
FREE JSON TRANSLATOR
This package will provide you to translate your JSON files or objects into different languages FREE.
Types of usages
-
CLI (Supports Google Translate, Bing Microsoft Translate, Libre Translate, Argos Translate)
-
In code (Node.js) as a package (Supports only Google Translate)
Browser support will come soon...
Install
npm i @parvineyvazov/json-translator
- OR you can install it globally (in case of using CLI)
npm i -g @parvineyvazov/json-translator
CLI
jsontt folder/file.json
Usage
1. Translate a word | sentence
- Import the library to your code.
For JavaScript
const translator = require('@parvineyvazov/json-translator');
For TypeScript:
import * as translator from '@parvineyvazov/json-translator';
// Let`s translate `Home sweet home!` string from English to Chinese
const my_str = await translator.translateWord(
'Home sweet home!',
translator.languages.English,
translator.languages.Chinese_Simplified
);
// my_str: 家,甜蜜的家!
2. Translate JSON object (supports deep objects)
- Import the library to your code
For JavaScript
const translator = require('@parvineyvazov/json-translator');
For TypeScript:
import * as translator from '@parvineyvazov/json-translator';
/*
Let`s translate our deep object from English to Spanish
*/
const en_lang: translator.translatedObject = {
login: {
title: 'Login {{name}}',
email: 'Please, enter your email',
failure: 'Failed',
},
homepage: {
welcoming: 'Welcome!',
title: 'Live long, live healthily!',
},
profile: {
edit_screen: {
edit: 'Edit your informations',
edit_age: 'Edit your age',
number_editor: [
{
title: 'Edit number 1',
button: 'Edit 1',
},
{
title: 'Edit number 2',
button: 'Edit 2',
},
],
},
},
};
/*
FOR JavaScript don`t use translator.translatedObject (No need to remark its type)
*/
let es_lang = await translator.translateObject(
en_lang,
translator.languages.English,
translator.languages.Spanish
);
/*
es_lang:
{
"login": {
"title": "Acceso {{name}}",
"email": "Por favor introduzca su correo electrónico",
"failure": "Fallida"
},
"homepage": {
"welcoming": "¡Bienvenidas!",
"title": "¡Vive mucho tiempo, vivo saludable!"
},
"profile": {
"edit_screen": {
"edit": "Edita tus informaciones",
"edit_age": "Editar tu edad",
"number_editor": [
{
"title": "Editar número 1",
"button": "Editar 1"
},
{
"title": "Editar número 2",
"button": "Editar 2"
}
]
}
}
}
*/
3. Translate JSON object into Multiple languages (supports deep objects)
- Import the library to your code
For JavaScript
const translator = require('@parvineyvazov/json-translator');
For TypeScript:
import * as translator from '@parvineyvazov/json-translator';
/*
Let`s translate our object from English to French, Georgian and Japanese in the same time:
*/
const en_lang: translator.translatedObject = {
login: {
title: 'Login',
email: 'Please, enter your email',
failure: 'Failed',
},
edit_screen: {
edit: 'Edit your informations',
number_editor: [
{
title: 'Edit number 1',
button: 'Edit 1',
},
],
},
};
/*
FOR JavaScript don`t use translator.translatedObject (No need to remark its type)
*/
const [french, georgian, japanese] = (await translator.translateObject(
en_lang,
translator.languages.Automatic,
[
translator.languages.French,
translator.languages.Georgian,
translator.languages.Japanese,
]
)) as Array<translator.translatedObject>; // FOR JAVASCRIPT YOU DO NOT NEED TO SPECIFY THE TYPE
/*
french:
{
"login": {
"title": "Connexion",
"email": "S'il vous plaît, entrez votre email",
"failure": "Manquée"
},
"edit_screen": {
"edit": "Modifier vos informations",
"number_editor": [
{
"title": "Modifier le numéro 1",
"button": "Éditer 1"
}
]
}
}
georgian:
{
"login": {
"title": "Შესვლა",
"email": "გთხოვთ, შეიყვანეთ თქვენი ელ",
"failure": "მცდელობა"
},
"edit_screen": {
"edit": "თქვენი ინფორმაციათა რედაქტირება",
"number_editor": [
{
"title": "რედაქტირების ნომერი 1",
"button": "რედაქტირება 1"
}
]
}
}
japanese:
{
"login": {
"title": "ログイン",
"email": "あなたのメールアドレスを入力してください",
"failure": "失敗した"
},
"edit_screen": {
"edit": "あなたの情報を編集します",
"number_editor": [
{
"title": "番号1を編集します",
"button": "編集1を編集します"
}
]
}
}
*/
4. Translate JSON file (supports deep objects)
- Import the library to your code.
For JavaScript
const translator = require('@parvineyvazov/json-translator');
For TypeScript:
import * as translator from '@parvineyvazov/json-translator';
/*
Let`s translate our json file into another language and save it into the same folder of en.json
*/
let path = 'C:/files/en.json'; // PATH OF YOUR JSON FILE (includes file name)
await translator.translateFile(
path,
translator.languages.English,
translator.languages.German
);
── files
├── en.json
└── de.json
5. Translate JSON file into Multiple languages (supports deep objects)
- Import the library to your code.
For JavaScript
const translator = require('@parvineyvazov/json-translator');
For TypeScript:
import * as translator from '@parvineyvazov/json-translator';
/*
Let`s translate our json file into multiple languages and save them into the same folder of en.json
*/
let path = 'C:/files/en.json'; // PATH OF YOUR JSON FILE (includes file name)
await translator.translateFile(path, translator.languages.English, [
translator.languages.Cebuano,
translator.languages.French,
translator.languages.German,
translator.languages.Hungarian,
translator.languages.Japanese,
]);
── files
├── en.json
├── ceb.json
├── fr.json
├── de.json
├── hu.json
└── ja.json
6. Ignore words
To ignore words on translation use {{word}}
OR {word}
style on your object.
{
"one": "Welcome {{name}}",
"two": "Welcome {name}",
"three": "I am {name} {{surname}}"
}
...translating to spanish
{
"one": "Bienvenido {{name}}",
"two": "Bienvenido {name}",
"three": "Soy {name} {{surname}}"
}
-
jsontt also ignores the
URL
in the text which means sometimes translations ruin the URL in the given string while translating that string. It prevents such cases by ignoring URLs in the string while translating.- You don't especially need to do anything for it, it ignores them automatically.
{
"text": "this is a puppy https://shorturl.at/lvPY5"
}
...translating to german
{
"text": "das ist ein welpe https://shorturl.at/lvPY5"
}
7. CLI commands
- translate
jsontt file.json
jsontt folder/file.json
jsontt "folder\file.json"
jsontt "C:\folder1\folder\en.json"
- with proxy
jsontt file.json proxy.txt
Result will be in the same folder as the original JSON file.
jsontt -h
jsontt --help
Roadmap
Translate a word | sentence
- for JSON objects
Translate JSON object
Translate deep JSON object
Multi language translate for JSON object
- Translate JSON object with extracting OR filtering some of its fields
- for JSON files
Translate JSON file
Translate deep JSON file
Multi language translate for JSON file
-
Translate JSON file with extracting OR filtering some of its fields
-
General
CLI support
Safe translation (Checking undefined, long, or empty values)
Queue support for big translations
Informing the user about the translation process (number of completed ones, the total number of lines and etc.)
Ignore value words in translation (such as ignore {{name}} OR {name} on translation)
Libre Translate option (CLI)
Argos Translate option (CLI)
- Bing Translate option (CLI)
Ignore URL translation on given string
-
Libre Translate option (in code package)
-
Argos Translate option (in code package)
-
Bing Translate option (in code package)
-
Sync translation
-
Browser support
License
@parvineyvazov/json-translator will be available under the MIT license.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK