mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-11-23 00:13:35 +01:00
52b48140fe
This allows <Class>.md beside <Class>.ts where we can add additional documentation such as examples
112 lines
2.9 KiB
JavaScript
112 lines
2.9 KiB
JavaScript
const customElementsManifest = require('../../dist/custom-elements.json');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
//
|
|
// Export it here so we can import it elsewhere and use the same version
|
|
//
|
|
module.exports.customElementsManifest = customElementsManifest;
|
|
|
|
//
|
|
// Gets all components from custom-elements.json and returns them in a more documentation-friendly format.
|
|
//
|
|
module.exports.getAllComponents = function ()
|
|
{
|
|
const allComponents = [];
|
|
|
|
customElementsManifest.modules?.forEach(module =>
|
|
{
|
|
module.declarations?.forEach(declaration =>
|
|
{
|
|
if (declaration.customElement)
|
|
{
|
|
// Generate the dist path based on the src path and attach it to the component
|
|
declaration.path = module.path.replace(/^src\//, 'dist/').replace(/\.ts$/, '.js');
|
|
|
|
// Remove members that are private or don't have a description
|
|
const members = declaration.members?.filter(member => member.description && member.privacy !== 'private') || [];
|
|
const methods = members?.filter(prop => prop.kind === 'method' && prop.privacy !== 'private') || [];
|
|
const properties = members?.filter(prop =>
|
|
{
|
|
// Look for a corresponding attribute
|
|
const attribute = declaration.attributes?.find(attr => attr.fieldName === prop.name);
|
|
if (attribute)
|
|
{
|
|
prop.attribute = attribute.name || attribute.fieldName;
|
|
}
|
|
|
|
return prop.kind === 'field' && prop.privacy !== 'private';
|
|
});
|
|
allComponents.push({
|
|
...declaration,
|
|
methods,
|
|
properties
|
|
});
|
|
}
|
|
});
|
|
});
|
|
|
|
// Build dependency graphs
|
|
allComponents.forEach(component =>
|
|
{
|
|
const dependencies = [];
|
|
|
|
// Recursively fetch sub-dependencies
|
|
function getDependencies(tag)
|
|
{
|
|
const cmp = allComponents.find(c => c.tagName === tag);
|
|
if (!cmp || !Array.isArray(component.dependencies))
|
|
{
|
|
return;
|
|
}
|
|
|
|
cmp.dependencies?.forEach(dependentTag =>
|
|
{
|
|
if (!dependencies.includes(dependentTag))
|
|
{
|
|
dependencies.push(dependentTag);
|
|
}
|
|
getDependencies(dependentTag);
|
|
});
|
|
}
|
|
|
|
getDependencies(component.tagName);
|
|
|
|
component.dependencies = dependencies.sort();
|
|
});
|
|
|
|
// Add custom docs - not monitored for file changes
|
|
allComponents.forEach(component =>
|
|
{
|
|
// Check for custom docs
|
|
const docPath = path.join('..', '..', path.dirname(component.path), component.name + ".md");
|
|
|
|
// Stick it in a variable so we can use the content filters
|
|
if (fs.existsSync(path.resolve(docPath)))
|
|
{
|
|
fs.readFile(docPath, (err, data) => component.content = data.toString());
|
|
}
|
|
})
|
|
|
|
// Sort by name
|
|
return allComponents.sort((a, b) =>
|
|
{
|
|
if (a.name < b.name)
|
|
{
|
|
return -1;
|
|
}
|
|
if (a.name > b.name)
|
|
{
|
|
return 1;
|
|
}
|
|
return 0;
|
|
});
|
|
};
|
|
|
|
module.exports.getShoelaceVersion = function ()
|
|
{
|
|
const shoelace = "@shoelace-style/shoelace"
|
|
|
|
const package = JSON.parse(fs.readFileSync('../../package.json', "utf8")) || {dependencies: {}}
|
|
return package.dependencies[shoelace] || "";
|
|
} |