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

feat(vue): web-types support #22428

Merged
merged 2 commits into from Nov 5, 2020

Conversation

piotrtomiak
Copy link
Contributor

@piotrtomiak piotrtomiak commented Nov 4, 2020

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue Number: resolves #19522

What is the new behavior?

This PR introduces bundling of web-types with @ionic/vue for in-editor documentation support. The web-types standard is an open source standard supported so far only by WebStorm and is bundled with various other Vue libraries, like vuetify, bootstrap-vue or quasar.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@github-actions github-actions bot added the package: vue @ionic/vue package label Nov 4, 2020
@liamdebeasi
Copy link
Contributor

Thank you! This looks great. I created a dev build and tested it in the latest version of WebStorm, and it is working well:

npm install @ionic/vue@5.5.0-dev.202011041734.2bd24d6 @ionic/vue-router@5.5.0-dev.202011041734.2bd24d6 --save-exact

Copy link
Contributor

@liamdebeasi liamdebeasi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small change, otherwise looks great.

packages/vue/scripts/build-web-types.js Outdated Show resolved Hide resolved
@liamdebeasi liamdebeasi changed the title #19522 Generate web-types for @ionic/vue during build feat(vue): web-types support Nov 4, 2020
Co-authored-by: Liam DeBeasi <liamdebeasi@users.noreply.github.com>
Copy link
Contributor

@liamdebeasi liamdebeasi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this! I will make sure this gets into our next minor release.

@liamdebeasi liamdebeasi merged commit 639314a into ionic-team:master Nov 5, 2020
@liamdebeasi
Copy link
Contributor

Merged. Thank you! This will be in our next minor release.

@piotrtomiak piotrtomiak deleted the generate-web-types branch November 6, 2020 12:36
@piotrtomiak
Copy link
Contributor Author

Thank you!

TakumaKira pushed a commit to TakumaKira/ionic-framework that referenced this pull request Nov 13, 2020
@aparajita
Copy link

aparajita commented Nov 18, 2020

Thank you @piotrtomiak! WebStorm rules!

@ddesmarais749
Copy link

I know this commit is old but seems like it is still an issues with Ionic v6.1.5. I can't get Webstorm autocomplete work.

Web-types.json is empty

The web-type.json in the "@Ionic" node_modules looks like this :

image

Can anyone help me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: vue @ionic/vue package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate web-types for @ionic/vue package
4 participants