Added command line interface using yargs.

Author: pankaj-a

bin/init.js

@@ -1,13 +1,14 @@
 #! /usr/bin/env node
 
 var fs = require('fs');
-var preset = process.argv[3] || 'default';
+var preset = require('./runner').preset;
+var path = require('./runner').path;
 var browsers = require('../presets/' + preset + '.json');
 
 var config = {
   username: 'BROWSERSTACK_USERNAME',
   key: 'BROWSERSTACK_KEY',
-  test_path: 'path/to/test/runner',
+  test_path: path || 'path/to/test/runner',
   browsers: browsers
 };
 

bin/runner.js

@@ -1,21 +1,53 @@
 #! /usr/bin/env node
 
-var todo = process.argv[2],
-  path = require('path'),
-  config;
+var yargs = require('yargs')
+  .command('init [preset] [path]', 'initialise browserstack.json with preset and test runner path', function(yargs) {
+    return yargs.option('preset', {
+      type: 'string',
+      default: 'default',
+      description: 'name of preset json file(without extension)(present in node_modules/browserstack-runner/presets to be used while initiating'
+    })
+    .option('path', {
+      type: 'string',
+      default: '/path/to/test/runner',
+      description: 'path to test runner to be inserted in browserstack.json'
+    })
+  })
+  .option('browsers', {
+    alias: 'b',
+    type: 'array',
+    description: 'list of space separatedbrowsers keys as described in json file'
+  })
+  .option('path', {
+    type: 'string',
+    description: 'path to test file'
+  })
+  .option('version', {
+    alias: 'V',
+    description: 'browserstack-runner version'
+  })
+  .option('pid', {
+    type: 'string',
+    description: 'path to pid file'
+  })
+  .option('verbose', {
+    alias: 'v',
+    description: 'verbose logging'
+  }).argv;
 
-if (process.argv.indexOf('--verbose') !== -1) {
+if (yargs['verbose']) {
   global.logLevel = process.env.LOG_LEVEL || 'debug';
 } else {
   global.logLevel = 'info';
 }
+var path = require('path'),
+  config;
 
-if (todo === 'init') {
+if(yargs['_'].indexOf('init') !== -1) {
+  module.exports.preset = yargs['preset'];
+  module.exports.path = yargs['path'];
   require('./init.js');
   return;
-} else if (todo === '--version') {
-  require('./version.js');
-  return;
 }
 
 var config_path = process.env.BROWSERSTACK_JSON || 'browserstack.json';
@@ -37,17 +69,28 @@ try {
 }
 
 // extract a path to file to store tunnel pid
-var pid = process.argv.find(function (param) { return param.indexOf('--pid') !== -1; });
-
-if (pid) {
-  var extracted_path = /--pid=([\w\/\.-]+)/g.exec(pid);
-  if (extracted_path) {
-    config.tunnel_pid_file = extracted_path[1];
+if(yargs['pid']) {
+  if(yargs['pid'].length > 0) {
+    config.tunnel_pid_file = yargs['pid'];
   } else {
     console.error('Error while parsing flag --pid. Usage: --pid=/path/to/file');
   }
 }
 
+// filter browsers according to from command line arguments
+if(yargs['browsers']) {
+  if(yargs['browsers'].length > 0) {
+    config.browsers = config.browsers.filter( function(browser) {
+      return yargs['browsers'].indexOf(browser['cli_key']) !== -1;
+    });
+  } else {
+    console.error('No browser keys specified. Usage --browsers <key1> <key2> ...');
+  }
+}
+
+// test file path from cli arguments
+config.test_path = yargs['path'] || config.test_path;
+
 var runner = require('./cli.js');
 runner.run(config, function(err) {
   if(err) {

package.json

@@ -15,7 +15,8 @@
     "mime": "1.3.4",
     "resolve": "1.1.7",
     "send": "0.13.0",
-    "tunnel": "0.0.3"
+    "tunnel": "0.0.3",
+    "yargs": "^12.0.1"
   },
   "devDependencies": {
     "jshint": "2.5.6",

presets/default.json

@@ -3,48 +3,56 @@
     "browser": "firefox",
     "browser_version": "latest",
     "os": "OS X",
-    "os_version": "Lion"
+    "os_version": "Lion",
+    "cli_key": 1
   },
   {
     "browser": "safari",
     "browser_version": "latest",
     "os": "OS X",
-    "os_version": "Mountain Lion"
+    "os_version": "Mountain Lion",
+    "cli_key": 2
   },
   {
     "browser": "chrome",
     "browser_version": "latest",
     "os": "OS X",
-    "os_version": "Mountain Lion"
+    "os_version": "Mountain Lion",
+    "cli_key": 3
   },
   {
     "browser": "firefox",
     "browser_version": "latest",
     "os": "Windows",
-    "os_version": "7"
+    "os_version": "7",
+    "cli_key": 4
   },
   {
     "browser": "chrome",
     "browser_version": "latest",
     "os": "Windows",
-    "os_version": "7"
+    "os_version": "7",
+    "cli_key": 5
   },
   {
     "browser": "ie",
     "browser_version": "9.0",
     "os": "Windows",
-    "os_version": "7"
+    "os_version": "7",
+    "cli_key": 6
   },
   {
     "browser": "ie",
     "browser_version": "10.0",
     "os": "Windows",
-    "os_version": "8"
+    "os_version": "8",
+    "cli_key": 7
   },
   {
     "browser": "ie",
     "browser_version": "11.0",
     "os": "Windows",
-    "os_version": "7"
+    "os_version": "7",
+    "cli_key": 8
   }
 ]