README
wScriptLauncher provides a simple human-machine, machine-machine interfaces to run a script file on a platform of interest and get output to your terminal. The platform could be remote or local, browser or native. Platforms list could be extended by an implementation of a new custom platform provider.
Implemented platforms :
Name - platform option value
- Mozilla Firefox - firefox
- Google Chrome - chrome
- Electron - electron
- PhantomJs - phantomjs
- Node.js - node
- Browserstack - browserstack
Installation
npm install wscriptlauncher
Usage options
Option | Type | Optional | Default | Description |
---|---|---|---|---|
filePath | string | path to script file | ||
platform | string | * | chrome | sets target platfrom |
headless | boolean | * | true | run in headless mode |
terminatingAfter | boolean | * | true | terminate launcher after script execution |
verbosity | number | * | 1 | sets level of details of console output |
Usage with Nodejs:
var _ = wTools;
/* Initialize launcher with provided options object */
var launcher = wScriptLauncher
({
filePath : '/path/to/file',
headless : true,
platform : 'chrome',
terminatingAfter : true,
verbosity : 1
});
/* Run our script file on target platform by calling launch, it
returns wConsequence object which gives us a message with platform provider
when all work will be done. More about wConsequence - https://github.com/Wandalen/wConsequence
*/
launcher.launch()
.got( function ( err, provider )
{
if( err )
throw _.errLog( err );
console.log( provider );
});
Usage with command line:
To print help:
launcher
To run script with default setting:
launcher /path/to/file.js
To run script with options, first argument must be path:
launcher /path/to/file.js platform : chrome headless : 0 terminatingAfter : 1
Another way to run script with options:
launcher filePath : /path/to/file.js platform : firefox headless : 1
Acknowledgements
We would like to thank Browserstack for support!