Repo officially moved to https://github.com/smodin-io/chargebee-languages and is now maintained by Smodin.io
Chargebee allows a certain number of languages out of the box (https://www.chargebee.com/docs/supported-locales.html), roughly 6. There are, however, around 30 supported by chargebee which you can choose to translate yourself (https://www.chargebee.com/docs/configure-multiple-languages.html). Here is a simple node package to translate those languages easily and efficiently.
There is a sample provided for all the languages that are machine translated that are free for you to use. These do not include mandatory folders or those CSV files. You will need to run TranslateChargebee.js after adding your mandatory folders. There are no guarantees the translations are correct, as they were made by a machine translator.
First: copy your language pack, place it in a folder named project-languages. You don't need all the supported languages, it will only copy over the languages you support in the project folder
Second: update translated values, run npm run update-project-folder to update all the missing values with their corresponding values from chargebee-languages which are already translated
(optional) Third: translate your left over values, follow Option 2, but use the LANGUAGE_FOLDER=project-languages config in step 3 like LANGUAGE_FOLDER=project-languages npm run translate. This will translate the remaining values missing (including your mandatory folders)
First: Config, edit the config in TranslateChargebee.js if the defaults don't work for you. FYI there is around 2250 keys to translate per blank language.
/* Config Options */
const config = {
folders, // array of language folders you want to include such as ['vi', 'zh']
ignoreKeys, // array of keys to ignore (runs before inclusion logic)
updateKeys, // array of keys to include
ignoreFiles, // default to some CSV files in mandatory directory. array of CSV files to ignore (runs before inclusion logic)
updateFiles, // array of CSV files to include
useTranslatedValuesIfAvailable, // Default to true, uses already translated value to avoid running translation fn() again
ignoreIfValue, // Default to true, if you want to re-translate all values, set this to false
reviewBadTranslations, // Defaults to true, if we notice an html or variable mishap, we will put in a separate review file
translator, // translator.js function
logs, // defaults to false
concurrentTranslations, // defaults to 3
replacements, // defaults to recommendedReplacements in /utils/constants, use this to replace text which may not translate well, i.e. { 'excl.': 'exclusive' }
ignoreValues, // defaults to recommendedIgnoreValues in /utils/constants, use this to ignore text that shouldn't be translated like VAT or {0}
warnIfValuesTranslated, // defaults to recommendedWarnIfValuesTranslated in /utils/constants, use to check text and translation counts match such as 3D or @$!%*#?&()
}
// example config usage
runTranslation({
translator,
logs: true,
folders: ['bg'],
updateFiles: ['hosted_privacy_settings.csv'],
updateKeys: ['static.hosted_pages_setting.tos_url_label'],
})
// use to get recommended constant values if you need them
const {recommendedReplacements, recommendedIgnoreValues, recommendedWarnIfValuesTranslated} = require('./utils/constants)Second: Translator, add a translator.js file for your translator. There are many simple to use packages. The function should look like so:
module.exports = async ({ to, from, text }) => {
/*... translate stuff ... */
return translatedText
}Third: language export, if you wish, replace the chargebee-languages folder with your languages. If you prefer a different directory, add the env variable LANGUAGE_DIRECTORY such as LANGUAGE_DIRECTORY=my_folder. Note: mandatory folders aren't pushed to the repo, you need to add yours manually.
Fourth: run to Translate, run it with the command npm run translate which runs the TranslateChargebee.js file
Fifth: Review, check on your translations to review and error translations located in the chargebee-languages/<relevant_language> as UNREVIEWED_TRANSLATIONS.json and FAILED_TRANSLATIONS.json. In the UNREVIEWED_TRANSLATIONS.json change the translation value. This will be used in the next step.
Sixth: Save reviewed, after you've reviewed the UNREVIEWED_TRANSLATIONS.json and edited all the translation values, run npm run save-reviewed to save the now reviewed translations.
Seventh: Delete reviewed and failed, run npm run delete-reviews to delete the UNREVIEWED_TRANSLATIONS.json and FAILED_TRANSLATIONS.json in all the language directories.
There are a list of keys there exceed the 500 character upload limit imposed by chargebee:
{ key: 'hp_v3.pm.agreement.gocardless_autogiro9', length: 577 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro3', length: 518 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro4', length: 520 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro1', length: 1076 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro7', length: 564 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro8', length: 562 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro6', length: 923 },
{ key: 'hp_v3.pm.agreement.cybersource_ach1', length: 1063 },
{ key: 'hp_v3.pm.agreement.gocardless_becs_nz_terms_condition', length: 1392 },
{ key: 'hp_v3.pm.agreement.gocardless_becs_terms_condition', length: 6003 },
{ key: 'hp_v3.pm.agreement.gocardless_autogiro10', length: 561 }And two that are close:
{ key: 'hp_v3.pm.agreement.stripe_sepa', length: 482 },
{ key: 'hp_v3.pm.agreement.gocardless_becs_4', length: 468 }It may be worth ignoring these incase the translations come in over 500 characters leaving you unable to upload.
(This may be fixed, it's fixed on my account) Currently restricted to 1MB unzipped size and 2MB zipped size. These limits need to be increased to 12MB and 3MB minimally, respectively. I've opened a ticket for this to be increased and will update the repo accordingly.
There are a few keys which are created in duplicate by Chargebee incorrectly. You may want to manually remove them. They're in tax_validation_options.csv. You can use the command npm run remove-duplicate-keys which will only include this file, you can add more if necessary.
The file reason_codes.csv has keys that don't match live vs test environment. For example, dy.subscription_cancellation.16CKpzSRTq5be683 can have the last segment of the key slightly different in live, and throws "new" key errors. Thus, if you are using the project-folder for your test keys, to update them to the appropriate live keys, you will need to use the function npm run fix-mismatched-keys. It will take the prod key names from a folder named live-project-languages and update them in project-languages.
- Uploading a failed file will not overwrite the current file; you will not lose your current language zip file
- You can upload with missing language directories, it will not error
- after you upload, you no longer see a "download language pack" button. You can now only download using the "download" button next to your language pack file name. If you add languages, they will be in this pack.
- If you delete a language, the translations will be saved, but no longer come from the download pack. When you activate it again, you will see it still translated (chargebee saves your translations)
- You cannot upload new keys that don't exist
- You cannot upload over 500 characters (currently)
- Upload zip size has caps (might not be an issue any longer)
| Symbol / folder name | language name | translation method | notes |
|---|---|---|---|
| bg | automated translation | ||
| cs | automated translation | ||
| da | automated translation | ||
| de | automated translation | ||
| es | automated translation | ||
| et | automated translation | ||
| fi | automated translation | ||
| fr | automated translation | ||
| hu | automated translation | ||
| id | automated translation | ||
| it | automated translation | ||
| ja | automated translation | ||
| ko | automated translation | ||
| lt | automated translation | ||
| lv | automated translation | ||
| nl | automated translation | ||
| no | automated translation | ||
| pl | automated translation | ||
| pt | automated translation | ||
| ro | automated translation | ||
| ru | automated translation | ||
| sk | automated translation | ||
| sl | automated translation | ||
| sv | automated translation | ||
| th | automated translation | ||
| tr | automated translation | ||
| uk | automated translation | ||
| vi | automated translation | ||
| zh | automated translation |
Open an issue and make a corresponding PR. It will get reviewed within a couple days.