Helper utility designed to make it easy to upload react-intl extracted messages to transifex, with support for ICU plurals and translator comments.
There are two modes of usage - compilation and comment pushing.
In this mode, messages that have been extracted by
babel-plugin-react-intl (into individual files) are combined. The resulting json is suitable to upload to Transifex and matches their specified
$(npm bin)/reactifex <input_folder> <output_file>
input_foldercorresponds to the
messagesDiroption used by
- note that reactifex assumes folder structure based on this default
output_filewill be suitable for upload to transifex
This mode is why I wrote this library in the first place - I wanted the ability to use comments as
PO files do, but none of the tools I found to convert react-intl messages to
PO files were able to properly handle ICU pluralization. By keeping everything in a js context with
KEYVALUEJSON, plurals work correctly and we now have comment support for translators (by default, Transifex's
KEYVALUEJSON file format does not allow for comments to be included with strings for translation).
Usage is a little complicated, I'm sorry about that; you're going to be running this server-side as a series of bash commands. Do note that I assume
$SECRET_PWD env vars exist for basic auth purposes. See Transifex's API Introduction for more details on authentication. Here's an example, written as it would be in the Makefile of a project that makes use of reactifex:
tx_url1 = https://www.transifex.com/api/2/project/<project>/resource/<resource>/translation/<default_language_code>/strings/ tx_url2 = https://www.transifex.com/api/2/project/<project>/resource/<resource>/source/ push_translations: ./node_modules/reactifex/bash_scripts/get_hashed_strings.sh $(tx_url1) $$(npm bin)/reactifex <input_folder> --comments ./node_modules/reactifex/bash_scripts/put_comments.sh $(tx_url2)
bash_scripts/get_hashed_strings.shis called with a url argument. This will populate
bash_scripts/hashmap.jsonwith data about the strings in your resource, including the all-important
Next, the main reactifex script (node js) runs with an additional
--commentsflag, and no output file. This has the effect of gathering up all your
babel-plugin-react-intlextracted messages with their comments attached. From there, it's simple enough to match up each message with its
string_hash, and save these pairs in a '|'-delimited list, for later consumption.
bash_scripts/put_comments.shis run with the base PUT url as an argument (also reads the data file we created in the previous step), updating translator comments for each message on Transifex via their API.