Update dependencies (#560)

* also deprecated --private option in favor of --access

Author: tmcw

bin/documentation.js

@@ -1,72 +1,35 @@
 #!/usr/bin/env node
 
+/* eslint no-console: 0 */
+
 'use strict';
 
-var documentation = require('../'),
-  path = require('path'),
-  yargs = require('yargs'),
-  extend = require('extend'),
-  loadConfig = require('../lib/load_config.js'),
+var yargs = require('yargs'),
   commands = require('../lib/commands');
 
-var parsedArgs = parseArgs();
-commands[parsedArgs.command](documentation, parsedArgs);
-
-function parseArgs() {
-
-  var rawArgv = addCommands(yargs)
-    .version(function () {
-      return require('../package').version;
-    })
-    .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) {
-    options = loadConfig(argv.config);
-  }
-  options = extend(options, argv);
-
-  if (typeof options.access === 'string') {
-    options.access = [options.access];
-  }
-
-  if (options.private) {
-    options.access = (options.access || ['public', 'undefined', 'protected']).concat(['private']);
-  }
-
-  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');
-    }
-  }
+var argv = yargs
+  .command(commands.serve)
+  .command(commands.build)
+  .command(commands.lint)
+  .command(commands.readme)
+  .version(function () {
+    return require('../package').version;
+  })
+  .recommendCommands()
+  .help()
+  .argv;
+
+if (argv.private) {
+  console.error('--private is deprecated, please use the --access (or -a) option instead');
+  console.error('for example: -a public -a private -a protected -a undefined');
+}
 
-  return {
-    inputs: inputs,
-    command: command,
-    commandOptions: addCommands(yargs).argv,
-    options: options
-  };
+if (!argv._handled) {
+  yargs.showHelp('error');
+  process.exit(1);
 }
 
