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

fix: augment vue rather than @vue/runtime-core #71

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

StevenPewsey
Copy link
Contributor

Types of changes

  • Chore (a non-breaking change which is related to package maintenance)
  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

For a while, in the Vue ecosystem we've been augmenting @vue/runtime-core to add custom properties and more to vue. However, this inadvertently breaks the types for projects that augment vue - which is (now?) the officially recommended in the docs way to augment these interfaces (for example, ComponentCustomProperties, GlobalComponents and so on).

This means all libraries must update their code (or it will break the types of the libraries that augment vue instead).

Here's an example of how the augmented types end up broken.

This PR is a small effort to ensure the ecosystem is consistent. For context, you can see that vue-router has vuejs/router#2295, as well as nuxt/nuxt#28542.

Checklist:

  • My change requires an update to the official documentation.
  • All TSDoc comments are up-to-date and new ones have been added where necessary.
  • All new and existing tests are passing.

@lihbr
Copy link
Member

lihbr commented Aug 28, 2024

Thank you so much! We'll release that soon ☺️

@lihbr lihbr merged commit fc66c4b into prismicio:master Aug 28, 2024
@StevenPewsey StevenPewsey deleted the SP/fix-vue-augment branch August 28, 2024 13:43
@StevenPewsey
Copy link
Contributor Author

StevenPewsey commented Sep 15, 2024

Hey @lihbr, thanks for merging! Do you know when this is going to be released?

This is preventing us from upgrading to the latest version of nuxt 😔

@lihbr
Copy link
Member

lihbr commented Sep 16, 2024

Hi @StevenPewsey, thanks for pinging me! I was hoping #72 would get in faster but the other teams aren't there yet.

Anyway, just released a patch with your PR 🎉 4.2.3 is out~!

@StevenPewsey
Copy link
Contributor Author

@lihbr legend, thank you so much! ⭐

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants