Skip to content

docs(vue): Update README for Vue docs, plugin setup and testing - #4204

Merged
ntucker merged 1 commit into
masterfrom
claude/project-thread-j9u92t
Oct 5, 2026
Merged

ntucker merged 1 commit into
masterfrom
claude/project-thread-j9u92t

Conversation

@ntucker

@ntucker ntucker commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Requested by Nathaniel · project thread

Motivation

The @data-client/vue README (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 a useLive() example that doesn't work (it returns a Promise, so the template read undefined).

Solution

packages/vue/README.md:

  • Every docs link now points at the Vue docs (/vue/...).
  • Installation shows app.use(DataClientPlugin) and links the Vue installation page.
  • useLive() example is awaited:
// Before
const price = useLive(PriceResource.get, { symbol: props.symbol });
// After
const price = await useLive(PriceResource.get, { symbol: props.symbol });
  • One-line note that awaiting components render inside Vue's <Suspense>.
  • Mocking example uses import.meta.env.DEV (Vite) and fixture args that match ArticleResource's searchParams.
  • New "Testing composables" example with renderDataCompose(), and an Examples section for vue-todo-app.
  • Features: Suspense, fixture mocking for tests (replaces the React-only Storybook link), and garbage collection on by default.
  • API list: removed useCancelling, <AsyncBoundary/>, <ErrorBoundary/> (not exported by the Vue package); added DataClientPlugin, getDefaultManagers, useFetch, useSubscription, and the @data-client/vue/test utilities; every entry linked.

Root and React READMEs: fixed "resouce definitons" / "gziped" typos and ctrl.fetch(ArticleResource.getList.push, { id }, article), which passed an id that getList doesn't take; it's now ctrl.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.md is reworked so npm/GitHub readers get Vue-specific guidance instead of React doc links. Doc URLs now use /vue/..., installation shows app.use(DataClientPlugin), and examples fix await useLive() (it returns a Promise) plus a short <Suspense> note for async setup. Mocking uses import.meta.env.DEV and list fixture args that match searchParams. New sections cover composable testing with renderDataCompose(), a vue-todo-app example, and an API/features list that drops React-only exports and links Vue setup, rendering, and @data-client/vue/test utilities.

Root README.md and packages/react/README.md get small copy fixes: typos (“resource definitions”, “gzipped”) and ctrl.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.

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
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@ntucker ntucker self-assigned this Oct 5, 2026
@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-site Ready Ready Preview Oct 5, 2026 7:48pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 0213cd3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

ntucker commented Oct 5, 2026

Copy link
Copy Markdown
Collaborator Author

Staff engineer (Cursor agent): LGTM. README-only, no follow-ups.

Checked against tip 0213cd3:

  • Every new /vue/... link resolves to a page that exists in docs/core (the Vue instance renders all of it), including /vue/guides/unit-testing-composables from the slug docs: Generate DevTools MCP and Vue testing skill references from docs #4181 already merged. The Controller anchors (#fetchIfStale, #setResponse, etc.), #async-fallbacks, #boundaries and DataClientPlugin#gcPolicy all match explicit heading ids.
  • await useLive(...) is right: Vue's useLive() is async and returns Promise<ComputedRef>.
  • The renderDataCompose() example matches its signature (awaited, result is what the composable returns, so await result then .value).
  • Fixture args: [{ author: '10' }] matches ArticleResource's searchParams, and dropping { id } from getList.push is correct since getList has no id param.
  • Removing useCancelling, <AsyncBoundary/> and <ErrorBoundary/> from the Vue API list is right; they aren't exported by @data-client/vue.

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Size Change: 0 B

Total Size: 103 kB

ℹ️ View Unchanged
Filename Size
examples/test-bundlesize/dist/App.js 1.46 kB
examples/test-bundlesize/dist/polyfill.js 307 B
examples/test-bundlesize/dist/rdcClient.js 10.9 kB
examples/test-bundlesize/dist/rdcEndpoint.js 8.07 kB
examples/test-bundlesize/dist/rdcNextjs.js 12.3 kB
examples/test-bundlesize/dist/rdcPipeableStream.js 9.64 kB
examples/test-bundlesize/dist/react.js 59.7 kB
examples/test-bundlesize/dist/webpack-runtime.js 784 B

compressed-size-action

@codecov

codecov Bot commented Oct 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.10%. Comparing base (cc5d178) to head (0213cd3).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ntucker
ntucker merged commit a51e745 into master Oct 5, 2026
26 checks passed
@ntucker
ntucker deleted the claude/project-thread-j9u92t branch October 5, 2026 19:56

This branch was successfully deployed

1 active deployment
Preview — 0213cd3a Deployed Oct 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants