typedoc-plugin-markdown
Version:
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
74 lines (73 loc) • 3.36 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.parameterTable = void 0;
const typedoc_1 = require("typedoc");
const comment_1 = require("./comment");
const strip_line_breaks_1 = require("./strip-line-breaks");
const type_1 = require("./type");
function parameterTable() {
const flattenParams = (current) => {
var _a, _b, _c;
return (_c = (_b = (_a = current.type) === null || _a === void 0 ? void 0 : _a.declaration) === null || _b === void 0 ? void 0 : _b.children) === null || _c === void 0 ? void 0 : _c.reduce((acc, child) => {
const childObj = {
...child,
name: `${current.name}.${child.name}`,
};
return parseParams(childObj, acc);
}, []);
};
const parseParams = (current, acc) => {
var _a, _b, _c, _d;
const shouldFlatten = ((_b = (_a = current.type) === null || _a === void 0 ? void 0 : _a.declaration) === null || _b === void 0 ? void 0 : _b.kind) === typedoc_1.ReflectionKind.TypeLiteral &&
((_d = (_c = current.type) === null || _c === void 0 ? void 0 : _c.declaration) === null || _d === void 0 ? void 0 : _d.children);
return shouldFlatten
? [...acc, current, ...flattenParams(current)]
: [...acc, current];
};
return table(this.reduce((acc, current) => parseParams(current, acc), []));
}
exports.parameterTable = parameterTable;
function table(parameters) {
const showDefaults = hasDefaultValues(parameters);
const comments = parameters.map((param) => { var _a, _b, _c, _d; return !!((_b = (_a = param.comment) === null || _a === void 0 ? void 0 : _a.text) === null || _b === void 0 ? void 0 : _b.trim()) || !!((_d = (_c = param.comment) === null || _c === void 0 ? void 0 : _c.shortText) === null || _d === void 0 ? void 0 : _d.trim()); });
const hasComments = !comments.every((value) => !value);
const headers = ['Name', 'Type'];
if (showDefaults) {
headers.push('Default value');
}
if (hasComments) {
headers.push('Description');
}
const rows = parameters.map((parameter) => {
const row = [];
row.push(`\`${parameter.flags.isRest ? '...' : ''}${parameter.name}${parameter.flags.isOptional ? '?' : ''}\``);
row.push(type_1.type.call(parameter.type, 'object'));
if (showDefaults) {
row.push(getDefaultValue(parameter));
}
if (hasComments) {
if (parameter.comment) {
row.push(strip_line_breaks_1.stripLineBreaks(comment_1.comment.call(parameter.comment)).replace(/\|/g, '\\|'));
}
else {
row.push('-');
}
}
return `| ${row.join(' | ')} |\n`;
});
const output = `\n| ${headers.join(' | ')} |\n| ${headers
.map(() => ':------')
.join(' | ')} |\n${rows.join('')}`;
return output;
}
function getDefaultValue(parameter) {
return parameter.defaultValue && parameter.defaultValue !== '...'
? `\`${parameter.defaultValue}\``
: '`undefined`';
}
function hasDefaultValues(parameters) {
const defaultValues = parameters.map((param) => param.defaultValue !== '{}' &&
param.defaultValue !== '...' &&
!!param.defaultValue);
return !defaultValues.every((value) => !value);
}