Refactor CLI parsing

Author: tmcw

bin/documentation.js

@@ -14,14 +14,23 @@ commands[parsedArgs.command](documentation, parsedArgs);
 
 function parseArgs() {
 
-  var commandArgv = addCommands(yargs)
+  var rawArgv = addCommands(yargs)
     .version(function () {
       return require('../package').version;
     })
     .argv;
 
-  var argv = commands[commandArgv._[0]]
-    .parseArgs(yargs.reset()).argv;
+  var command = rawArgv._[0];
+
+  if (!commands[command]) {
+    yargs.showHelp();
+    var suggestion = [rawArgv['$0'], 'build'].concat(process.argv.slice(2)).join(' ');
+    process.stderr.write('Unknown command: ' + command + '.  Did you mean "' + suggestion + '"?\n');
+    process.exit(1);
+  }
+
+  var argv = commands[command].parseArgs(yargs.reset()).argv;
+  var inputs = argv._.slice(1);
 
   var options = {};
   if (argv.config) {
@@ -37,16 +46,6 @@ function parseArgs() {
     options.access = (options.access || ['public', 'undefined', 'protected']).concat(['private']);
   }
 
-  var command = argv._[0],
-    inputs = argv._.slice(1);
-
-  if (!commands[command]) {
-    yargs.showHelp();
-    var suggestion = [argv['$0'], 'build'].concat(process.argv.slice(2)).join(' ');
-    process.stderr.write('Unknown command: ' + command + '.  Did you mean "' + suggestion + '"?\n');
-    process.exit(1);
-  }
-
   if (inputs.length == 0) {
     try {
       var p = require(path.resolve('package.json'));
@@ -66,8 +65,8 @@ function parseArgs() {
   };
 }
 
-function addCommands(parser, descriptionOnly) {
-  return Object.keys(commands).reduce(function(parser, cmd) {
+function addCommands(parser) {
+  return Object.keys(commands).reduce(function (parser, cmd) {
     return parser.command(cmd, commands[cmd].description);
   }, parser.demand(1)).help('help');
 }

lib/commands/build.js

@@ -40,6 +40,9 @@ function build(documentation, parsedArgs, callback) {
   var inputs = parsedArgs.inputs;
   var buildOptions = parsedArgs.commandOptions;
   var options = parsedArgs.options;
+  if (options.f === 'html' && options.o === 'stdout') {
+    throw new Error('The HTML output mode requires a destination directory set with -o');
+  }
   var formatterOptions = {
     name: buildOptions.name || (options.package || {}).name,
     version: buildOptions['project-version'] || (options.package || {}).version,

lib/commands/shared_options.js

@@ -1,5 +1,9 @@
 /**
  * Adds shared options to any command that runs documentation
+ *
+ * @param {Object} parser yargs object
+ * @returns {Object} same yargs object with options
+ * @private
  */
 function sharedInputOptions(parser) {
   return parser.option('shallow', {
@@ -45,10 +49,17 @@ function sharedInputOptions(parser) {
     describe: 'infer links to github in documentation',
     alias: 'g'
   });
-};
+}
 
-function sharedOutputOptions(yargs) {
-  return yargs.option('theme', {
+/**
+ * Adds shared options to any command that runs documentation
+ *
+ * @param {Object} parser yargs object
+ * @returns {Object} same yargs object with options
+ * @private
+ */
+function sharedOutputOptions(parser) {
+  return parser.option('theme', {
     describe: 'specify a theme: this must be a valid theme module',
     alias: 't'
   })