docs: mention retry plugin in tvq migration guide

[87xie]

I used the retry plugin when migrating from TanStack Query to Pinia Colada. Mentioning this difference in the migration guide might be helpful.

Additionally, I would like to write some test cases for the retry plugin. Would it be okay to submit a PR for that? Thank you!

Summary by CodeRabbit

• Documentation
  • Enhanced the migration guide with updated instructions on implementing retry functionality. Users now receive guidance on leveraging a dedicated plugin to enable reliable retry logic during the migration process.

[coderabbitai]

Walkthrough

The update modifies the migration guide in the documentation by adding a new row in the API Differences section. It details that the useQuery({ retry }) option, previously part of @tanstack/vue-query, now requires the Retry plugin from @pinia/colada-plugin-retry when migrating to @pinia/colada.

Changes

File(s)	Change Summary
docs/cookbook/migration-tvq.md	Added a new API Differences entry for useQuery({ retry }), indicating its usage with the @pinia/colada-plugin-retry for implementing retry logic.

Suggested reviewers

• posva

Poem

I hop through code with gentle cheer,
A new retry option now appears.
With Colada’s plugin shining bright,
Migrations sparkle in the light.
From rabbit lips, a code delight!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for funny-banoffee-0afb46 ready!

Name	Link
🔨 Latest commit	c92897c
🔍 Latest deploy log	https://app.netlify.com/sites/funny-banoffee-0afb46/deploys/67ed84d76b997d0008e5850d
😎 Deploy Preview	https://deploy-preview-248--funny-banoffee-0afb46.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/cookbook/migration-tvq.md (1)

37-37: Review of the Newly Added Retry Plugin Row

The new row for useQuery({ retry }) is well integrated into the existing API Differences table. The entry clearly indicates that users should utilize the @pinia/colada-plugin-retry and follows the established format used for similar rows (e.g., the Auto Refetch plugin entry). For further clarity, you might consider adding a brief note on what the retry plugin specifically addresses or any nuances in its usage compared to the previous implementation. This additional detail could help users better understand the migration impact.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 340d34e and c92897c.

📒 Files selected for processing (1)

• docs/cookbook/migration-tvq.md (1 hunks)

[posva]

Of course! Glad to have more tests!