Repository navigation
fix(types): drop stale source-line citations from 12 published describe() strings (objectui#8478) - #8776
Merged
Conversation
…be() strings overlay.zod.ts (8) / data-display.zod.ts (3) / objectql.zod.ts (1): remove the `NAME.ext:NNN` address from each published .describe() string (objectui#8478). Each was either trimmed to its author-useful sentence (the detail is already duplicated in the adjacent maintainer-facing JSDoc, so nothing is lost) or rewritten to cite the same fact by identifier/behavior instead of by line — the shape objectui#7853 established for assertions. Text only: no accept-set, key, or shape change. One of the twelve addresses removed (ObjectKanban.tsx:264 on `limit`) was measured to have already drifted: the cited line is now unrelated permissions code, the real read site is ObjectKanban.tsx:365. Filed back on objectui#8478 as the drift evidence its own re-grade trigger asked for. form.zod.ts / layout.zod.ts (held by PR objectui#8763) and complex.zod.ts (held by PR objectui#8766 at claim time, merged mid-round) carry the remaining 15 addresses and are out of scope for this PR — the card does not close here. Refs #8478 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012W3vMLTFY9SPr2LyxhSeYi
Contributor
✅ Console Performance Budget
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
Size Limits
|
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 free
to 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.
Refs #8478
Scope — narrowed by live file collisions
The card's population is 27
NAME.ext:NNNaddresses inside published.describe()strings across six
packages/types/src/zod/**files. Three were held by other in-flightPRs at claim time and stay out of bounds here:
zod/overlay.zod.tszod/data-display.zod.tszod/objectql.zod.tszod/form.zod.tszod/layout.zod.tszod/complex.zod.ts⇒ This PR does not close objectui#8478 — the remaining 15 addresses (
form.zod.ts,layout.zod.ts,complex.zod.ts) are unaffected and the card stays open for them.Re-derived population, on the commit this PR reads from (
c03d03bb2)A
.describe(argument holding aNAME.ext:NNNaddress, matched call-by-call (not a rawstring scan), across the whole of
packages/types:form.zod.tsoverlay.zod.tscomplex.zod.tsdata-display.zod.tslayout.zod.tsobjectql.zod.tsExactly matches the card's own count (taken on
868e82501) and the triage seat'sindependent recount (taken on
f76f4362) — three separate commits across a day of churn,same 27, same per-file split. No discrepancy to report.
What changed, and why (per-address disposition)
Text only — no accept-set, key, or shape change confirmed by
git diff(12 linestouched, all inside
.describe(...)call arguments).Dropped (address removed; description trimmed to its author-useful sentence — the
implementation detail was already duplicated in the file's own maintainer-facing JSDoc,
so nothing is lost) — 3:
overlay.zod.ts—TooltipSchema.triggerdata-display.zod.ts—TreeViewSchema.nodesobjectql.zod.ts—ObjectKanbanSchema.limitRewritten by content (address replaced with an identifier/behavior citation that
survives a line renumbering — the shape objectui#7853 established for assertions) — 9:
overlay.zod.ts—TooltipSchema.content,TooltipSchema.body,HoverCardSchema.align,ContextMenuSchema.trigger,ContextMenuSchema.triggerClassName,ContextMenuSchema.contentClassName,ContextMenuSchema.modaldata-display.zod.ts—ListSchema.wrapperClass,TreeViewSchema.titleMoved to a comment — 0. Every one of these 12 carried at least a thin layer of
author-useful content once the line address was stripped, so none needed a brand-new
maintainer-only comment; where the detail was purely internal it was already sitting in
an adjacent JSDoc block.
A drift found while spot-checking (the card's own bonus ask)
The card's triage comment asked: verify a handful of the 27 addresses against current
source, and report back if any is wrong (pre-committed re-grade trigger: any confirmed
drift raises the card from p3 to p2). Spot-checked all 12 in-scope addresses against
packages/components/src/renderers/**andpackages/plugin-kanban/src/ObjectKanban.tsx:ObjectKanban.tsx:264(onObjectKanbanSchema.limit) had already drifted — thatline is now unrelated permissions-context code; the real read site
(
$top: schema.limit ?? DEFAULT_KANBAN_LIMIT) is at line 365. Verified there isonly one
DEFAULT_KANBAN_LIMITuse site in the file (grep -n), so this isn't asecond call being mismatched — the file simply grew above it.
This is exactly the failure mode the card names as its reason for removing these
addresses at all ("an inaccurate one and an accurate one are indistinguishable from
inside the repository") — reported back on the issue for the p3→p2 call, which is the
maintainer's / triage seat's to make, not mine.
Verification
pnpm exec vitest run --root . packages/types/—Test Files 155 passed (155),Tests 3073 passed (3073)pnpm --filter @object-ui/types build(tsc && vite build && check-dist-completeness)tsc --noEmit/tsc -p tsconfig.examples.json/tsc -p tsconfig.test.json(inpackages/types)pnpm exec eslint .inpackages/types— 225 files, 0 errors, 266 warningsnode scripts/check-changeset-presence.mjsnode scripts/check-changeset-no-major.mjspnpm check:control-bytes— 6969 tracked text files scannedpnpm check:spec-symbolspnpm check:designer-field-key-paritypnpm check:handler-key-readsGate selection, declared.
scripts/pm/dispatch-gates.mjsrefuses cross-repo paths forthis repo, so the above was hand-picked from
package.json'scheck:*scripts and.github/workflows/ci.yml's job list, scoped to gates that readpackages/types/src/zod/**content or scan all tracked source text; gates about doc-example types, i18n, actions,
dependency hygiene, or upstream Shadcn parity aren't implicated by a
.describe()text-onlydiff and were left to CI's full farm.
Merged
origin/mainonce before opening (final basec03d03bb2, which includes PRobjectui#8766's merge — see the collision table above).
Toolchain note carried forward for the next seat on this card (objectui#3378): run vitest
from the repo root;
pnpm --filter PKG exec vitest FILEsilently runs zero tests of thetarget package.
🤖 Generated with Claude Code
https://claude.ai/code/session_012W3vMLTFY9SPr2LyxhSeYi
Generated by Claude Code