11bbc5fff5
* feat: migrated the navigation metadata from inline MD title decorations to frontmatter * fix: fixed frontmatter metadate for api-table MDs * fix: fixed frontmatter eslint issue
106 lines
2.8 KiB
JavaScript
106 lines
2.8 KiB
JavaScript
import fs from 'fs';
|
|
import { customElementsManifestToMarkdown } from '@custom-elements-manifest/to-markdown';
|
|
import matter from 'gray-matter';
|
|
|
|
/**
|
|
* @param {string} text
|
|
*/
|
|
function toSplitAndUpperCase(text) {
|
|
return text.replace(/(^\w|-\w)/g, clearAndUpper);
|
|
}
|
|
|
|
/**
|
|
* @param {string} text
|
|
*/
|
|
function clearAndUpper(text) {
|
|
return text.replace(/-/, ' ').toUpperCase();
|
|
}
|
|
|
|
const systemsTable = ['core', 'form-core', 'localize', 'overlays'];
|
|
const mappingTable = [{ componentDir: 'validate-messages', portalDir: 'form' }];
|
|
|
|
const componentDirs = fs
|
|
.readdirSync('./packages/ui/components')
|
|
.filter(d => !d.startsWith('_') && !d.startsWith('form-integrations'));
|
|
|
|
const customElementsJson = JSON.parse(
|
|
fs.readFileSync('./packages/ui/custom-elements.json', 'utf8'),
|
|
);
|
|
|
|
for (let dir of componentDirs) {
|
|
const isSystem = systemsTable.includes(dir);
|
|
const classes = fs
|
|
.readdirSync(`./packages/ui/components/${dir}/src/`)
|
|
.filter(f => {
|
|
if (isSystem) {
|
|
return f.endsWith('.js')
|
|
}
|
|
return f.endsWith('.js') && !f.endsWith('Manager.js') && !f.endsWith('Mixin.js')
|
|
})
|
|
.map(f => f.replace('.js', ''));
|
|
|
|
for (const component of mappingTable) {
|
|
if (dir === component.componentDir) {
|
|
dir = component.portalDir;
|
|
}
|
|
}
|
|
if (dir === 'form-core') {
|
|
dir = 'form';
|
|
}
|
|
|
|
const titleFromDir = toSplitAndUpperCase(dir);
|
|
const parts = ['API Table', titleFromDir];
|
|
if (isSystem) {
|
|
parts.push('Systems');
|
|
}
|
|
const title = `${titleFromDir}: API Table`;
|
|
const eleventyNavigation = {
|
|
key: parts.join(' >> '),
|
|
title: 'API Table',
|
|
order: 90,
|
|
parent: parts.slice(1).reverse().join(' >> ')
|
|
}
|
|
|
|
let dirApiTableMd = matter.stringify(`# ${title}`, {
|
|
parts,
|
|
title,
|
|
eleventyNavigation,
|
|
});
|
|
|
|
for (const c of classes) {
|
|
for (const mod of customElementsJson.modules) {
|
|
for (const declaration of mod.declarations) {
|
|
if (declaration.name === c && declaration.kind === 'class') {
|
|
const md = customElementsManifestToMarkdown(
|
|
{
|
|
modules: [
|
|
{
|
|
declarations: [declaration],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
private: 'hidden',
|
|
headingOffset: 0,
|
|
omitSections: [
|
|
'main-heading',
|
|
'super-class',
|
|
'static-fields',
|
|
'static-methods',
|
|
'mixins',
|
|
],
|
|
},
|
|
);
|
|
dirApiTableMd = `${dirApiTableMd} \n\n${md}`;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
const folder = isSystem ? 'fundamentals/systems' : 'components';
|
|
try {
|
|
fs.writeFileSync(`./docs/${folder}/${dir}/api-table.md`, dirApiTableMd);
|
|
} catch (e) {
|
|
console.error(`No api docs have been created, ${e}`);
|
|
}
|
|
}
|