Skip to content

Document breaking changes in v4 and fix the readme #217

@Mister-Hope

Description

@Mister-Hope

v4 introduces a lot of ** breaking changes, and there is no migration guide.

For now, I feel pissed off when migrating to v4, just listing some of the issues here:

  1. The advanced part in readme is not updated at all

image

  1. The ReplStore class to useStore composable is ABSOLUTELY not a small refactor, a lot of option now requires ref proxies, and I don't think dropping support of constants can improve most users experience. Why should people being enforced to pass refs if they never want something change? VueUse always allow people to provide a MaybeRef if possible

  2. A lot of APIs has been removed, like a ref vueVersion should be passed if users want to change vue version instead of calling any API called setVueVersion. These changes should be listed clearly in release page or changelog instead of letting the user read through all codes and guess how to migrate themselves.

image

The related refactor is too huge to let people understand what's changing at a glance in web page.

  1. The behavior of import map seems to have undocumented breaking changes or bugs. When including a import map in an serializedState before, a empty import map works as expected. Now, I am getting errors like these:

image

image

There was an option called defaultVueRuntimeURL and it seems to be removed in v4, and I doubt why the builtinImportMap should have a empty default value instead of a importmap containing vue. I don't think why is there any need to let users force declare vue import. Please fix it or document the breaking change in release.


I hope @sxzz can done maintenance work nicely in the future without spoiling users' experience as this is a official package published under @vue scope.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions