Research: Custom Elements Manifest

[ilhan007]

Feature Request Description

Custom Elements Manifest is a file format that describes the custom elements in your project. This format will allow tooling and IDEs to give rich information about the custom elements in a given project. It's a JSON file, called custom-elements.json containing metadata about the custom elements in your project; their properties, methods, attributes, inheritance, slots, CSS Shadow Parts, CSS custom properties, and a modules exports.

Tasks

• do a research regarding the format
• generate custom-elements.json out of our docs (even for a single class is ok)
• find a way to test it with IDEs (this example looks promising)

Additional context

In order to allow tools to find npm packages with custom element manifests without having to download package tarballs, packages should have a "customElements" field in their package.json that points to the manifest:

{
  "name": "example-package",
  "customElements": "custom-elements.json",
}

Example of custom-elements.json can be found here.

Priority

• Low
• Medium
• High
• Very High