@bitjson/typedoc
Version:
Create api documentation for TypeScript projects.
57 lines • 2.18 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const ts = require("typescript");
const declaration_1 = require("./declaration");
function getParameterHelp(options, scope) {
const parameters = options.getDeclarationsByScope(scope);
parameters.sort((a, b) => a.name.localeCompare(b.name, undefined, { sensitivity: 'base' }));
const names = [];
const helps = [];
let margin = 0;
for (let i = 0; i < parameters.length; i++) {
const parameter = parameters[i];
if (!parameter.help) {
continue;
}
let name = ' ';
if (parameter.short) {
name += '-' + parameter.short;
if (typeof parameter.hint !== 'undefined') {
name += ' ' + declaration_1.ParameterHint[parameter.hint].toUpperCase();
}
name += ', ';
}
name += '--' + parameter.name;
if (parameter.hint) {
name += ' ' + declaration_1.ParameterHint[parameter.hint].toUpperCase();
}
names.push(name);
helps.push(parameter.help);
margin = Math.max(name.length, margin);
}
return { names: names, helps: helps, margin: margin };
}
function getOptionsHelp(options) {
const typeDoc = getParameterHelp(options, declaration_1.ParameterScope.TypeDoc);
const output = [];
output.push('Usage:');
output.push(' typedoc --mode modules --out path/to/documentation path/to/sourcefiles');
output.push('', 'TypeDoc options:');
pushHelp(typeDoc);
output.push('', 'TypeScript options:');
output.push('See https://www.typescriptlang.org/docs/handbook/compiler-options.html');
output.push('');
return output.join(ts.sys.newLine);
function pushHelp(columns) {
for (let i = 0; i < columns.names.length; i++) {
const usage = columns.names[i];
const description = columns.helps[i];
output.push(usage + padding(typeDoc.margin - usage.length + 2) + description);
}
}
function padding(length) {
return Array(length + 1).join(' ');
}
}
exports.getOptionsHelp = getOptionsHelp;
//# sourceMappingURL=help.js.map