-function addCommands(parser) {
-  return Object.keys(commands).reduce(function (parser, cmd) {
-    return parser.command(cmd, commands[cmd].description);
-  }, parser.demand(1)).help('help');
+
+if (!yargs.argv._.length) {
+  yargs.showHelp();
 }

default_theme/test/format_markdown.js

@@ -3,7 +3,7 @@ var remark = require('remark');
 var formatMarkdown = require('../lib/format_markdown');
 
 test('main', function (t) {
-  t.deepEqual(formatMarkdown(remark.parse('Converts from `Result<T>` to `?Error`')),
+  t.deepEqual(formatMarkdown(remark().parse('Converts from `Result<T>` to `?Error`')),
     '<p>Converts from <code>Result&lt;T&gt;</code> to <code>?Error</code></p>\n');
   t.done();
 });

default_theme/test/index.js

@@ -7,7 +7,7 @@ test('main', function (t) {
     {
       path: [],
       context: {},
-      description: remark.parse('test'),
+      description: remark().parse('test'),
       members: {
         static: [],
         instance: []

lib/commands/build.js

@@ -4,35 +4,36 @@ var streamArray = require('stream-array'),
   sharedOptions = require('./shared_options'),
   fs = require('fs'),
   vfs = require('vinyl-fs'),
+  extend = require('extend'),
   chokidar = require('chokidar'),
+  documentation = require('../../'),
   debounce = require('debounce');
 
-module.exports = build;
-module.exports.description = 'build documentation';
+module.exports.command = 'build [input..]';
+module.exports.describe = 'build documentation';
 
 /**
  * Add yargs parsing for the build command
  * @param {Object} yargs module instance
  * @returns {Object} yargs with options
  * @private
  */
-module.exports.parseArgs = function (yargs) {
-  return sharedOptions.sharedOutputOptions(
-    sharedOptions.sharedInputOptions(yargs))
-    .option('format', {
+module.exports.builder = extend({},
+  sharedOptions.sharedOutputOptions,
+  sharedOptions.sharedInputOptions, {
+    format: {
       alias: 'f',
       default: 'json',
       choices: ['json', 'md', 'remark', 'html']
-    })
-    .option('output', {
+    },
+    output: {
       describe: 'output location. omit for stdout, otherwise is a filename ' +
-        'for single-file outputs and a directory name for multi-file outputs like html',
+      'for single-file outputs and a directory name for multi-file outputs like html',
       default: 'stdout',
       alias: 'o'
-    })
-    .example('documentation build foo.js -f md > API.md', 'parse documentation in a ' +
-      'file and generate API documentation as Markdown');
-};
+    },
+    example: 'documentation build foo.js -f md > API.md'
+  });
 
 /*
  * The `build` command.  Requires either `--output` or the `callback` argument.
@@ -42,22 +43,22 @@ module.exports.parseArgs = function (yargs) {
  * The former case, with the callback, is used by the `serve` command, which is
  * just a thin wrapper around this one.
  */
-function build(documentation, parsedArgs, callback) {
-  var inputs = parsedArgs.inputs;
-  var buildOptions = parsedArgs.commandOptions;
-  var options = parsedArgs.options;
-  if (options.f === 'html' && options.o === 'stdout') {
+module.exports.handler = function build(argv, callback) {
+  argv._handled = true;
+  argv = sharedOptions.expandInputs(argv);
+  if (argv.f === 'html' && argv.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,
-    theme: buildOptions.theme,
-    paths: options.paths,
-    hljs: options.hljs || {}
+    name: argv.name || (argv.package || {}).name,
+    version: argv['project-version'] || (argv.package || {}).version,
+    theme: argv.theme,
+    paths: argv.paths,
+    hljs: argv.hljs || {}
   };
 
-  var generator = documentation.build.bind(null, inputs, options, onDocumented);
+  var generator = documentation.build
+    .bind(null, argv.input, argv, onDocumented);
 
   function onDocumented(err, comments) {
     if (err) {
@@ -67,38 +68,38 @@ function build(documentation, parsedArgs, callback) {
       throw err;
     }
 
-    documentation.formats[buildOptions.format](comments, formatterOptions, onFormatted);
+    documentation.formats[argv.format](comments, formatterOptions, onFormatted);
   }
 
   function onFormatted(err, output) {
-    if (buildOptions.watch) {
+    if (argv.watch) {
       updateWatcher();
     }
 
     if (typeof callback === 'function') {
       callback(null, output);
-    } else if (buildOptions.output === 'stdout') {
+    } else if (argv.output === 'stdout') {
       process.stdout.write(output);
     } else if (Array.isArray(output)) {
-      streamArray(output).pipe(vfs.dest(buildOptions.output));
+      streamArray(output).pipe(vfs.dest(argv.output));
     } else {
-      fs.writeFileSync(buildOptions.output, output);
+      fs.writeFileSync(argv.output, output);
     }
   }
 
-  if (buildOptions.watch) {
-    var watcher = chokidar.watch(inputs);
+  if (argv.watch) {
+    var watcher = chokidar.watch(argv.input);
     watcher.on('all', debounce(generator, 300));
   }
   generator();
 
   function updateWatcher() {
-    documentation.expandInputs(inputs, options, addNewFiles);
+    documentation.expandInputs(argv.input, argv, addNewFiles);
   }
 
   function addNewFiles(err, files) {
     watcher.add(files.map(function (data) {
       return typeof data === 'string' ? data : data.file;
     }));
   }
-}
+};

lib/commands/lint.js

@@ -1,33 +1,26 @@
 'use strict';
 
+var documentation = require('../../');
+var sharedOptions = require('./shared_options');
+
 /* eslint no-console: 0 */
 
-module.exports = lint;
+module.exports.command = 'lint [input..]';
 module.exports.description = 'check for common style and uniformity mistakes';
-
-/**
- * Add yargs parsing for the lint command
- * @param {Object} yargs module instance
- * @returns {Object} yargs with options
- * @private
- */
-module.exports.parseArgs = function (yargs) {
-  return yargs
-    .example('documentation lint project.js', 'check documentation style')
-    .help('help');
-};
+module.exports.builder = {};
 
 /**
  * Wrap around the documentation.lint method and add the additional
  * behavior of printing to stdout and setting an exit status.
  *
- * @param {Object} documentation self-module instance
- * @param {Object} parsedArgs cli arguments
+ * @param {Object} argv cli arguments
  * @returns {undefined} has side-effects
  * @private
  */
-function lint(documentation, parsedArgs) {
-  documentation.lint(parsedArgs.inputs, parsedArgs.options, function (err, lintOutput) {
+module.exports.handler = function (argv) {
+  argv._handled = true;
+  argv = sharedOptions.expandInputs(argv);
+  documentation.lint(argv.input, argv, function (err, lintOutput) {
     if (err) {
       throw err;
     }
@@ -38,4 +31,4 @@ function lint(documentation, parsedArgs) {
       process.exit(0);
     }
   });
-}
+};