polygotpt v1.0.0

PolygotPT (Polyglot Phrase Translater)

Who This Tool is Best Suited For

• Users of PolygotPT will most likely be using this tool alongside Polyglot to create Phrase objects.
• Users who want to perform a translation from one phrase to multiple languages

Who this Tool is Not Suited For

If you need to perform a single phrase translation from one language to another it's best to use Google's Translate web interface or google-cloud/translate client libraries.

Description

A command-line tool to Google translate a phrase or an object of phrases from one language to one or more languages. PolyglotPT is a library specifically used for Polyglot. This tool can take a file with a single object of deeply-nested keys and provide translations for all it's values.

For example, this object of English phrases:

module.exports = {
  nav: {
    title: 'Navigation Title',
    description: 'Navigation Description',
  },
  title: 'Main Title',
}

Given to PolygotPT with the options --to=es (Spanish) will be translated to:

module.exports = {
  'nav.title': 'Titulo principal',
  'nav.description': 'Título de navegación',
  'title': 'Navegación Descripción',
}

As you can see you can have a very deeply nested object of Polyglot Phrases that need translations! You can then take this outputted object and provide it to Polyglot to translate.

Dependencies

• commander
• google-translate-api

Installation

• install with npm install -g ppt

Usage

Translate a phrase

Translate a single phrase to one or more languages to the console:

ppt --phrase=<phrase> --from=<language> --to=<language[,language]>

Translate an object of phrases

Translate an input file with an exported object:

ppt --input=<file> --from=<language> --to=<language>

Translate an object of phrases but ignore all phrases that contain the ignoreToken value

Translate an input file of an exported object but ignore any values that contain the ignoreToken option. In Polyglot there are interpolation variables such as ${} that Google Translate fails to translate. All ignored values will be outputted to the console. These unfortunately must be translated another way.

ppt --input=<file> --from=<language> --to=<language> --ignoreToken=<token>

Contributions

I'd be happy to accept PR's but please open a ticket (if it doesn't exist already) to discuss the bug, request, concern, questions, etc.

To-Do

• Write tests... of course!
• replace google-translate-api with Google's google-cloud/translate library. This will require client's to provide their own Google Developer keys and secret.