Neatly Packaged Modules

    @krds/labels

    1.2.2 • Public • Published

    Label Generator for KRDS

    Allows to export translation files for projects via the KRDS Unity API. Designed to support multiple output formats.

    Usage

    For Kite:

    krds-labels --db krds_unity -f kite -o ./application/config/extra
    

    For Lumen:

    krds-labels --db krds_unity -f lumen -o ./resources/lang
    

    For JSON:

    krds-labels --db krds_unity -f json -o ./labels
    
    Option Meaning
    --db Database to export labels from
    -f Output format
    -o Output path. Wether this is a file or directory depends on the format used

    ENV

    You need to set the following ENV variables for it to work

    UNITY_URL=https://unity.krds.com
    UNITY_TOKEN=<my_token>
    

    Formats

    • kite - Single php file lang.php containing all the labels is written into dir specified by -o option. Usually it belongs to application/config/extra
    • kite08 - Alias for kite
    • kite09 - Same as kite but class naming compatible with Kite 0.9 and 'Kilex' codebase
    • kilex - Alias for kite09
    • lumen - Output for Lumen framework, one folder/php file per locale
    • json - Renders labels into json files, one file per locale, useful for NodeJS apps

    Extending

    • For each new format, create a new module in lib (see lib/kite.js for reference)
    • Extend index.js to recognize the new format

    TODO

    • Additional formats

    Keywords

    Install

    npm i @krds/labels

    DownloadsWeekly Downloads

    30

    Version

    1.2.2

    License

    ISC

    Unpacked Size

    12.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • krds