mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
112 lines
3.0 KiB
JavaScript
Executable File
112 lines
3.0 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
var documentation = require('../'),
|
|
PassThrough = require('stream').PassThrough,
|
|
|
|
path = require('path'),
|
|
fs = require('fs'),
|
|
vfs = require('vinyl-fs'),
|
|
|
|
lint = require('../streams/lint.js'),
|
|
github = require('../streams/github.js');
|
|
|
|
var yargs = require('yargs')
|
|
.usage('Usage: $0 <command> [options]')
|
|
|
|
.alias('f', 'format')
|
|
.default('f', 'json')
|
|
.describe('f', 'output format, of [json, md, html]')
|
|
|
|
.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')
|
|
|
|
.describe('name', 'project name. by default, inferred from package.json')
|
|
.describe('version', 'project version. by default, inferred from package.json')
|
|
|
|
.boolean('shallow')
|
|
.describe('shallow', 'shallow mode turns off dependency resolution, only processing the specified files (or the main script specified in package.json)')
|
|
.default('shallow', false)
|
|
|
|
.boolean('polyglot')
|
|
.describe('polyglot', 'polyglot mode turns off dependency resolution and enables multi-language support. use this to document c++')
|
|
|
|
.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,
|
|
name = argv.name,
|
|
version = argv.version,
|
|
transform;
|
|
|
|
if (argv._.length > 0) {
|
|
inputs = argv._;
|
|
} else {
|
|
try {
|
|
var p = require(path.resolve('package.json'));
|
|
inputs = [p.main];
|
|
name = name || p.name;
|
|
version = version || p.version;
|
|
if (p.browserify && p.browserify.transform) {
|
|
transform = p.browserify.transform;
|
|
}
|
|
} catch(e) {
|
|
yargs.showHelp();
|
|
throw new Error('documentation was given no files and was not run in a module directory');
|
|
}
|
|
}
|
|
|
|
try {
|
|
|
|
var formatterOptions = {
|
|
name: name,
|
|
version: version,
|
|
mdtemplate: argv.mdtemplate
|
|
};
|
|
|
|
var formatter = documentation.formats[argv.f](formatterOptions);
|
|
} 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, {
|
|
private: argv.private,
|
|
transform: transform,
|
|
polyglot: argv.polyglot,
|
|
shallow: argv.shallow
|
|
})
|
|
.pipe(argv.lint ? lint() : new PassThrough({ objectMode: true }))
|
|
.pipe(argv.g ? github() : new PassThrough({ objectMode: true }))
|
|
.pipe(formatter);
|
|
|
|
if (argv.o !== 'stdout') {
|
|
if (argv.f === 'html') {
|
|
docStream.pipe(vfs.dest(argv.o));
|
|
} else {
|
|
docStream.pipe(fs.createWriteStream(argv.o));
|
|
}
|
|
} else {
|
|
docStream.pipe(process.stdout);
|
|
}
|