@phila/auto-translator-cli

This tool will translate all of the keys in a json object into any other languages that Amazon Translate offers.

It can be found at https://www.npmjs.com/package/@phila/auto-translator-cli.

Installation

To use auto-translator-cli, first install it globally using

npm i -g @phila/auto-translator-cli

Setup

Any project that uses it should, by default, have an i18n folder at the location src/i18n:

This location and folder name can be anything, but the cli questions are set to import and export from src/i18n by default

The english file you import can be a .js file, and it should export a JSON object:

This object MUST

• use "" around all keys and values
• not have any trailing commas after the last entry in a nested object

Branching

The typical way to use this is to be working in a branch where you have branched off from the main branch. Running from there, you will first be comparing your en.js file to the en.js file in the main branch. That way it will only bother translating lines in your current branch's en.js that have changed since your branched off of main.

Note, you do have the chance to set it to compare to any branch, it does not have to be main. The git branch to use for comparison is one of the questions that the CLI will ask.

Use

To run the auto-translator, go to a project's base folder and in the cmd line run:

auto-translator

It will ask 5 questions:

The default answers for those questions will be correct for almost any situation, so unless you are using a special case, you can simply hit enter through all 5 questions to accept the default values.

In some cases an english file may be named en-us.js, and then the default of en.js will have to be overridden. Or you may want to compare your changes to en.js against a branch other than main, and will have to enter the branch name.

Troubleshooting

The input files MUST export a perfect JSON object. The process will break if it reads in a file in which there is a single extra comma, or a missing quotation mark.