Skip to content

docs(plugin-designer): shrink UNGATED_DOCS by one — 24 entries to 23, the designer README's 8 blocks compile (#5174 batch 15) - #7983

Merged
baozhoutao merged 1 commit into
mainfrom
claude/issue-5174-ungated-docs-batch15
Sep 6, 2026
Merged

docs(plugin-designer): shrink UNGATED_DOCS by one — 24 entries to 23, the designer README's 8 blocks compile (#5174 batch 15)#7983
baozhoutao merged 1 commit into
mainfrom
claude/issue-5174-ungated-docs-batch15

Conversation

@baozhoutao

Copy link
Copy Markdown
Contributor

Part of #5174

Batch 15 of the UNGATED_DOCS burn-down in scripts/check-doc-snippet-types.mjs.
One document leaves the ledger: packages/plugin-designer/README.md. All 8 of its
ts/tsx blocks now compile against the built dist/*.d.ts, so the entry comes out.
The card stays open — 23 entries remain.

File surface: exactly two files. scripts/check-doc-snippet-types.mjs is 0 2 on
git diff --numstat — the two-line entry removal and nothing else.

Census, re-taken at this branch point

Base b31370093, recorded before the first edit and never inherited from batch 14
or from the dispatch. Taken with the gate's own exports (UNGATED_DOCS,
listDocuments, scanFences).

Ledger entry count at base: 24 — batch 14 has not merged, so
packages/mobile/README.md is still listed. Gate verdict at base, exit 0:

Scanned 227 document(s): 203 covered (101 of them hold a ts/tsx block), 24 ungated — declared in this script, NOT verified by it.
Covered blocks: 635 — 477 to compile, 158 declared fragment(s).
Semantic phase: 477 of 477 block(s) judged, 0 failed.
blocks document takeable?
18 packages/plugin-gantt/README.md no — objectui#7302's, being dispatched to another dev this round
11 packages/plugin-chatbot/README.md no — deferred, needs a which-side-is-wrong ruling against the third-party ai SDK
10 packages/auth/README.md no — held by draft PR #7685 (re-read its file list: packages/auth/README.md is still in it)
9 packages/mobile/README.md no — batch 14, in flight as PR #7975
8 packages/i18n/README.md yes — tie at 8, 11 measured diagnostics
8 packages/plugin-designer/README.md yes — tie at 8, 22 measured diagnostics ⇒ PICKED
7 packages/collaboration · layout · permissions · plugin-detail · types yes
5 packages/core · plugin-kanban (no — objectui#7302's) · plugin-list · react-runtime · root README.md
4 packages/plugin-ai · plugin-charts · plugin-editor · plugin-map · plugin-markdown · providers
2 packages/fields/README.md
1 packages/plugin-tree/README.md

The tie at 8 blocks was broken by measured debt, per the batch-14 ruling: the entry
hiding more diagnostics is the one whose green means more. Both sides were measured
on this base by removing that one entry and running the gate — 22 for
plugin-designer, 11 for i18n.

Decomposition, measured at the base before any edit

The ledger reason is archaeology; the measurement is the fact. This time the two
agree, which is worth recording after three batches where they did not:

the entry claims measured on b31370093
2 parse 2 — TS1003, TS1382, both at README.md:105
12 undefined-name 12 — TS2304 x11 + TS2552 x1
TS2339 x6, TS2554 x1, TS2741 x1 identical
22 total 22 total

What each one was:

  • TS1382/TS1003 at line 105 — the CollaborationProvider example wrote a literal
    three-dot elision inside a JSX tag. Not a fragment marker, just a token TypeScript
    cannot parse.

  • TS2741 at line 41CollaborationProvider was used with no config, which its
    shipped CollaborationProviderProps declares as required.

  • TS2304/TS2552 x12 — five prop-reference blocks used ambient names (componentList,
    canvasConfig, entities, relationships, nodes, edges, sections) and, in four
    of them, the component itself was never imported.

  • TS2554 at line 120useUndoRedo() called with zero arguments; it ships as
    useUndoRedo(initialState, options).

  • TS2339 x6 at lines 121-123 — six phantom member names on three hooks. Every one of
    them has a shipped equivalent, so each is a repair and not a refusal, except cut,
    which has no shipped counterpart and is simply no longer documented:

    the page taught the shipped surface treatment
    useClipboard().cut nothing — ClipboardState is clipboard / copy / paste / hasContent phantom removed
    useMultiSelect().selected selectedIds shipped spelling taught
    useMultiSelect().select selectOne shipped spelling taught
    useMultiSelect().selectAll selectMany(ids) shipped spelling taught
    useCanvasPanZoom().pan panOffset (state) and startPan (action) shipped spelling taught
    useCanvasPanZoom().resetView resetZoom shipped spelling taught

No public type was widened to accept anything the page said, and no lenient alias was
added anywhere. The direction is the one AGENTS.md commandment #0.1 requires: the
document moved to the contract, never the contract to the document.

Shape of the rewrite, and the readers it had to keep green

git grep -l 'plugin-designer/README' -- scripts/ packages/ examples/ apps/ returns two
readers: this gate, and scripts/__tests__/doc-version-claims.test.ts, whose
KNOWN_CLAIMS pins the peer line at README.md:26 and asserts it verbatim against the
package manifest. Lines 25-28 are byte-identical on this branch, and probe P4 below shows
that pin is still live rather than vacuous.

The five prop-reference blocks keep their original element shape and gain a compact
preamble of the real import plus declare const placeholders carrying the shipped type.
That form documents strictly more than the old ambient names did — a reader now sees what
type each prop wants — and probe P5 shows those annotations are load-bearing rather than
silently widened.

Coverage arithmetic

base b31370093 branch 7116b5e1d delta
documents scanned 227 227 0
covered 203 204 +1
covered holding a ts/tsx block 101 102 +1
ungated 24 23 -1
covered blocks 635 643 +8
blocks to compile 477 485 +8
declared fragments 158 158 0
semantic failures 0 0 0

All 8 blocks were bought by compiling them. None was bought with a fragment declaration.

Strictness invariant

sha256 of scripts/check-doc-snippet-types.mjs from the Fence scanning banner to EOF,
1178 lines on both sides:

  • base b31370093f46b5662ba336f026bca3a0003e0b7979789d48d0291fa5760be7d23c8ed0160
  • branch 7116b5e1df46b5662ba336f026bca3a0003e0b7979789d48d0291fa5760be7d23c8ed0160

Identical. Nothing in the gate's scanning, marker, control or verdict logic moved.

Ledger invariants

Both sides' UNGATED_DOCS literals were imported and diffed programmatically:

base entries = 24 | head entries = 23
added          = []
removed        = ["packages/plugin-designer/README.md"]
reason-changed = []
key order preserved for survivors = true
survivors count = 23

Probes — predicted in writing, then observed

Every mutation proved on disk (occurrence counts plus blob hash), every restore proved
(blob equals HEAD, empty git diff HEAD), each leg wrapped in an EXIT/INT/TERM trap with
absolute paths.

# mutation predicted observed
P1 ledger entry restored, README repair kept exit 0, coverage silently shrinks back to 24 ungated / 477 to compile exact match: exit 0, 24 ungated, Covered blocks: 635 — 477 to compile, 477 of 477 judged, 0 failed
P2 zoomIn becomes zoomInTypo in the hooks block exit 1, one TS2339 on that line exact match: README.md:170:26 TS2339: Property 'zoomInTypo' does not exist on type 'PanZoomState', 485 of 485 judged, 1 failed
P3 README reverted to base bytes, removal kept exit 1 with the same 22 diagnostics as the decomposition exact match, all 22, same codes, same lines
P4 peer line react caret-18 becomes caret-17 doc-version-claims.test.ts goes red exact match: 3 assertions red — the ratchet, the inventory, and the peer-line assertion (README says caret-17 or caret-19, manifest says caret-18 or caret-19)
P5 the entities placeholder retyped from DataModelEntity[] to BPMNNode[] exit 1, assignability error on entities= exact match: TS2322: Type 'BPMNNode[]' is not assignable to type 'DataModelEntity[]'
P6 ReportDesigner import renamed to ReportDesignerNope check:readme-exports red, 1 fabricated exact match: 1 README import name(s) NO package exports, census 431 real, 0 wrong-path, 1 fabricated

Six of six landed in the predicted direction; nothing reversed, so no isolating follow-up
probe was needed.

Gates

Every exit code captured by redirecting first, never through a pipe. Union re-run at the
final commit 7116b5e1d.

gate exit its own verdict line
pnpm check:doc-snippets 0 Every covered documentation snippet compiles against the built types.
pnpm check:doc-fences 0 every TypeScript block in 227 document(s) is fenced ts/tsx/typescript, except 80 declared file(s) carrying 89 block(s)
pnpm check:readme-exports 0 OK (43 tracked README(s) ... 432 of them self-imports judged (432 real, 0 wrong-path, 0 fabricated)
pnpm check:doc-types 0 Every documented component type is registered.
node scripts/check-doc-links.mjs 0 Links are valid across 17 scan roots.
pnpm check:doc-example-readers 0 OK 80 documented symbol(s), 3947 call site(s) ... no @example hand-spells one.
pnpm check:control-bytes 0 OK (scanned 6421 tracked text file(s); skipped 85 binary).
pnpm type-check:scripts 0 clean tsc -p tsconfig.scripts.json
node scripts/check-changeset-presence.mjs 0 No source or published contract of a released package changed in this range, so no changeset is owed.
node scripts/check-governed-queue-guard.mjs --test (both paths) 0 NOT GOVERNED — 2 path(s) checked against 5 governed surface(s); none matched.

Tests: pnpm exec vitest run scripts/__tests__/check-doc-snippet-types.test.ts scripts/__tests__/doc-version-claims.test.ts scripts/__tests__/check-doc-fence-languages.test.ts scripts/__tests__/check-readme-exports.test.tsTest Files 4 passed (4) / Tests 231 passed (231).
pnpm exec vitest run packages/plugin-designer/Test Files 17 passed (17) / Tests 124 passed (124).
pnpm --filter @object-ui/plugin-designer type-check — exit 0.

check:readme-exports first came back exit 1 with three @object-ui/plugin-ai entries
reading its type entry ./dist/index.d.ts is not on disk -- run pnpm build first. That is
the unbuilt-tree PRECONDITION, not a verdict: @object-ui/plugin-ai sits outside
check:doc-snippets --build-filter's closure, so building only what the snippet gate asks
for leaves it unbuilt. After turbo run build --filter=@object-ui/plugin-ai... the gate
ran and returned the green quoted above. Read the earlier exit as NOT MEASURED.

TURBO_SCM_BASE=b31370093 turbo ls --affected names five packages: plugin-designer,
app-shell, console, example-byo-backend-console, example-console-starter. Only the
first owns anything that reads the changed bytes; the other four are affected through
turbo's package input hash alone. git grep README across those four returns nothing but
prose in comments and their own READMEs, none of it naming this document. Their suites are
declared to CI — a stated narrowing, not a skipped run. Repository-wide pnpm lint is
likewise CI's run.

Concurrency with batch 14

Batch 14 is PR #7975, removing packages/mobile/README.md. The two removals are disjoint
lines of the same object literal in the same file, and the two READMEs do not overlap. Both
are Part of #5174; whichever lands second is rebuilt by the merge queue on the other's
result. No coordination beyond that is owed.

Refusals

None. Every block on this page had a shipped spelling for what it meant, so all 8 compile
and none was declared a fragment. No coverage limit to record.

Next takeable

packages/i18n/README.md — 8 blocks, 11 measured diagnostics on this base (TS2304 x7,
TS2559 x2, TS2554 x2), no open PR holding it.


Generated by Claude Code

…p its ledger entry

Every ts/tsx block in packages/plugin-designer/README.md now compiles against
the built dist/*.d.ts, so its UNGATED_DOCS entry comes out. The gate file's own
strictness is untouched: the only edit there is the two-line entry removal.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013uAaxiwgYDybsTNV9xwa1M
@github-actions github-actions Bot added documentation Improvements or additions to documentation plugin labels Sep 6, 2026
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Eager closure (gzip, 50 chunks) 3185.9 KB 3191.4 KB
Main entry chunk (gzip) 143.5 KB 350 KB
Entry file index-8xzvN5SF.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) 15.67KB 5.75KB
app-shell (runtime-config.js) 20.68KB 7.36KB
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) 497.06KB 113.79KB
core (index.js) 6.96KB 2.79KB
create-plugin (index.js) 10.08KB 3.26KB
data-objectstack (index.js) 182.08KB 50.62KB
fields (index.js) 242.44KB 61.25KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (builtinAggregateLabels.js) 0.86KB 0.49KB
i18n (currency.js) 1.22KB 0.64KB
i18n (fallbackInterpolation.js) 6.25KB 2.77KB
i18n (i18n.js) 4.28KB 1.75KB
i18n (index.js) 3.65KB 1.47KB
i18n (pickLocalized.js) 7.62KB 3.26KB
i18n (provider.js) 26.89KB 9.04KB
i18n (useDisplayLocale.js) 2.85KB 1.45KB
i18n (useObjectLabel.js) 34.34KB 9.17KB
i18n (useSafeTranslation.js) 5.60KB 2.33KB
layout (index.js) 38.84KB 10.94KB
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.99KB 0.87KB
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 (useSpecGesture.js) 4.39KB 1.66KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 11.71KB 4.29KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 6.24KB 2.16KB
permissions (discardProofCache.js) 1.04KB 0.55KB
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) 4.83KB 2.27KB
plugin-ai (index.js) 15.16KB 3.68KB
plugin-calendar (index.js) 47.35KB 13.21KB
plugin-charts (index.js) 70.31KB 19.62KB
plugin-chatbot (index.js) 193.53KB 46.05KB
plugin-dashboard (index.js) 131.41KB 34.43KB
plugin-designer (index.js) 211.51KB 43.01KB
plugin-detail (index.js) 247.59KB 63.48KB
plugin-editor (index.js) 2.23KB 1.05KB
plugin-form (index.js) 131.01KB 32.32KB
plugin-gantt (index.js) 167.16KB 40.99KB
plugin-grid (index.js) 208.56KB 56.63KB
plugin-kanban (index.js) 52.30KB 14.49KB
plugin-list (index.js) 113.24KB 27.66KB
plugin-map (index.js) 20.35KB 6.77KB
plugin-markdown (index.js) 13.88KB 4.80KB
plugin-report (index.js) 43.42KB 11.92KB
plugin-timeline (index.js) 29.95KB 8.67KB
plugin-tree (index.js) 9.16KB 3.18KB
plugin-view (index.js) 84.33KB 20.75KB
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) 81.07KB 26.86KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 4.63KB 2.18KB
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) 20.57KB 5.88KB
sdui-parser (provenance.js) 3.66KB 1.82KB
sdui-parser (types.js) 0.28KB 0.23KB
sdui-parser (validate.js) 10.35KB 3.60KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 1.00KB
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) 3.75KB 1.85KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.85KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (expression.js) 0.20KB 0.18KB
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.74KB 2.25KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 4.73KB 2.28KB
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 (select-option.js) 0.20KB 0.19KB
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) 8.11KB 3.32KB
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

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 plugin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants