bulmil
Version:
53 lines (52 loc) • 2.66 kB
JavaScript
/**
* Stencil Doc Outputs don't seem to support custom-elements.json as suggested
* here: https://github.com/w3c/webcomponents/issues/776#issuecomment-536749457.
* This generator implements this standard, which is used by Storybook to display
* documentation.
* Thanks to @jagreehal https://github.com/jagreehal/stencil-boilerplate/blob/master/src/customElementDocGenerator.ts
*/
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
function isOutputTargetCustomElementDocsJson(o) {
return o.name === 'custom-element-docs';
}
export async function writeDocsOutput(compilerCtx, jsonContent, root) {
return compilerCtx.fs.writeFile(`${root}/dist/docs/custom-elements.json`, jsonContent);
}
export async function generateJsonDocs(config, compilerCtx, _buildCtx, docsData) {
const jsonOutputTargets = config.outputTargets.filter(isOutputTargetCustomElementDocsJson);
const { components } = docsData, docsDataWithoutComponents = __rest(docsData, ["components"]);
const json = Object.assign(Object.assign({}, docsDataWithoutComponents), { tags: components.map(cmp => ({
filePath: cmp.filePath,
encapsulation: cmp.encapsulation,
tag: cmp.tag,
name: cmp.tag,
readme: cmp.readme,
description: cmp.docs,
docsTags: cmp.docsTags,
usage: cmp.usage,
properties: cmp.props.map(prop => (Object.assign(Object.assign({}, prop), { description: prop.docs }))),
attributes: cmp.props.map(prop => (Object.assign(Object.assign({}, prop), { name: prop.attr, description: prop.docs }))),
methods: cmp.methods,
events: cmp.events.map(e => (Object.assign(Object.assign({}, e), { name: e.event, description: e.docs, type: e.detail }))),
styles: cmp.styles,
slots: cmp.slots,
dependents: cmp.dependents,
dependencies: cmp.dependencies,
dependencyGraph: cmp.dependencyGraph,
deprecation: cmp.deprecation,
})) });
const jsonContent = JSON.stringify(json, null, 2);
await Promise.all(jsonOutputTargets.map(() => {
return writeDocsOutput(compilerCtx, jsonContent, config.rootDir);
}));
}