UNPKG

vue-docgen-cli

Version:

Generate documentation markdown files from VueJs components using the vue-docgen-api.

36 lines (35 loc) 1.16 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); const utils_1 = require("./utils"); function formatProperties(properties) { if (!properties) { return ''; } return properties .map(property => { const { name, description, type } = property; if (!type) { return ''; } return `**${name}** \`${type.names.length ? type.names.join(', ') : ''}\` - ${description}`; }) .join('\n'); } const tmpl = (events) => { let ret = ''; events.forEach(evt => { const { description = '', ...e } = evt; const readableProperties = e.properties ? `${formatProperties(e.properties)}` : ''; ret += `| ${(0, utils_1.mdclean)(e.name)} | ${(0, utils_1.mdclean)(readableProperties)} | ${(0, utils_1.mdclean)(description)}\n`; }); return ret; }; exports.default = (events, opt = {}) => { return ` ${opt.isSubComponent || opt.hasSubComponents ? '#' : ''}## Events | Event name | Properties | Description | | -------------- |--------------- | -------------| ${tmpl(events)} `; }; //# sourceMappingURL=events.js.map