Command Line Utils

Load Translation

Download the specified languages of translation files in your project location.

Command line arguments description

Parameter	Type	Value	Description
–directory	string	required	The directory you want to put translations in.
–host	string	required	This is singleton service which provides clients with translations and pattern.
–product	string	required	Product name. For now, singleton service doesn’t explicitly restrict name of product, but it’s better to keep short and sync with the name in release master.
–component	string	required	Component name.
–version	string	required	Release version.
–languages	string	required	Specified the languages your product supports; Separated by , for example, zh-cn,en-US.
–verbose	Don’t need	optional	If set, it will show all information during command execution for debug purpose.

For example

load-translation
  --directory `pwd`/src/app/assets
  --host https://singleton.service.com:8090 // It requires to deploy singleton service
  --product Testing
  --component default
  --version 1.0
  --languages zh-cn,en-US

Config script in package.json

{
    ...
    scripts: {   
        "load-translation": "load-translation 
                            --directory `pwd`/src/app/assets
                            --host <Singleton Service host>
                            --product <product>
                            --component <component>
                            --version <product version>
    }
    ...
}

Use the script

npm run load-translation

Collect Source Bundle

The @singleton-i18n/angular-client provides a script to collect source strings from source bundles. This script collects the collection named ENGLISH from the files named *.l10n.ts, and then send them to the singleton server.

Command line arguments description

Parameter	Type	Value	Description
–source-dir	string	required	The directory your source code in.
–host	string	required	This is singleton service which provides clients with translations and pattern.
–product	string	required	Product name. For now, singleton service doesn’t explicitly restrict name of product, but it’s better to keep short and sync with the name in release master.
–component	string	required	Component name.
–version	string	required	Release version.
–refresh-token	string	optional	Refresh token is only required for the CSP environment.
–verbose	Don’t need value	optional	If set, will show all information during command execution for debug purpose.

Create source bundle

export const ENGLISH = {
    "network-error": 'Network instability.'',
    "data-error": 'Data error.',
    ...
}

Config script in package.json

collect-source-bundle
            --source-dir `pwd`/src/app
            --host https://singleton.service.com:8090 // It requires to deploy singleton service
            --product Testing
            --component Angular
            --version 1.0

{
    ...
    scripts: {   
        "collect-source-bundle": "collect-source-bundle 
                                --source-dir pwd`/src/app 
                                --host <Singleton Service host>
                                --product <product>
                                --component <component>
                                --version <product version>
    }
    ...
}

Use the script

npm run collect-source-bundle

Last updated on 24 Sep 2019
Published on 24 Sep 2019
Edit on GitHub