docs: release 2.10.0

[ymc9]

Summary by CodeRabbit

• Documentation
  • Updated documentation for the @zenstackhq/tanstack-query plugin to clarify the functionality of generated hooks.
  • Enhanced explanations on return values, query key management, query cancellation, and optimistic updates.
  • Improved examples for using query and mutation hooks across React, Vue, and Svelte frameworks.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 5, 2024 7:57am

[coderabbitai]

Walkthrough

The pull request updates the documentation for the @zenstackhq/tanstack-query plugin, focusing on clarifying the functionality of the generated hooks. Key modifications include changes to the return values of query and mutation hooks, the addition of query key information, details on query cancellation, expanded guidance on optimistic updates, and enhanced examples for context providers across multiple frameworks.

Changes

File Path	Change Summary
docs/reference/plugins/tanstack-query.mdx	Updated documentation detailing: return values of hooks, query key, query cancellation, optimistic updates, context provider examples, and refined usage examples across React, Vue, and Svelte.

Possibly related PRs

• docs: add FAQ to tanstack-query #385: The changes in this PR enhance the documentation for the @zenstackhq/tanstack-query plugin, which is directly related to the updates made in the main PR regarding the functionality of generated hooks.
• doc: fix installation instructions for tanstack-query and swr plugins #388: This PR addresses installation instructions for the tanstack-query plugin, which is relevant to the main PR's focus on the @zenstackhq/tanstack-query plugin and its usage.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/reference/plugins/tanstack-query.mdx (1)

691-705: Consider adding error handling example for query cancellation

While the new section on query cancellation is well-documented, it would be beneficial to show how to handle potential errors during cancellation.

Consider adding an example like this:

 function onCancel() {
-    queryClient.cancelQueries({ queryKey, exact: true });
+    try {
+        queryClient.cancelQueries({ queryKey, exact: true });
+    } catch (error) {
+        console.error('Failed to cancel query:', error);
+    }
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 61e2cc4 and b558028.

⛔ Files ignored due to path filters (1)

• package.json is excluded by !**/*.json

📒 Files selected for processing (1)

• docs/reference/plugins/tanstack-query.mdx (3 hunks)

🔇 Additional comments (3)

docs/reference/plugins/tanstack-query.mdx (3)

55-58: LGTM: Clear explanation of query hook return values

The documentation clearly explains that query hooks return a standard TanStack Query result with an additional queryKey field, and properly documents the data field content.

---

70-70: LGTM: Clear explanation of mutation hook return values

The documentation accurately describes the mutation hook return value and provides a good example of the mutation argument format.

---

685-689: LGTM: Good addition of queryKey field documentation

The documentation properly explains that query hooks return the queryKey in the result object and provides a clear example of destructuring it.