Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Support jetbrains web-types standard #7674

Closed
KaelWD opened this issue Jun 26, 2019 · 7 comments · Fixed by #9440
Closed

[Feature Request] Support jetbrains web-types standard #7674

KaelWD opened this issue Jun 26, 2019 · 7 comments · Fixed by #9440
Labels
framework Issues and Feature Requests that have needs framework-wide. good first issue A quick-win fix that would be great for new contributors T: feature A new feature

Comments

@KaelWD
Copy link
Member

KaelWD commented Jun 26, 2019

Problem to solve

Code completion and hints in jetbrains IDEs

Proposed solution

Publish a web-types.json file to npm and link it in package.json

https://github.com/JetBrains/web-types
https://youtrack.jetbrains.com/issue/WEB-31682#comment=27-3538850

@KaelWD KaelWD added T: feature A new feature good first issue A quick-win fix that would be great for new contributors framework Issues and Feature Requests that have needs framework-wide. labels Jun 26, 2019
@ghost ghost added the S: triage label Jun 26, 2019
@KaelWD KaelWD removed the S: triage label Jun 26, 2019
@vaibhavhrt
Copy link

@KaelWD Looking to contribute, since it's labelled good first issue I guess it should be easy enough. I am new to vue and vuetify (coming from React and mui-org/material-ui) so some help will be appreciated.

@vaibhavhrt
Copy link

Unless it's already done as I see there is json for various versions of vuetify already on JetBrains/web-types repo.

@DRoet
Copy link
Contributor

DRoet commented Jul 18, 2019

@vaibhavhrt I think the idea is to create a script that automatically generates a new web-types.json file for every new vuetify release in the future.

The files located in JetBrains/web-types have been generated by the jetbrains team and might fall out of date eventually

@KaelWD
Copy link
Member Author

KaelWD commented Jul 18, 2019

We already have packages/api-generator for the documentation and vscode, so this would just be an addition to that to output a different format.

@vaibhavhrt
Copy link

@KaelWD thanks, I will take a look at it when I get home after work.

@vaibhavhrt
Copy link

@KaelWD , I have set up development environment and took a look at the api-generator code. It's quite a bit of code so might take a while to figure out whats going on and what to add to create one more file, so please be patient, it might take me a while before I open a PR.

@vaibhavhrt
Copy link

nvm created a PR, it's work in progress but created PR anyway so that I can receive some help and feedback.

johnleider pushed a commit that referenced this issue Oct 24, 2019
…ains IDEs (#9440)

* create intial web-types.json, doesn't matches the schema

* web-types in poper format, but names need captalization

* make linters happy

* don't change stuff in gitignore

* make linters even more happy

* convert name to pascal case

* add schema

* feat: Properly transform components and directives to match schema.

* feat(web-types): add source property for components

* feat(web-types): improve directives metadata

* feat(web-types): include web-types in vuetify dist

closes #7674
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework Issues and Feature Requests that have needs framework-wide. good first issue A quick-win fix that would be great for new contributors T: feature A new feature
Projects
None yet
3 participants