Merge pull request #277 from documentationjs/refactor-commands-new

Refactor commands into modules

Author: anandthakker

Diff for: bin/documentation.js

@@ -1,84 +1,96 @@
 #!/usr/bin/env node
 
-/* eslint no-console: 0 */
-
 'use strict';
 
 var documentation = require('../'),
-  chokidar = require('chokidar'),
-  debounce = require('debounce'),
-  streamArray = require('stream-array'),
-  fs = require('fs'),
-  vfs = require('vinyl-fs'),
-  errorPage = require('../lib/error_page'),
-  Server = require('../lib/server'),
-  args = require('../lib/args');
-
-var parsedArgs = args(process.argv.slice(2));
+  path = require('path'),
+  yargs = require('yargs'),
+  extend = require('extend'),
+  loadConfig = require('../lib/load_config.js'),
+  commands = require('../lib/commands');
 
-var generator = documentation.bind(null,
-  parsedArgs.inputs, parsedArgs.options, onDocumented.bind(null, parsedArgs));
+var parsedArgs = parseArgs();
+commands[parsedArgs.command](documentation, parsedArgs);
 
-var server = new Server();
-server.on('listening', function () {
-  process.stdout.write('documentation.js serving on port 4001\n');
-});
+function parseArgs() {
+  // reset() needs to be called at parse time because the yargs module uses an
+  // internal global variable to hold option state
+  var argv = yargs
+    .usage('Usage: $0 <command> [options]')
+    .version(function () {
+      return require('../package').version;
+    })
+    .option('shallow', {
+      describe: 'shallow mode turns off dependency resolution, ' +
+      'only processing the specified files (or the main script specified in package.json)',
+      default: false,
+      type: 'boolean'
+    })
+    .option('config', {
+      describe: 'configuration file. an array defining explicit sort order',
+      alias: 'c'
+    })
+    .option('external', {
+      describe: 'a string / glob match pattern that defines which external ' +
+        'modules will be whitelisted and included in the generated documentation.',
+      default: null
+    })
+    .option('extension', {
+      describe: 'only input source files matching this extension will be parsed, ' +
+        'this option can be used multiple times.',
+      alias: 'e'
+    })
+    .option('polyglot', {
+      type: 'boolean',
+      describe: 'polyglot mode turns off dependency resolution and ' +
+        'enables multi-language support. use this to document c++'
+    })
+    .option('private', {
+      describe: 'generate documentation tagged as private',
+      type: 'boolean',
+      default: false,
+      alias: 'p'
+    })
+    .option('github', {
+      type: 'boolean',
+      describe: 'infer links to github in documentation',
+      alias: 'g'
+    })
+  .argv;
 
-function onDocumented(parsedArgs, err, comments) {
-  if (err) {
-    if (parsedArgs.command === 'serve') {
-      return server.setFiles([errorPage(err)]).start();
-    }
-    throw err;
+  var options = {};
+  if (argv.config) {
+    options = loadConfig(argv.config);
   }
+  options = extend(options, argv);
 
-  documentation.formats[parsedArgs.formatter](
-    comments, parsedArgs.formatterOptions,
-    onFormatted.bind(null, parsedArgs));
-}
+  var command = argv._[0],
+    inputs = argv._.slice(1);
 
-function onFormatted(parsedArgs, err, output) {
-  if (parsedArgs.watch) {
-    updateWatcher();
+  if (inputs.length == 0) {
+    try {
+      var p = require(path.resolve('package.json'));
+      options.package = p;
+      inputs = [p.main || 'index.js'];
+    } catch (e) {
+      yargs.showHelp();
+      throw new Error('documentation was given no files and was not run in a module directory');
+    }
   }
 
-  if (parsedArgs.command === 'serve') {
-    server.setFiles(output).start();
-  } else if (parsedArgs.output === 'stdout') {
-    process.stdout.write(output);
-  } else if (Array.isArray(output)) {
-    streamArray(output).pipe(vfs.dest(parsedArgs.output));
-  } else {
-    fs.writeFileSync(parsedArgs.output, output);
-  }
+  return {
+    inputs: inputs,
+    command: command,
+    commandOptions: addCommands(yargs).argv,
+    options: options
+  };
 }
 
-if (parsedArgs.command === 'lint') {
-  documentation.lint(parsedArgs.inputs, parsedArgs.options, function (err, lintOutput) {
-    if (err) {
-      throw err;
-    }
-    if (lintOutput) {
-      console.log(lintOutput);
-      process.exit(1);
-    } else {
-      process.exit(0);
-    }
-  });
-} else {
-  generator();
-  if (parsedArgs.watch) {
-    var watcher = chokidar.watch(parsedArgs.inputs);
-    watcher.on('all', debounce(generator, 300));
+function addCommands(parser) {
+  parser = parser.demand(1);
+  for (var cmd in commands) {
+    parser = parser.command(cmd, commands[cmd].description, commands[cmd].parseArgs);
   }
+  return parser.help('help');
 }
 
-function updateWatcher() {
-  documentation.expandInputs(parsedArgs.inputs, parsedArgs.options, addNewFiles);
-}
-
-function addNewFiles(err, files) {
-  watcher.add(files.map(function (data) {
-    return data.file;
-  }));
-}