Package Exports

hokeylization
hokeylization/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hokeylization) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hokeylization

The name is a portmanteau, meaning 'hokey localization'

It's hokey because it's very simple: it runs some strings against Google Translate

You can translate:

a JavaScript object containing messages
a directory of files, recursively

Source

Setup

Set the GOOGLE_TRANSLATE_PROJECT_ID env var to identify your project

Set the GOOGLE_APPLICATION_CREDENTIALS env var to the JSON credentials you downloaded after navigating the holy hell that is figuring out authentication on Google cloud

If you're running from source, you can also put these in a .env file in the source directory they'll be loaded at runtime via dotenv

Translating a JavaScript string resource file

Your string table must be in a JavaScript file in the form:

export default {
  string_key: "some value",
  another_key: "another value",
  ... more keys ...
}

If this file was named myfile.js, you can translate it to Spanish with:

hokey -l es -o myfile.es.js myfile.js

For the -l / --language option, you can use any 2-letter language code supported by Google Translate

Translating a directory of text files

You can also translate a directory, hokey will recursively visit every file in the directory and run its contents through Google Translate, and save the output to an identically named file in a separate directory tree

When the target of your translation is a directory, this mode is enabled

The -o / --outfile option specifies the output directory

BIG WARNING: When translating directories, DO NOT specify an output directory that is within your input directory! If you do, you will:

induce infinite recursion
run up your Google bill
fill up your disk
have less fun

Here is an example of what not to do:

hokey -l es -o templates/es templates    # <--- DON'T DO THIS!

When this runs, translated files are written to templates/es, and thus become new source files to translate, since they are under templates/ -- this process continues forever, don't do it!

OK, let's say you have some email templates in a directory:

templates/email/en/welcome.txt
templates/email/en/welcome.html
templates/email/en/verify-account.txt
templates/email/en/verify-account.html
templates/email/en/reset-password.txt
templates/email/en/reset-password.html

To translate all of these to Spanish, run:

hokey -l es -o templates/email/es templates/email/en

What happens when the above runs:

The templates/email/es will be created if it doesn't exist
Every file in templates/email/en will be translated
You'll end up with an identical directory structure under es that you have under en

hokeylization