Giter VIP home page Giter VIP logo

ios_translator's Introduction

demonstration1.png

demonstration2.png

Install

    npm install ios_translator

Description

  • Translation is executed upon Google Cloud.
  • Translation quality wholly depends on Google Translate API
  • Generate localizable.strings

Features

  • translate

    • translate single word or phrase or sentence
  • listAvailableLanguages

    • fetch all available language lists for translation
    • returns json objects list for customization
  • generateLocalizableStrings

    • generate localizable.strings for various languages
    • returns json objects list for cutomization

Prepare

  • localizable.strings must be provided as input

demo.png

Usage

const fs = require("fs");
const iosTranslator = require("ios_translator");

const jsonData = fs.readFileSync(
  "./your_google_service_account_credential.json"
);
const credential = JSON.parse(jsonData);

iosTranslator.configure({
  googleApiCredential: credential,
  googleApiProjectId: credential.project_id,
  log: false,
});

const options = {
  input: "./path/to/localizable.strings",
  output: "./path/to/yourdirectory",
  from: "en",
  to: ["de", "fr"],
};

async function main() {
  const translatedJSON = await iosTranslator.generateLocalizableStrings(
    options
  );
}

main();

Configure

  1. Create your google account
  2. Enable Google Translate API
  3. Create Service Account
  4. Get json credential
const fs = require("fs");
const iosTranslator = require("ios_translator");

const jsonData = fs.readFileSync(
  "./your_google_service_account_credential.json"
);
const credential = JSON.parse(jsonData);

iosTranslator.configure({
  googleApiCredential: credential,
  googleApiProjectId: credential.project_id,
  log: false,
});

generateLocalizableStrings

  • Options

    • input => where your original file is

    • output => where your output files will be

    • from => indicate your original language

      example) "hello world" is english

    • to => provide your target languages

      example) if you provide these languages, ["de", "fr"], your localizable.strings will be translated into german and french

const fs = require("fs");
const iosTranslator = require("ios_translator");

const jsonData = fs.readFileSync(
  "./your_google_service_account_credential.json"
);
const credential = JSON.parse(jsonData);

iosTranslator.configure({
  googleApiCredential: credential,
  googleApiProjectId: credential.project_id,
  log: false,
});

const options = {
  input: "./path/to/localizable.strings",
  output: "./path/to/yourdirectory",
  from: "en",
  to: ["de", "fr"],
};
const translatedJSON = await iosTranslator.generateLocalizableStrings(options);

Code Example - all features

// Configure
const fs = require("fs");
const iosTranslator = require("ios_translator");

const jsonData = fs.readFileSync(
  "./your_google_service_account_credential.json"
);
const credential = JSON.parse(jsonData);

iosTranslator.configure({
  googleApiCredential: credential,
  googleApiProjectId: credential.project_id,
  log: false,
});

// returns 'bonjour'
const result = await iosTranslator.translate("hello", { from: "en", to: "fr" });

// returns objects (available languages for translation), [{ code: 'tk', name: 'Turkmen' }, { code: 'uk', name: 'Ukrainian' },]
const result = await iosTranslator.listAvailableLanguages();

// returns objects and generate `localizable.strings`
// Object will look like this
/*
    {
        "ko": {
            "key": "hello",
            "value": "안녕하세요"
        }
    }
*/
const options = {
  input: "./path/to/localizable.strings",
  output: "./path/to/yourdirectory",
  from: "en",
  to: ["de", "fr"],
};
const translatedJSON = await iosTranslator.generateLocalizableStrings(options);

ios_translator's People

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.