Generate web-types for ant-design-vue package for rich code assist in IDE

[piotrtomiak]

• I have searched the issues of this repository and believe that this is not a duplicate.

What problem does this feature solve?

This is a feature request to include web-types metadata information with ant-design-vue library to provide users of WebStorm (and possibly other IDEs in the future) with precise code completion, inspections and documentation for the components. There has already been 2 requests by users of ant-design-package: JetBrains/web-types#13 and JetBrains/web-types#11

What does the proposed API look like?

The best solution would be to generate the file based on existing documentation JSONs during the build process and ship it with the library. This solution has been implemented in quasar and bootstrap-vue libraries and is being worked on in vuetify.

I can work on the transformation code itself, but it would be pretty difficult for me to hook into the build process in the correct place, so I need some help from your side, before I can create a PR for this. Additionally we can generate web-types for older versions of library and publish them to @web-types/ scope so that consumers of older versions of library can also benefit from better code assist.

[rxliuli]

这对于 WebStorm 的代码提示相当重要，希望能添加支持。。。

[piotrtomiak]

Here is how code completion will look like with WebStorm 2019.3 and bootstrap-vue 2.1.0:

I think would be a really great help for developers to have such a support for your library.

[toleberdyyeva]

Is there any updates on that issue ?

[bigBron]

Is anyone following up on this issue?

[piotrtomiak]

@bigBron I am waiting for some help from the maintainers to start with.

[bigBron]

This is the web-types implementation of vuetify.
https://github.com/vuetifyjs/vuetify/blob/c2734d3e7721ad794de84c89ce0486869580742c/packages/api-generator/src/index.js#L331-L461

[piotrtomiak]

@bigBron I've actually authored most of that code ;) What I need to know to start is how the documentation is generated? With this information I can plug-in to the build process and generate web-types.json

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.