i18next-google-translate
This tool allows you to automatically translate a locale folder containing multiple
JSON files into multiple languages using Google Translate. You can either use the
translation keys (natural translation) or their values (key-based translation)
as a source for translations.
If some of the strings have already been translated, they won't be translated
again. This improves performance and ensures that you won't accidentally lose
existing translations.
ICU MessageFormat parts (e.g. {name}
) aren't passed to Google Translate so
their structure doesn't get mangled by the translation.
Prerequisites
To use this tool with Google Translate, you need to obtain valid credentials from
Google. Follow these steps to get them:
You can specify the location of your downloaded JSON key file using the
GOOGLE_APPLICATION_CREDENTIALS
environment variable, either by setting
it in your shell or by adding it to your .env
file.
Installation
$ yarn add i18next-google-translate
Directory Structure
Your locales
directory should look like this:
locales
├── de
├── en
│ ├── login.json
│ └── register.json
├── fr
└── it
If you don't specify another source language, this tool will translate all files
located in the en
into all other languages that exist as directories. A single
language directory (e.g. en
) should only contain JSON files. Sub-directories and
other files will be ignored.
File Structure
There are two ways that i18next-google-translate can interpret files:
Natural Language
This is the default way that this tool will interpret your source files. The keys
will be used as the basis of translations. If one or more of the values in your
source files don't match their respective key, you'll see a warning as this could
indicate an inconsistency in your translations. You can fix those inconsistencies
by passing the --fix-inconsistencies
flag.
{
"Your username doesn't exist.": "Your username doesn't exist.",
"{email} is not a valid email address.": "{email} is not a valid email address."
}
Key-Based
If you pass the --key-based
flag, this tool will use the source file's values
as the basis of translations. Keys can be nested, the structure will be transfered
over to the translated files as well.
{
"ERRORS": {
"USERNAME": "Your username doesn't exist.",
"EMAIL": "{email} is not a valid email address."
},
"LOGIN": "Login",
"FORGOT_PASSWORD": "Forgot password?"
}
Available Services
As of this release, i18next-google-translate offers three services:
- googleTranslate (default, uses Google Translate to translate strings)
- manual (allows you to translate strings manually by entering them into the CLI)
- dryRun (outputs a list of strings that will be translated without touching any files)
You can select a service using the -s
or --service
flag.
Available Parameters
Options:
-i, --input <inputDir> the directory containing language directories (default: ".")
-l, --source-language <sourceLang> specify the source language (default: "en")
-s, --service <service> selects the service to be used for translation (default: "googleTranslate")
--list-services outputs a list of available services
-k, --key-based uses the template file's values instead of the keys as translation source
-f, --fix-inconsistencies automatically fixes inconsistent key-value pairs by setting the value to the key
-d, --delete-unused-strings deletes strings in translation files that don't exist in the template
-h, --help output usage information
Contributing
If you'd like to contribute to this project, please feel free to open a pull request.