update options in help messages

browserstack · May 12, 2020 · 8d9d4d3 · 8d9d4d3
1 parent fc3d9c0
commit 8d9d4d3
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 36 deletions.
diff --git a/bin/helpers/constants.js b/bin/helpers/constants.js
@@ -49,6 +49,9 @@ const cliMessages = {
         INFO: "Run your tests on BrowserStack.",
         DESC: "Path to BrowserStack config",
         CONFIG_DEMAND: "config file is required"
+    },
+    COMMON: {
+      DISABLE_USAGE_REPORTING: "Disable usage reporting"
     }
 }
 

diff --git a/bin/helpers/util.js b/bin/helpers/util.js
@@ -61,8 +61,8 @@ exports.sendUsageReport = (bsConfig, args, message, message_type, error_code) =>
 }
 
 exports.setUsageReportingFlag = (bsConfig, disableUsageReporting) => {
-  if (disableUsageReporting === undefined && bsConfig && bsConfig['disable-usage-reporting'] != undefined) {
-    process.env.DISABLE_USAGE_REPORTING = bsConfig['disable-usage-reporting'];
+  if (disableUsageReporting === undefined && bsConfig && bsConfig['disable_usage_reporting'] != undefined) {
+    process.env.DISABLE_USAGE_REPORTING = bsConfig['disable_usage_reporting'];
   } else {
     process.env.DISABLE_USAGE_REPORTING = disableUsageReporting;
   }

diff --git a/bin/runner.js b/bin/runner.js
@@ -22,16 +22,22 @@ var argv = yargs
   .demand(1, Constants.cliMessages.VERSION.DEMAND)
   .command('init', Constants.cliMessages.INIT.INFO, function(yargs) {
     argv = yargs
-      .usage('usage: $0 init [options]')
-      .options('p', {
-        alias: 'path',
-        default: false,
-        description: Constants.cliMessages.INIT.DESC,
-        type: 'string'
+      .usage("usage: $0 init [options]")
+      .options({
+        'p': {
+          alias: "path",
+          default: false,
+          description: Constants.cliMessages.INIT.DESC,
+          type: "string",
+        },
+        'disable-usage-reporting': {
+          default: undefined,
+          description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
+          type: "boolean"
+        },
       })
-      .help('help')
-      .wrap(null)
-      .argv
+      .help("help")
+      .wrap(null).argv;
 
     if (checkCommands(yargs, argv, 1)) {
       return require('./commands/init')(argv);
@@ -41,14 +47,21 @@ var argv = yargs
     argv = yargs
       .usage('usage: $0 <buildId>')
       .demand(1, Constants.cliMessages.BUILD.DEMAND)
-      .options('cf', {
-        alias: 'config-file',
-        describe: Constants.cliMessages.BUILD.DESC,
-        default: '/browserstack.json',
-        type: 'string',
-        nargs: 1,
-        demand: true,
-        demand: Constants.cliMessages.BUILD.CONFIG_DEMAND
+      .options({
+        'cf': {
+          alias: 'config-file',
+          describe: Constants.cliMessages.BUILD.DESC,
+          default: '/browserstack.json',
+          type: 'string',
+          nargs: 1,
+          demand: true,
+          demand: Constants.cliMessages.BUILD.CONFIG_DEMAND
+        },
+        'disable-usage-reporting': {
+          default: undefined,
+          description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
+          type: "boolean"
+        },
       })
       .help('help')
       .wrap(null)
@@ -62,14 +75,21 @@ var argv = yargs
     argv = yargs
       .usage('usage: $0 <buildId>')
       .demand(1, Constants.cliMessages.BUILD.DEMAND)
-      .options('cf', {
-        alias: 'config-file',
-        describe: Constants.cliMessages.BUILD.DESC,
-        default: '/browserstack.json',
-        type: 'string',
-        nargs: 1,
-        demand: true,
-        demand: Constants.cliMessages.BUILD.CONFIG_DEMAND
+      .options({
+        'cf': {
+          alias: 'config-file',
+          describe: Constants.cliMessages.BUILD.DESC,
+          default: '/browserstack.json',
+          type: 'string',
+          nargs: 1,
+          demand: true,
+          demand: Constants.cliMessages.BUILD.CONFIG_DEMAND
+        },
+        'disable-usage-reporting': {
+          default: undefined,
+          description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
+          type: "boolean"
+        },
       })
       .help('help')
       .wrap(null)
@@ -82,14 +102,21 @@ var argv = yargs
   .command('run', Constants.cliMessages.RUN.INFO, function(yargs) {
     argv = yargs
       .usage('usage: $0 build')
-      .options('cf', {
-        alias: 'config-file',
-        describe: Constants.cliMessages.RUN.DESC,
-        default: '/browserstack.json',
-        type: 'string',
-        nargs: 1,
-        demand: true,
-        demand: Constants.cliMessages.RUN.CONFIG_DEMAND
+      .options({
+        'cf': {
+          alias: 'config-file',
+          describe: Constants.cliMessages.RUN.DESC,
+          default: '/browserstack.json',
+          type: 'string',
+          nargs: 1,
+          demand: true,
+          demand: Constants.cliMessages.RUN.CONFIG_DEMAND
+        },
+        'disable-usage-reporting': {
+          default: undefined,
+          description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
+          type: "boolean"
+        },
       })
       .help('help')
       .wrap(null)

diff --git a/bin/templates/configTemplate.js b/bin/templates/configTemplate.js
@@ -20,7 +20,7 @@ module.exports = function () {
       "local": false,
       "localIdentifier": null
     },
-    "disable-usage-reporting": false
+    "disable_usage_reporting": false
   }
   var EOL = require('os').EOL
   var file = [