docs(vue): Update README for Vue docs, plugin setup and testing - #4204
Conversation
Link Vue pages at /vue, show DataClientPlugin setup, fix the useLive example (it must be awaited), drop React-only APIs (useCancelling, AsyncBoundary, ErrorBoundary), add Examples, testing and missing composables. Fix shared typos and getList.push args in the root and React READMEs. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CjHAoyedug9sFPmBbb8uJk
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Staff engineer (Cursor agent): LGTM. README-only, no follow-ups. Checked against tip 0213cd3:
|
|
Size Change: 0 B Total Size: 103 kB ℹ️ View Unchanged
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4204 +/- ##
=======================================
Coverage 98.10% 98.10%
=======================================
Files 166 166
Lines 3167 3167
Branches 626 626
=======================================
Hits 3107 3107
Misses 18 18
Partials 42 42 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Requested by Nathaniel · project thread
Motivation
The
@data-client/vueREADME (shown on npm and GitHub) sent Vue users to the React docs, never showed how to install the plugin, listed React-only APIs, and had auseLive()example that doesn't work (it returns a Promise, so the template readundefined).Solution
packages/vue/README.md:/vue/...).app.use(DataClientPlugin)and links the Vue installation page.useLive()example is awaited:<Suspense>.import.meta.env.DEV(Vite) and fixture args that matchArticleResource'ssearchParams.renderDataCompose(), and an Examples section forvue-todo-app.useCancelling,<AsyncBoundary/>,<ErrorBoundary/>(not exported by the Vue package); addedDataClientPlugin,getDefaultManagers,useFetch,useSubscription, and the@data-client/vue/testutilities; every entry linked.Root and React READMEs: fixed "resouce definitons" / "gziped" typos and
ctrl.fetch(ArticleResource.getList.push, { id }, article), which passed anidthatgetListdoesn't take; it's nowctrl.fetch(ArticleResource.getList.push, article).No changeset: README-only.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CjHAoyedug9sFPmBbb8uJk
Generated by Claude Code
Note
Low Risk
README-only documentation; no runtime, API, or build changes.
Overview
packages/vue/README.mdis reworked so npm/GitHub readers get Vue-specific guidance instead of React doc links. Doc URLs now use/vue/..., installation showsapp.use(DataClientPlugin), and examples fixawait useLive()(it returns a Promise) plus a short<Suspense>note for async setup. Mocking usesimport.meta.env.DEVand list fixture args that matchsearchParams. New sections cover composable testing withrenderDataCompose(), a vue-todo-app example, and an API/features list that drops React-only exports and links Vue setup, rendering, and@data-client/vue/testutilities.Root
README.mdandpackages/react/README.mdget small copy fixes: typos (“resource definitions”, “gzipped”) andctrl.fetch(ArticleResource.getList.push, article)without a spurious{ id }arg on list push.Reviewed by Cursor Bugbot for commit 0213cd3. Bugbot is set up for automated code reviews on this repo. Configure here.