chore: update readme, add migration steps #257
Conversation
this pr add a clear migration steps from v2 to @tanstack/vue-query
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 3dc03b1:
|
|
Kudos, SonarCloud Quality Gate passed!
|
There was a problem hiding this comment.
Suggested steps:
- In your package.json, replace
"vue-query": "2.x"with"@tanStack/vue-query": "4.19.x" - Install your dependencies (e.g.
npm install). - Change all
vue-queryimports to use@tanstack/vue-queryThis can be achieved easily using VS Code find and replace functionality.
| @@ -15,6 +15,15 @@ If you are still on `v1` make sure to follow [migration guide](https://vue-query | |||
|
|
|||
| If you are already on `v2`, just swap `vue-query` for `@tanstack/vue-query` in both of your `package.json` and `import` statements. Everything should still work as before. | |||
|
|
|||
| steps to move to `@tanstack/vue-query` from `vue-query` v2 | |||
|
|
|||
| 1. delete your `node_modules` | |||
There was a problem hiding this comment.
Unnecessary step, node_modules will be modified correctly when running npm install after editing package.json
| steps to move to `@tanstack/vue-query` from `vue-query` v2 | ||
|
|
||
| 1. delete your `node_modules` | ||
| 2. delete your `lock` file |
There was a problem hiding this comment.
Unnecessary step, lock file will be modified correctly when running npm install after editing package.json
There was a problem hiding this comment.
Not only is this unnecessary, but it could also have unintended consequences by potentially version bumping unrelated packages in the repo in question.
| 1. delete your `node_modules` | ||
| 2. delete your `lock` file | ||
| 3. remove `vue-query` from your package-json | ||
| 4. install deps |
There was a problem hiding this comment.
The order of this step should be after adding @tanstack/vue-query to package.json
| 2. delete your `lock` file | ||
| 3. remove `vue-query` from your package-json | ||
| 4. install deps | ||
| 5. install `@tanstack/vue-query` |
There was a problem hiding this comment.
Should be merged with step 3 (or right after). Like this:
3. Replace "vue-query": "2.x" with "@tanStack/vue-query": "4.19.x" in package.json
4. Run npm install
this pr add a clear migration steps from
v2to@tanstack/vue-query