@first-lego-league/dev-launcher

DevL (Dev-Launcher)

A launcher simulation to run modules independently during development

Features

• Running mhub process
• Injecting environment variables
• Sending module configurations updates

Basic usage

In your module directory, use the devl command before the server command, e.g,:

devl

For more options:

--port, -p <port>                              In which port to open the primary module. Default to: 3000
--log-level, -L <logLevel>                     In which port to open the primary module
--data-directory, -d <dataDirectory>           Directory to store service data. Default to: ./data
--secondary-modules, -s <secondaryModule>      Module's url to pass to the primary module in the format "#module_name#=#origin#
--config-file <configFile>                     The config file for the primary module. Default to: ./module-config.json
--mongo-uri <mongoUri>                         The mongo uri for the primary module. Default to: mongodb://localhost:27017/##module-name##
--secret <secret>                              The secret token. Default: secret
--mhub-pass <mhubPass>                         The mhub protected password
--no-color                                     Disable colors
--inspect [host:port]                          Adding node --inspect options to the node process. Works only when module command omitted
--inspect-brk [host:port]                      Adding node --inspect-brk options to the node process. Works only when module command omitted

Changing module config

When the DevL is running it's watching a module config file module-config.json (or otherwise if specified). The file is created automatically if not already exists. Any change to the file will send the new configuration to the primary module.

Adding secondary modules

When needed to pass the primary module a environment variable indicating the url of another module - from now on the secondary module - pass the option --secondary-module or -s with the value #module_name#=#url#. This will cause DevL to inject the environment variable MODULE_#NAME#_URL (#NAME# should be switched with the module name) with the url part of the value.

NOTICE: It's the developer responsibility to start the secondary module processes.

Debugging node modules

When taking the command from the definition in the module.yml with a node module one can add the option --inspect or --inspect-brk as used in the node documentation and that options will be forwarded to the node process for debugging.