documentation/bin/documentation.js

60 lines
1.4 KiB
JavaScript
Executable File

#!/usr/bin/env node
var documentation = require('../'),
markdown = require('../streams/output/markdown.js'),
json = require('../streams/output/json.js'),
normalize = require('../streams/normalize.js'),
flatten = require('../streams/flatten.js'),
filterAccess = require('../streams/filter_access.js'),
path = require('path');
var yargs = require('yargs')
.usage('Usage: $0 <command> [options]')
.alias('f', 'format')
.default('f', 'json')
.describe('f', 'output format, of [json, md]')
.describe('mdtemplate', 'markdown template: should be a file with Handlebars syntax')
.boolean('p')
.describe('p', 'generate documentation tagged as private')
.alias('p', 'private')
.help('h')
.alias('h', 'help')
.example('$0 foo.js', 'parse documentation in a given file'),
argv = yargs.argv;
var inputs;
if (argv._.length > 0) {
inputs = argv._;
} else {
try {
inputs = [require(path.resolve('package.json')).main];
} catch(e) {
yargs.showHelp();
throw new Error('documentation was given no files and was not run in a module directory');
}
}
var formatter = {
json: json(),
md: markdown({
template: argv.mdtemplate
})
}[argv.f];
if (!formatter) {
yargs.showHelp();
throw new Error('Formatter not found');
}
documentation(inputs)
.pipe(normalize())
.pipe(flatten())
.pipe(filterAccess(argv.private ? [] : undefined))
.pipe(formatter)
.pipe(process.stdout);