feat: create a 'web-types' doc output target

[duhem-s]

Prerequisites

• I have read the Contributing Guidelines.
• I agree to follow the Code of Conduct.
• I have searched for existing issues that already include this feature request, without success.

Describe the Feature Request

I would like to propose the addition of a new feature to Stencil, which is the ability to export web-types alongside the existing VS Code documentation export.

Describe the Use Case

Currently, Stencil provides an export feature for VS Code documentation, which is immensely helpful for providing auto-completion and documentation support within VS Code. However, it would be beneficial to extend this functionality to include web-types, which would facilitate auto-completion and documentation support in other IDEs such as WebStorm.

Describe Preferred Solution

I envision the preferred solution as an enhancement to the existing Stencil build system to generate web-types metadata in addition to the current VS Code documentation. This could be achieved by introducing a new build target that generates web-types-compatible metadata files alongside the existing VS Code documentation files. This feature would greatly enhance the usability of Stencil components across a wider range of development environments.

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

[rwaskiewicz]

Thanks! I've marked this to ingest it into our internal backlog

[rwaskiewicz]

As a hack day project, I created https://github.com/stencil-community/stencil-web-types. Feel free to give that go! Feedback welcome!

[duhem-s]

As a hack day project, I created https://github.com/stencil-community/stencil-web-types. Feel free to give that go! Feedback welcome!

Looks nice, thanks for the project.
Now I'm wondering why this is not included in Stencil builds since it provides a vscode build.

[rwaskiewicz]

Now I'm wondering why this is not included in Stencil builds since it provides a vscode build.

The reason it's not in Stencil today is that it's still early on/experimental. I'm maintaining it as a hack day project (I'll be working on it again in ~3 weeks for our next hack days). If folks are actively using it, we'll probably fold it into Stencil Core at some point.

[christian-bromann]

Thanks @rwaskiewicz for contributing this awesome plugin! Let's continue further discussions in that project. So if anyone runs into issues or would like to add features, raise an issue there and we can take it from there.