fix: augment `vue` rather than `@vue/runtime-core`

StevenPewsey commented 1 month ago

Types of changes

[ ] Chore (a non-breaking change which is related to package maintenance)
[x] 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 https://github.com/vuejs/router/pull/2295, as well as https://github.com/nuxt/nuxt/pull/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.
[x] All new and existing tests are passing.

lihbr commented 1 month ago

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

StevenPewsey commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

@lihbr legend, thank you so much! ⭐

prismicio / prismic-vue