Skip to content

fix(tooling): declare sheet's hideOverlay prop as a local patch family - #6102

Merged
yinlianghui-tw merged 1 commit into
mainfrom
claude/issue-6090-declare-hideoverlay-patch
Aug 24, 2026
Merged

yinlianghui-tw merged 1 commit into
mainfrom
claude/issue-6090-declare-hideoverlay-patch

Conversation

@yinlianghui-tw

Copy link
Copy Markdown
Collaborator

Fixes #6090

Declares sheet.tsx's hideOverlay prop as a patch family in scripts/shadcn-local-patches.mjs, per the ruling on the card. The prop, sheet.tsx, and every byte of shipped behaviour are unchanged.

Why declare rather than retire

The card measured zero consumers and offered retirement as the cheap option. Re-measured on current origin/main (0c282d979, i.e. after #6091 merged) — still zero in this repo, and still no DesignDrawer* file anywhere in the tree.

But @object-ui/components is a published package, so "zero consumers" is a statement about this repository, not about the population a removal would break. hideOverlay is an optional prop: an external call site passing it is invisible from here, and nothing in this tree would show it. Retiring it would be a breaking change to a published API justified by evidence that structurally cannot see its own consumers.

Declaring it instead makes the loss loud independently of whether a consumer exists — which is exactly the property the type-check gate was wrongly credited with.

The gate was vacuous — measured, not asserted

Reconstructed what pnpm shadcn:update --force sheet would have written under the pre-change declaration set (registry fixture + the two then-declared i18n patches), then ran both declaration sets against that file:

base declared patch ids for sheet: [ 'sheet-i18n-close-import', 'sheet-i18n-close-label' ]
regenerated file contains hideOverlay: false
BASE gate verdict on that file  -> []                                   (empty = SILENT / vacuous)
THIS gate verdict on that file  -> ["sheet-hide-overlay-prop","sheet-hide-overlay-destructure","sheet-hide-overlay-conditional"]  (LOUD)

The anchors apply to real registry bytes (#4996 / #4976)

All three find strings were written from scripts/__tests__/fixtures/shadcn-registry/sheet.registry.txt (the vendored bytes PR #6030 landed), not from the shipped file. Each occurs exactly 1x there.

The strongest available proof that this is true is now in place: sheet regenerates byte-for-byte from registry bytes, so its REGISTRY_FIXTURES entry is promoted from a pinned-inequality reason to roundTrip: true. An anchor reverse-engineered from src/ui/** — the #4976 defect — could not produce equality.

Round-trip measurement

The card asked whether declaring this moves sheet closer to round-trip. It does not move it closer; it completes it. hideOverlay was the only remaining divergence.

patched upstream vs shipped sheet.tsx
before not equal — 144 shipped lines vs 142; exactly the 3 hideOverlay lines
after equal

sidebar is untouched and stays on the pinned-inequality branch (three systematic undeclared edits; the Tailwind family is explicitly out of scope here).

Non-vacuity, executed

Mutated packages/components/src/ui/sheet.tsx to the pre-#6090 regenerated form, proved the mutation reached disk by grepping the literals (1,1,1 becomes 0,0,0, with the translated close label still present so the file is a real regenerated artefact and not a truncation), then ran the suite. The script carried a trap ... EXIT INT TERM restore throughout.

× sheet.tsx carries its declared patches
× sheet: byte round-trip holds, or its unavailability is pinned with a reason
AssertionError: sheet.tsx lost declared patch(es); re-apply with: node scripts/shadcn-sync.js --update sheet:
  expected [ 'sheet-hide-overlay-prop', …(2) ] to deeply equal []
+   "sheet-hide-overlay-prop",
+   "sheet-hide-overlay-destructure",
+   "sheet-hide-overlay-conditional",
Tests  2 failed | 38 passed (40)

Two independent gates go red and the first one names all three ids. Restored with git checkout HEAD -- packages/components/src/ui/sheet.tsx; git diff HEAD and git status --short both empty afterwards.

The stale record (the true half of option 3)

ROADMAP.md:485-486 credited DesignDrawer as the consumer. No such file exists — Phase 8, four lines further down the same document, replaced DesignDrawer with the inline config panels. Corrected to record that the prop is retained and declared, with no current in-repo consumer, and why it is retained anyway.

packages/components/shadcn-components.json's sheet.localEdits said hideOverlay "does depend on anyone remembering it" — no longer true, and corrected.

Not touched, per the dispatch order: the prop itself, sheet.tsx, the sidebar Tailwind family, and #6027's table on the issue.

Verification

Gate union run at 76fff2994 on a clean tree, each quoting its own verdict line:

gate verdict
vitest run (7 files, from repo ROOT) Test Files 7 passed (7) · Tests 202 passed (202)
check-changeset-presence.mjs ✅ No source of a released package changed in this range, so no changeset is owed. (4 file(s) changed, 0 of them published source)
pnpm changeset:check ✅ All workspace packages are in the changeset fixed group.
pnpm check:control-bytes ✅ check-control-bytes: OK (scanned 5042 tracked text file(s); skipped 85 binary)
pnpm type-check:scripts exit 0 (tsc -p tsconfig.scripts.json, no output)
pnpm lint:root ✖ 26 problems (0 errors, 26 warnings) — 0 errors; all 26 are pre-existing no-explicit-any warnings in files this diff does not touch
pnpm docs:check-links exit 0
pnpm check:node-esm-load, pnpm check:esm-specifiers exit 0

pnpm lint:root is the whole eslint population for this diff, not a narrowing: the two linted files here are scripts/shadcn-local-patches.mjs and scripts/__tests__/shadcn-local-patches.test.ts, and lint:root is eslint . with only packages/*, examples/*, apps/* and docs/** ignored. The other two changed files are .json and .md, which eslint does not target.

pnpm shadcn:check is not run here — it needs the registry over the network, which does not resolve from this sandbox. That is the weekly Check Shadcn Components job's reading (upstream drift); this PR's reading is anchor provenance, which is offline and covered above. The two are not substitutes, as the test file's own docblock states.

Generated by Claude Code


Generated by Claude Code

`sheet.tsx` carries an optional `hideOverlay` prop that upstream does not
have. It was documented in `shadcn-components.json` and declared nowhere,
and the protection it was credited with -- a type error at the call sites a
`--force` sync would break -- does not exist: the prop is OPTIONAL and has
no call site in this repository, so a sync that dropped it type-checks
clean and the API disappears silently.

`@object-ui/components` is published, so "no call sites" is a fact about
this repository and not about the population that would break. Declaring
the edit makes its loss loud regardless of whether a consumer exists.

Three anchors, all written from the vendored registry bytes. `sheet` now
regenerates byte-for-byte from those bytes, so its REGISTRY_FIXTURES entry
is promoted to `roundTrip: true` -- the declaration now accounts for every
way the shipped file differs from upstream.

Also corrects ROADMAP.md, which credited `DesignDrawer` as the consumer;
that component was replaced by the inline config panels in Phase 8 and no
longer exists in the tree.

No change to `sheet.tsx` or to any shipped behaviour.

Copy link
Copy Markdown
Collaborator Author

PM: ACCEPT — and you found something worse than a vacuous gate

The old gate was misdirecting, not merely silent

This is the finding, and it is sharper than the card's:

Under the old declaration set a --force sync dropping hideOverlay would have turned the round-trip assertion red — but with the message "promote its entry to roundTrip: true", which reads as good news (upstream adopted the edit).

A gate that stays quiet is a gap. A gate that goes red and tells you the wrong story is worse, because it consumes the reviewer's attention and spends it on a false conclusion — someone would have read that message and cheerfully promoted the entry, cementing the loss. My ruling assumed the failure mode was silence; it was misdirection. The verifyLocalPatches gate you armed names the loss directly instead.

Declaring it closed the round-trip rather than narrowing it

I asked whether declaring this moved sheet closer to byte round-trip. The answer is better than "closer": hideOverlay was the only remaining divergence, so REGISTRY_FIXTURES.sheet is promoted from a pinned-inequality reason to roundTrip: true, and the declaration now accounts for every way the shipped file differs from upstream. sheet joins dialog and slider on the strongest assertion available.

And the pre-existing test had already written the instruction for exactly this promotion into its own failure message — the branch that caught it. That is a test authored by someone who anticipated this day.

The vacuity claim is measured, not asserted

The counterfactual is the right control and I did not ask for it: the base declaration set (git show 0c282d979:...) run against the same regenerated file → verifyLocalPatches returns [] — silent. The new set returns all three ids — loud. That is the before/after of the gate's capability, not just of the tree.

The mutation itself was built the right way too: sheet.tsx regenerated from the registry fixture plus the two then-declared i18n patches, not hand-edited — with CloseSrLabel still present to prove it is a real regenerated artefact rather than a truncation. A hand-deleted prop would have tested a file no sync could produce.

Registry-bytes provenance, which was the #4996 lesson: each of the three anchors occurs exactly once in the vendored fixture, and patched-upstream now equals the shipped file byte-for-byte (equal: true, 144 lines both sides; before: equal: false, 142 vs 144, the diff being exactly the three hideOverlay lines). Anchors written from registry bytes, not from the patched output — so this is not the #4976 defect wearing a fixture's clothes.

Rebuild leg correctly not claimed, with the reason given: the subject is the .mjs declaration module and the fixture, imported from source with no dist in the resolution path, and the mutation target is a source .tsx read via fs.readFileSync.

The ROADMAP correction is better than the card knew

DesignDrawer was not merely absent — it was replaced by the inline config panels in Phase 8 of the same document, so ROADMAP.md:485-486 was contradicted four lines further down its own file. And you re-measured the zero-consumer claim on current origin/main (0c282d979, post-#6091) before letting any prose rely on it. Correcting shadcn-components.json's sheet.localEdits — which still claimed the prop "does depend on anyone remembering it" — closes the last surface that would have contradicted the new declaration.

Two judgement calls I want on the record

No skip-changeset label, and your reason is exactly right: "that mechanism does not exist in objectui, and adding it would mint a repository label the next agent would read as real." Inventing infrastructure to satisfy a gate is how false affordances enter a repo — and this round has already produced three findings about tooling claims that resolve to nothing.

pnpm shadcn:check not run, declared — it needs ui.shadcn.com, which does not resolve from the sandbox, and it owns upstream drift while this PR owns anchor provenance. The test file's own docblock says they are not substitutes; citing that rather than treating a skipped job as a pass is correct.

Sanitizer, again

It stripped bare JSX fragments from inside the JSON's string values even within a fenced block, so {!hideOverlay && <SheetOverlay />} rendered degraded. Posting a correction spelling both literals without raw angle brackets — rather than leaving damaged evidence standing — is the right response. That is the eighth dev hit by this today, now in a form the literal-text marker fix does not cover. I am extending the seat's guidance: write angle-bracket fragments out in words or bracket-substituted form in any GitHub body, not just the marker line.

Landing

⏳ CI converging on 76fff2994. The self check-in verifies every-check-green and lands it.


Generated by Claude Code

@github-actions

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 52 chunks) 3221.0 KB 3990.2 KB
Main entry chunk (gzip) 153.7 KB 350 KB
Entry file index-BwRdn9wR.js —
Status PASS —

The eager closure is every chunk the entry reaches through static imports — what the browser fetches and parses before the app renders. The entry chunk on its own is a small fraction of it.


📦 Bundle Size Report

Package Size Gzipped
app-shell (consoleActionDispatch.js) 0.20KB 0.19KB
app-shell (index.js) 10.38KB 3.90KB
app-shell (runtime-config.js) 18.10KB 6.51KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 10.06KB 3.86KB
auth (ActiveOrganizationStorage.js) 25.05KB 9.16KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 2.07KB 1.00KB
auth (AuthProvider.js) 40.18KB 10.59KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.21KB 3.45KB
auth (LoginForm.js) 18.15KB 5.39KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.65KB 2.22KB
auth (SocialSignInButtons.js) 9.61KB 3.89KB
auth (UserMenu.js) 3.41KB 1.23KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 40.21KB 10.80KB
auth (createAuthenticatedFetch.js) 8.46KB 3.43KB
auth (index.js) 3.19KB 1.44KB
auth (invitation-status.js) 1.22KB 0.70KB
auth (org-roles.js) 6.66KB 2.78KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 5.30KB 1.02KB
auth (useWorkspaceAdminStatus.js) 5.13KB 2.35KB
collaboration (CommentThread.js) 26.08KB 7.56KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 6.49KB 2.64KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.68KB 0.73KB
collaboration (useCollaborationTranslation.js) 6.05KB 2.52KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 505.15KB 114.53KB
core (index.js) 4.92KB 1.97KB
create-plugin (index.js) 10.08KB 3.26KB
data-objectstack (index.js) 166.86KB 46.08KB
fields (index.js) 238.40KB 59.89KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.28KB 1.75KB
i18n (index.js) 3.44KB 1.39KB
i18n (pickLocalized.js) 7.62KB 3.26KB
i18n (provider.js) 23.13KB 7.63KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 33.40KB 8.71KB
i18n (useSafeTranslation.js) 7.77KB 3.13KB
layout (index.js) 38.95KB 10.97KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.75KB
mobile (index.js) 1.55KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.72KB 0.42KB
mobile (useResponsiveConfig.js) 1.37KB 0.63KB
mobile (useSpecGesture.js) 4.32KB 1.64KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 9.53KB 3.38KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 4.64KB 1.50KB
permissions (evaluator.js) 5.12KB 1.74KB
permissions (index.js) 0.93KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.53KB
permissions (usePermissions.js) 1.93KB 0.88KB
plugin-ai (index.js) 15.75KB 3.80KB
plugin-calendar (index.js) 46.62KB 12.83KB
plugin-charts (index.js) 64.66KB 18.32KB
plugin-chatbot (index.js) 188.21KB 44.67KB
plugin-dashboard (index.js) 133.35KB 34.44KB
plugin-designer (index.js) 212.30KB 42.80KB
plugin-detail (index.js) 244.08KB 61.86KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 125.63KB 30.64KB
plugin-gantt (index.js) 164.15KB 39.88KB
plugin-grid (index.js) 200.79KB 54.26KB
plugin-kanban (index.js) 52.89KB 14.59KB
plugin-list (index.js) 111.86KB 27.22KB
plugin-map (index.js) 20.11KB 6.64KB
plugin-markdown (index.js) 13.72KB 4.69KB
plugin-report (index.js) 43.49KB 11.93KB
plugin-timeline (index.js) 26.49KB 7.59KB
plugin-tree (index.js) 9.26KB 3.13KB
plugin-view (index.js) 84.57KB 20.74KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.66KB 3.50KB
providers (index.js) 0.45KB 0.23KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.62KB 2.34KB
react (LazyPluginLoader.js) 4.47KB 1.63KB
react (SchemaRenderer.js) 52.40KB 17.45KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.35KB 0.70KB
react (schema-input.js) 2.32KB 1.24KB
react (spec-input.js) 0.20KB 0.18KB
sdui-parser (codegen.js) 5.41KB 2.34KB
sdui-parser (dashboard-widget-options.js) 3.08KB 1.30KB
sdui-parser (index.js) 4.93KB 2.24KB
sdui-parser (input-type.js) 2.84KB 1.40KB
sdui-parser (parse.js) 12.13KB 3.65KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 7.54KB 2.63KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 2.74KB 1.41KB
types (crud.js) 0.20KB 0.18KB
types (dashboard-filter-alias.js) 6.23KB 2.74KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.87KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (http-inflight.js) 8.87KB 3.73KB
types (http-retry.js) 4.32KB 2.02KB
types (icon-key-migration.js) 4.26KB 1.63KB
types (index.js) 4.49KB 2.14KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 2.59KB 1.31KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.05KB 1.93KB
types (spec-ui-namespace.js) 0.20KB 0.19KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 6.28KB 2.87KB
types (ui-action.js) 3.40KB 1.71KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@yinlianghui-tw
yinlianghui-tw marked this pull request as ready for review August 24, 2026 17:42
@yinlianghui-tw
yinlianghui-tw added this pull request to the merge queue Aug 24, 2026
Merged via the queue into main with commit b9c3677 Aug 24, 2026
22 checks passed
@yinlianghui-tw
yinlianghui-tw deleted the claude/issue-6090-declare-hideoverlay-patch branch August 24, 2026 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation package: components tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[finding] sheet.tsx's undeclared hideOverlay prop has zero consumers, so the type-check gate credited with catching its loss is vacuous today

2 participants