Skip to content

docs(plugin-calendar): shrink UNGATED_DOCS by one — the calendar README's 10 blocks compile (#5174 batch 13) - #7929

Merged
baozhoutao merged 3 commits into
mainfrom
claude/issue-5174-ungated-docs-batch13
Sep 6, 2026
Merged

docs(plugin-calendar): shrink UNGATED_DOCS by one — the calendar README's 10 blocks compile (#5174 batch 13)#7929
baozhoutao merged 3 commits into
mainfrom
claude/issue-5174-ungated-docs-batch13

Conversation

@claude

@claude claude Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Part of #5174 — batch 13 of the check-doc-snippet-types ungated-docs ledger burn-down.

packages/plugin-calendar/README.md leaves UNGATED_DOCS. All 10 of its ts/tsx blocks now compile --strict against the built dist/*.d.ts. Zero FRAGMENT_MARKERs written, zero entries added — the ledger hunk is 0 additions / 2 deletions and the whole diff is exactly two files.

reading before after
ledger entries 25 24
covered documents 202 203
covered blocks 625 635
of those, to compile 467 477
declared fragments 158 158
scan-set size 227 227

Fragments unmoved ⇒ every one of the 10 newly covered blocks earned it by compiling.

All figures are at 8fbe7b724, the final commit, after merging origin/main db2c20d08 (never rebased). git status --porcelain was empty at union time and after all seven probe runs.

What was wrong, measured — the ledger reason was stale in BOTH halves

The entry read "9 parse diagnostic(s) — blocks fenced ts that are bare object literals or elided bodies; 2 undefined-name diagnostic(s)". What reproduces at the branch point is 15 parse diagnostics, not 9, and zero undefined-name diagnostics — the two that remain are implicit-any. Reported, not reproduced.

2 parse failures, 15 diagnostics, all TS1109: Expression expected:

  1. The "Schema API → CalendarView" listing was a bare brace-wrapped block using ?: optional-property notation inside a ```typescript fence. ?: is not expression syntax, so it could not parse as a value at all (14 diagnostics).
  2. data: [...] — a literal ellipsis standing in for "your records". ... with no operand is not an expression (1 diagnostic).

1 semantic failure, 2 diagnostics: TS7006 ×2 on the event and view parameters of the two host-only handlers — their object literal carried no annotation, so neither parameter got a contextual type.

7 blocks already compiled.

⭐ The interesting part: the first repair was correct and still wrong

The listing was first rewritten as a CalendarViewSchema-annotated value literal. It compiled, and the gate went green. It also turned packages/plugin-calendar/src/readme-calendar-view-schema.test.ts red with 12 false claims of the form data: README says required, schema says optional — because that pin parses the fence's ?: markers to hold the README's requiredness to the interface, and a value literal cannot carry them.

That pin is a working guard, and editing it to accept a value literal would have deleted the requiredness check. So the block is now a type alias — it keeps the ?: markers a reader needs — held to the shipped type by two assignments in both directions:

declare const authored: CalendarViewNode;
declare const shipped: CalendarViewSchema;
const forwards: CalendarViewSchema = authored;
const backwards: CalendarViewNode = shipped;

The pin is untouched and green (probe P7 shows the doc gate now holds optionality — the exact property that pin checks textually — by a second, independent mechanism).

⚠️ A limit published rather than left to be discovered

CalendarViewSchema extends BaseSchema, and BaseSchema ends with [key: string]: any (packages/types/src/base.ts:467). So the annotation checks every key's type and no key's spelling. That is measured (probe P5, predicted green in writing and observed green), it is stated in a note in the README itself, and it is filed as #7927. Nothing in this PR is written as if key spelling were checked.

Seven reverse-verification probes — direction predicted IN WRITING before any probe ran

Predictions were written to a file first. All seven matched. Each leg proved the mutation reached disk (injected/removed text counted, git hash-object shown to differ from the HEAD blob — an equal or empty hash aborts the harness non-zero) and proved the restore by an empty git diff HEAD plus a blob hash equal to HEAD's. No build artifact sits between mutation and thing-under-test, so no rebuild was needed on either leg — stated rather than assumed. Every probe was run twice: once before the origin/main merge and again at the merged head, with identical diagnostics.

probe mutation predicted observed
P1 view?: CalendarViewModeview?: 'agenda' RED ✅ RED — TS2322 in both assignment directions
P2 block 10's discriminant → 'calendar-vue' RED ✅ RED — TS2322: Type '"calendar-vue"' is not assignable to type '"calendar-view"'
P3 delete the annotation this PR added to block 7 RED ✅ RED — TS7006 ×2 on event and view, the exact pair the decomposition recorded
P4 restore data: [...] RED, syntax phase ✅ RED — Syntax phase: 1 block(s) failed to parse, TS1109, denominator 477 → 476
P5 misspell a KEY: titleField?:titleFieldd?: GREEN (blind spot) ✅ GREEN — exit 0, 477 of 477 judged, 0 failed
P6 event.titleevent.titel RED ✅ RED — TS2551: Property 'titel' does not exist on type 'CalendarEvent'
P7 data?: anydata: any (optional → required) RED ✅ RED — TS2322: Property 'data' is optional in type 'CalendarViewSchema' but required in type 'CalendarViewNode'

Honest notes: P6's predicted code was "TS2339/TS2551-class" and the observed code is TS2551 (TypeScript emits 2551 when it has a near-spelling suggestion) — predicted direction was RED and the observed fact is the same one. P5 and P6 together bound exactly where this document's checking starts (types, optionality, and members of the callback payload) and stops (schema key spelling). CalendarEvent is a plain interface with no index signature, which is why P6 IS caught and P5 is not.

⚠️ An earlier probe set (v1) targeted the value-literal form of the listing and was discarded, not carried over, when that form was replaced. All seven results above are fresh against the shipped form.

Scope guard

  • The gate file is touched only inside the UNGATED_DOCS object literal; git diff --numstat reads 0 2 three-dot. The ledger docblock prose is untouched and no surviving entry's reason text changed (asserted programmatically, not by eye).
  • Strictness proven byte for byte: everything from the Fence scanning banner to EOF is identical on both sides of this diff — sha256 91450911e8… on origin/main and on this branch, measured over the same working tree. ⚠️ That is asserted as identity across this diff, never as a constant carried from an earlier batch.
  • Invariants were diffed programmatically: origin/main's copy of the gate was imported alongside this branch's and both were evaluated over the same working tree, so the covered-set delta is attributable to the ledger alone. ADDED entries: [], previously-covered docs now UNGATED: [], build filters ADDED [] REMOVED [].
  • Untouched: packages/react/README.md (batch 12), packages/auth/README.md (held by open PR chore(deps): resolve @objectstack/spec at 17.3.0 in the lockfile #7685), packages/plugin-gantt / plugin-kanban (finding(docs): three documented interface blocks are behind their shipped types — the PARTIAL_EXCERPTS ledger #6214 opened with #7302), packages/plugin-chatbot (deferred).

Gates

All at 8fbe7b724, exit codes captured by redirect before any pipe:

check:doc-snippets 0 · check:doc-fences 0 · check:doc-types 0 · check:control-bytes 0 (plus a manual grep -naP over the C0 set on both changed files, no hits) · check-doc-links 0 · check:readme-exports 0 · type-check:scripts 0 · check-changeset-presence 0 ("No source or published contract of a released package changed in this range, so no changeset is owed" — none added) · lint:root 0, 32 problems (0 errors, 32 warnings), all pre-existing and the changed gate file reports errorCount 0 warningCount 0.

Vitest from the repo root, --maxWorkers=2, exit 0: Test Files 9 passed (9) / Tests 377 passed (377). Suite union derived by git grep -l for the gate's name and for the edited document, re-derived after the merge (identical set); it includes the gate's own suite and packages/plugin-calendar/src/readme-calendar-view-schema.test.ts, the pin discussed above.

⚠️ check:readme-exports first exited 1 with 3 findings, all "its type entry ./dist/index.d.ts is not on disk — run pnpm build first" for plugin-ai, none naming a file in this diff. That is the gate's own by-design precondition refusal, not a verdict. Building plugin-ai and plugin-tree made it a real, green measurement — and the doc gate's reading was re-taken afterwards and proved identical, so the top-up build did not move any figure here.

⚠️ 15 of the 36 build tasks were turbo cache replays whose logs print objectui-issue-5174-b12's paths. The artifacts were restored into this worktree: dist/index.d.ts was confirmed on disk here for all 26 build-filter packages before any gate result was trusted, and the gate's own resolution control names this worktree's path.

Filed for triage, not repaired in this PR

Both finding, unassigned, no domain:* and no grade — those are triage's.

Draft, not enqueued, auto-merge not enabled.


Generated by Claude Code

…ME's 10 blocks compile

`packages/plugin-calendar/README.md` leaves the `check-doc-snippet-types`
ledger. All 10 of its ts/tsx blocks now compile --strict against the built
`dist/*.d.ts`; no FRAGMENT_MARKER was written and no entry was added.

Three blocks were repaired at the document, never by weakening the gate:

- The authored-surface listing was a bare brace-wrapped block using `?:`
  optional-property notation inside a ```typescript fence — not expression
  syntax, so it could not parse at all (TS1109 x14). It is now a `type`
  alias, which keeps the `?:` markers a reader needs, plus two assignments
  that hold the listing to `CalendarViewSchema` in both directions. An
  earlier draft rewrote it as an annotated VALUE literal; that form compiles
  but destroys the optionality notation that
  `readme-calendar-view-schema.test.ts` reads, turning that pin red with 12
  false "README says required" claims. The pin is a working guard and is left
  untouched.
- `data: [...]` — a literal ellipsis standing in for "your records" — is not
  an expression either (TS1109 x1). It is now an empty array with a comment.
- The two host-only handlers took their parameters implicitly `any`
  (TS7006 x2) because their object literal had no annotation. The annotation
  now supplies `CalendarEvent` and `CalendarViewMode` from the shipped schema.

The ledger reason for this entry was stale in both halves and is reported in
the PR rather than reproduced: 15 parse diagnostics reproduce, not 9, and the
two remaining diagnostics are implicit-any, not undefined-name.

A limit is published rather than left to be discovered: `CalendarViewSchema`
extends `BaseSchema`, whose `[key: string]: any` means the compiler checks
every key's TYPE and no key's SPELLING. A note in the README says so.

Part of #5174

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013uAaxiwgYDybsTNV9xwa1M
The note added above states the limit; this points at the card that owns it.

Part of #5174

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) 3187.4 KB 3191.4 KB
Main entry chunk (gzip) 143.5 KB 350 KB
Entry file index-DXVOmq-o.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) 510.60KB 116.20KB
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.98KB 10.98KB
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.75KB 3.80KB
plugin-calendar (index.js) 47.87KB 13.31KB
plugin-charts (index.js) 70.92KB 19.75KB
plugin-chatbot (index.js) 196.19KB 46.37KB
plugin-dashboard (index.js) 132.88KB 34.69KB
plugin-designer (index.js) 212.86KB 43.19KB
plugin-detail (index.js) 250.55KB 64.06KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 132.87KB 32.66KB
plugin-gantt (index.js) 167.26KB 41.00KB
plugin-grid (index.js) 209.29KB 56.78KB
plugin-kanban (index.js) 52.71KB 14.55KB
plugin-list (index.js) 113.56KB 27.70KB
plugin-map (index.js) 20.44KB 6.78KB
plugin-markdown (index.js) 13.93KB 4.81KB
plugin-report (index.js) 43.59KB 11.97KB
plugin-timeline (index.js) 30.40KB 8.76KB
plugin-tree (index.js) 9.20KB 3.19KB
plugin-view (index.js) 85.24KB 20.94KB
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

@baozhoutao
baozhoutao marked this pull request as ready for review September 6, 2026 03:38
@baozhoutao
baozhoutao added this pull request to the merge queue Sep 6, 2026
Merged via the queue into main with commit 58153d9 Sep 6, 2026
32 checks passed
@baozhoutao
baozhoutao deleted the claude/issue-5174-ungated-docs-batch13 branch September 6, 2026 04:02
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