[framework]: use Custom Elements Manifest analyzer to generate custom-elements-manifest.json

[ilhan007]

Feature Request Description

Currently, we use a private JSDoc plugin to analyse the JSDoc to generate the so called api.json describing the API of all the components.

Based on the api.json we generate:

• custom-elements-manifest.json
• SAPUI5 control wrappers
• ui5-webcomponents-react React wrappers
• ui5-webcomponents-ngx Angular wrappers

While this setup is working, it requires certain knowledge of adding proper JSDoc to get the right output when developing web components. And, especially the namespace part that should be present, f.e "sap.ui.webc.main" and used everywhere and the slightest typo would lead to wrong generation.

Proposed Solution

As the custom-elements-manifest.json is a standard schema for describing web components, ideally we could use the @custom-elements-manifest/analyzer to output the JSON file and not rely on the JSDoc and the private JSDoc plugin.
By default, the analyser supports standard JavaScript, and vanilla web components. Dedicated web component libraries like ours can be supported through the use of plugins as explained here https://custom-elements-manifest.open-wc.org/analyzer/getting-started. If we can make the analyser work, we can then either get rid of the "api.json" and use directly the custom-elements-manifest.json and adopt it in wrappers generators, or keep the "api.json" as before, but generate it out of the custom-elements-manifest.json.

Proposed Alternatives

No response

Additional Context

No response

Priority

High

Privacy Policy

• I’m not disclosing any internal or sensitive information.