Skip to content

A CLI for uploading native phrases and downloading reviewed translations from Swiftyper platform.

License

Notifications You must be signed in to change notification settings

swiftyper-sk/node-fbt-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FBT

FBT sync

This library allows you to import native phrases (or your current translations) and deploy reviewed translations.

Get started with Swiftyper Translations

📦 Installing

# as a dev dependency (recommended)
$ npm install --save-dev fbt-sync

# as a global package
$ npm install --global fbt-sync

The installed binary is named fbt-sync. You can execute it directly in node_modules/.bin/fbt-sync or using npx (with or without installation) like npx fbt-sync.

🔧 Configuration

These steps are required:

  1. Register your FBT project on Swiftyper Translations

  2. Init project settings:

    $ ./node_modules/.bin/fbt-sync --init
    # or
    $ npx fbt-sync --init

Options

The CLI will not prompt for an API key if a value is provided in the environment variable SWIFTYPER_API_KEY or defined in .env file.

Option Description
--deploy Deploy reviewed app translations
--upload-translations Upload translations to swiftyper
--upload-phrases Upload native phrases to swiftyper
--init Connect fbt project with swiftyper
--pretty Pretty print output for translations file
--path Path where to store translations e.g. ./src/

📜 License

The MIT License (MIT). Please see LICENSE for more information.