mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
114 lines
3.1 KiB
JavaScript
Executable File
114 lines
3.1 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
var documentation = require('../'),
|
|
PassThrough = require('stream').PassThrough,
|
|
|
|
combine = require('stream-combiner'),
|
|
path = require('path'),
|
|
fs = require('fs'),
|
|
vfs = require('vinyl-fs'),
|
|
|
|
hierarchy = require('../streams/hierarchy.js'),
|
|
highlight = require('../streams/highlight.js'),
|
|
|
|
json = require('../streams/output/json.js'),
|
|
markdown = require('../streams/output/markdown.js'),
|
|
htmlOutput = require('../streams/output/html.js'),
|
|
docset = require('../streams/output/docset.js'),
|
|
|
|
lint = require('../streams/lint.js'),
|
|
github = require('../streams/github.js'),
|
|
normalize = require('../streams/normalize.js'),
|
|
flatten = require('../streams/flatten.js'),
|
|
filterAccess = require('../streams/filter_access.js');
|
|
|
|
var yargs = require('yargs')
|
|
.usage('Usage: $0 <command> [options]')
|
|
|
|
.alias('f', 'format')
|
|
.default('f', 'json')
|
|
.describe('f', 'output format, of [json, md, html, docset]')
|
|
|
|
.describe('lint', 'check output for common style and uniformity mistakes')
|
|
|
|
.describe('mdtemplate', 'markdown template: should be a file with Handlebars syntax')
|
|
|
|
.boolean('p')
|
|
.describe('p', 'generate documentation tagged as private')
|
|
.alias('p', 'private')
|
|
|
|
.boolean('g')
|
|
.describe('g', 'infer links to github in documentation')
|
|
.alias('g', 'github')
|
|
|
|
.describe('o', 'output location. omit for stdout, otherwise is a filename for single-file outputs and a directory name for multi-file outputs like html')
|
|
.alias('o', 'output')
|
|
.default('o', 'stdout')
|
|
|
|
.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');
|
|
}
|
|
}
|
|
|
|
try {
|
|
var formatter = {
|
|
json: function () {
|
|
return json();
|
|
},
|
|
docset: function () {
|
|
return combine([highlight(), hierarchy(), htmlOutput({
|
|
hideSidebar: true
|
|
}), docset()]);
|
|
},
|
|
md: function () {
|
|
return markdown({
|
|
template: argv.mdtemplate
|
|
});
|
|
},
|
|
html: function () {
|
|
return combine([highlight(), hierarchy(), htmlOutput()]);
|
|
}
|
|
}[argv.f]();
|
|
} catch(e) {
|
|
yargs.showHelp();
|
|
throw new Error('Formatter not found');
|
|
}
|
|
|
|
if (argv.f === 'html' && argv.o === 'stdout') {
|
|
yargs.showHelp();
|
|
throw new Error('The HTML output mode requires a destination directory set with -o');
|
|
}
|
|
|
|
var docStream = documentation(inputs)
|
|
.pipe(normalize())
|
|
.pipe(argv.lint ? lint() : new PassThrough({ objectMode: true }))
|
|
.pipe(argv.g ? github() : new PassThrough({ objectMode: true }))
|
|
.pipe(flatten())
|
|
.pipe(filterAccess(argv.private ? [] : undefined))
|
|
.pipe(formatter);
|
|
|
|
if (argv.o !== 'stdout') {
|
|
if (argv.f === 'html') {
|
|
docStream.pipe(vfs.dest(argv.o));
|
|
} else if (argv.f === 'docset') {
|
|
docStream.pipe(vfs.dest(argv.o));
|
|
} else {
|
|
docStream.pipe(fs.createWriteStream(argv.o));
|
|
}
|
|
} else {
|
|
docStream.pipe(process.stdout);
|
|
}
|