Uh oh!
There was an error while loading. Please reload this page.
docs(data-objectstack): describe the real dependency contract, not a peer one - #4127
Merged
Merged
Conversation
…peer one (#3781) The page claimed `@objectstack/client` is a peer dependency that must be installed separately, and listed a `react` peer dependency. Neither is true: `packages/data-objectstack/package.json` declares no `peerDependencies` key at all, carries `client` and `spec` as regular dependencies, and mentions `react` only in `keywords` — the package is headless and imports React nowhere. Three sites corrected: - install line drops `@objectstack/client` (it resolves with the package); - the "peer dependency ... must be installed separately" note becomes a truthful one-liner; - the Dependencies list drops the `react` bullet outright, relabels the `client` bullet, and gains the two regular dependencies it had been omitting (`@objectstack/spec`, `@object-ui/core`), so the section now matches the manifest exactly. Docs-only; the manifest is deliberately untouched per the maintainer's split ruling on #3781 (whether `client` *should* be a peer was declined without measured pain). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017Qqyix2QcnpUC9XeYVDzx3
The latest updates on your projects. Learn more about Vercel for GitHub. |
yinlianghui
marked this pull request as ready for review
August 10, 2026 11:20
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes#3781
Docs-only. Aligns
content/docs/utilities/data-objectstack.mdxwith the manifest as it is — the manifest is deliberately untouched, per the split ruling on the card.Premise re-verified on
origin/main=cfeb378b5packages/data-objectstack/package.json:peerDependencieskey at all — stronger than the card's"peerDependencies": {}, same conclusion: the package declares no peers;@objectstack/clientand@objectstack/specare regulardependencies(alongside@object-ui/coreand@object-ui/types);reactappears in no dependency field — only inkeywords.grep -rn react packages/data-objectstack/src/returns two prose comments naming the separate@object-ui/reactpackage and nothing else, so the package imports React nowhere. Its dependency closure is React-free too:@object-ui/coreand@object-ui/typesboth declarepeerDependencies: {}.Premise holds: the docs were wrong, the manifest was not.
The three sites
:13installnpm install @object-ui/data-objectstack @objectstack/clientnpm install @object-ui/data-objectstack:16note:456bulletsclientandreactboth labelled(peer dependency)reactbullet deleted outright;clientrelabelledOne addition beyond the card's three sites, from its own instruction to cross-check the whole page for dependency-contract prose: the Dependencies section listed only 2 of the package's 4 regular dependencies. Since the
reactbullet was being deleted from that exact list, the two omitted ones (@objectstack/spec,@object-ui/core) were added, so the section now matches the manifest line for line.Page-wide cross-check
grep -i "peer" / "installed separately"over the file: the only surviving match is the new truthful sentence. Repo-wide, the only other peer-dependency prose incontent/docs/isguide/troubleshooting.md:70("ObjectUI packages declare React 18+ as a peer dependency") — left alone because it is true: 20+ packages do declare a react peer.data-objectstackis the headless adapter that correctly does not, which is exactly how the false bullet got copied onto this page.Verification
pnpm turbo run build --filter=@object-ui/site(Build Docs equivalent)29 successful, 29 totalin 3m11snode scripts/check-doc-links.mjsLinks are valid across 7 scan roots.node scripts/check-control-bytes.mjsOK (scanned 3827 tracked text file(s); skipped 85 binary)node scripts/check-changeset-presence.mjsNo source of a released package changed in this range, so no changeset is owed.Rendered-output check on the built page (
apps/site/.next/server/app/docs/utilities/data-objectstack.html): none of the three false claims render any more, and the four corrected bullets do. Changeset: none owed, per the presence script's own arbitration (docs-only, no released packagesrc/touched).Out-of-scope findings (filed, not fixed here)
ObjectStackProvider/useObjectStackReact API the package does not export. It is headless; the real surface iscreateObjectStackAdapter/ObjectStackAdapter. Concrete defect, needs its own rewrite.**Version:** 0.3.1hardcoded on this page and onvscode-extension.mdxwhile both packages are at17.4.0. Filed asfinding.Not done, deliberately
The manifest-side half of #3781 — whether
@objectstack/clientshould become a peer so hosts share one client instance — stays with the maintainer and was declined without measured pain. Today's change makes the docs true under the contract that ships now; if that ruling ever flips, the docs flip back as part of that change.Generated by Claude Code