docs: fix two stale-symbol doc/comment strings (GanttViewMode JSDoc, ReportInput exemption reasons) by os-support-ai · Pull Request #5331 · objectstack-ai/objectui

os-support-ai · 2026-08-19T15:26:19Z

Sweep pack: two one-line stale-doc-text fixes, unrelated files, no behavior change either card.

Before / after

Issue	File	Before	After
#5132	`packages/plugin-gantt/src/GanttView.tsx:195`	`/** Timeline granularity — one column per day, week, month, or quarter. */`	`/** Timeline granularity — one column per day, week, month, quarter, or year. */`
#5139	`scripts/check-doc-component-types.mjs:329`	`matrix: 'ReportInput kind — a report definition\'s shape, sibling of \`joined` / `summary`.',`	`matrix: 'ReportSchema.type kind — a report definition\'s shape, sibling of \`joined` / `summary`.',`
#5139	`scripts/check-doc-component-types.mjs:330`	`joined: 'ReportInput kind — a report definition\'s shape, sibling of \`matrix` / `summary`.',`	`joined: 'ReportSchema.type kind — a report definition\'s shape, sibling of \`matrix` / `summary`.',`

#5132 — GanttViewMode JSDoc undercounted granularities

The JSDoc above export type GanttViewMode named four granularities while the type itself ('day' | 'week' | 'month' | 'quarter' | 'year'), VIEW_MODES, NOMINAL_DAYS (year: 365.25), the column builder, the toolbar (VIEW_MODES.map) and the header-band logic (viewMode === 'year' ? 'decade' : …) all honor a fifth member, 'year'. 'year' is fully live, not vestigial. The upstream spec agrees: GanttConfigSchema.viewMode on @objectstack/spec@17.0.0 is z.enum(['day','week','month','quarter','year']). One-word fix, comment only.

#5139 — DOC_TYPE_EXEMPTIONS reason cites a retired symbol

Both DOC_TYPE_EXEMPTIONS['content/docs/plugins/plugin-report.mdx'] reason strings opened with 'ReportInput kind — …'. ReportInput is not on @objectstack/spec@17.0.0's export surface — the …Input aliases were retired at rc.6 (packages/types/src/spec-report.ts records the rename). The exemptions themselves stay exactly as they are: matrix and joined really are report-type discriminants, not component types. Only the reason text changes.

Chose to name the real member, ReportSchema.type, over the more generic Report kind — verified against the current @objectstack/spec@17.0.0.d.ts: ReportSchema declares its type field as a defaulted Zod enum over summary / tabular / matrix / joined, and the exported ReportType enum carries the same four members. Naming the concrete field is more defensible and re-checkable than the generic phrase.

Verification

node scripts/check-doc-component-types.mjs — passes on the edited file (Scanned 143 mdx file(s) … Every documented component type is registered.).
node scripts/check-changeset-presence.mjs — 1 source file(s) of 1 released package(s) changed, and this change declares 1 changeset(s) (@object-ui/plugin-gantt patch changeset added; scripts/ is not a released package so finding: DOC_TYPE_EXEMPTIONS reasons cite ReportInput, a symbol @objectstack/spec does not export #5139's file needs none).
node scripts/check-changeset-no-major.mjs — no major bump declared.
Vitest run from repo root, pnpm exec vitest run scripts/__tests__/check-doc-component-types.test.ts — Test Files 1 passed (1), Tests 27 passed (27) (this is the gate's own test, not just the gate script — a prior PR, fix(examples): lowercase hello-world schema node types to registered keys #5244, went red for skipping this distinction).
Dependency closure built first (pnpm --filter "@object-ui/plugin-gantt^..." build, 13 packages), then pnpm --filter "@object-ui/plugin-gantt" type-check (tsc --noEmit && tsc -p tsconfig.test.json) — green, zero errors. Ran it and it was green; a JSDoc-only edit cannot break typecheck but this is measured, not assumed.
packages/plugin-gantt owns a standalone vitest.config.ts (confirmed — assertCanonicalVitestInvocation does not cover it), so its real invocation is the package-scoped one: pnpm --filter "@object-ui/plugin-gantt" test — Test Files 44 passed (44), Tests 386 passed (386). Cross-checked the file count against find packages/plugin-gantt/src -iname '*.test.*' | wc -l (44) to rule out a silent zero/partial match.
Reverse-verification: degenerate here, stated plainly rather than filled into the template. Both changes are comment/string-literal text with no reachable behavior difference to revert-and-observe: the JSDoc line is never read by any code path (TypeScript doesn't type-check comment prose), and the exemption reason string is dead data as far as check-doc-component-types.mjs's accept/reject logic goes — the gate keys off matrix/joined (untouched) and only ever prints the reason string in a pass-report, never branches on its content. There is no artifact-vs-source distinction to report per leg because there is no behavior boundary to cross in either direction.

All verification above ran against commit 3fefe5fde (this branch's current head).

Scope note

Nothing else rides along. Sweep-pack rules followed: only the two lines named in the dispatch order changed.

Generated by Claude Code

- GanttViewMode JSDoc undercounted its granularities at four; the type, VIEW_MODES, NOMINAL_DAYS, the column builder, the toolbar and the header-band logic all honor a fifth, 'year'. One word. - DOC_TYPE_EXEMPTIONS reason strings for plugin-report.mdx cited ReportInput, retired from @objectstack/spec's export surface at rc.6. Renamed to the live member, ReportSchema.type; the exemptions themselves (matrix/joined) are untouched. No behavior change in either file.

github-actions · 2026-08-19T15:27:38Z

✅ Console Performance Budget

Metric	Value	Budget
Main entry (gzip)	25.3 KB	350 KB
Entry file	`index-CuENH-rI.js`	—
Status	PASS	—

📦 Bundle Size Report

Package	Size	Gzipped
app-shell (index.js)	9.83KB	3.70KB
app-shell (runtime-config.js)	7.42KB	2.32KB
app-shell (types.js)	0.01KB	0.04KB
app-shell (urlParams.js)	8.92KB	3.41KB
auth (AuthContext.js)	0.31KB	0.24KB
auth (AuthGuard.js)	1.17KB	0.53KB
auth (AuthProvider.js)	29.33KB	7.05KB
auth (AuthShell.js)	3.49KB	1.40KB
auth (ForgotPasswordForm.js)	12.21KB	3.45KB
auth (LoginForm.js)	18.13KB	5.39KB
auth (PreviewBanner.js)	0.90KB	0.50KB
auth (RegisterForm.js)	6.64KB	2.21KB
auth (SocialSignInButtons.js)	9.60KB	3.89KB
auth (UserMenu.js)	3.40KB	1.22KB
auth (auth-gate-events.js)	1.29KB	0.66KB
auth (authStyles.js)	5.04KB	1.72KB
auth (createAuthClient.js)	40.21KB	10.79KB
auth (createAuthenticatedFetch.js)	6.34KB	2.43KB
auth (index.js)	2.71KB	1.22KB
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.02KB	0.88KB
auth (useIsWorkspaceAdmin.js)	1.61KB	0.85KB
collaboration (CommentThread.js)	26.07KB	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.65KB	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)	506.75KB	113.40KB
core (index.js)	4.11KB	1.62KB
create-plugin (index.js)	10.08KB	3.26KB
data-objectstack (index.js)	159.80KB	44.34KB
fields (index.js)	237.07KB	59.46KB
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.42KB	1.39KB
i18n (pickLocalized.js)	3.69KB	1.73KB
i18n (provider.js)	23.13KB	7.63KB
i18n (useDisplayLocale.js)	2.85KB	1.45KB
i18n (useObjectLabel.js)	29.43KB	7.15KB
i18n (useSafeTranslation.js)	7.77KB	3.13KB
layout (index.js)	39.16KB	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.74KB
mobile (index.js)	1.50KB	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.71KB	0.42KB
mobile (useResponsiveConfig.js)	1.36KB	0.63KB
mobile (useSpecGesture.js)	4.32KB	1.64KB
mobile (useTouchTarget.js)	1.01KB	0.54KB
permissions (MePermissionsProvider.js)	9.35KB	3.31KB
permissions (PermissionContext.js)	0.31KB	0.25KB
permissions (PermissionGuard.js)	0.89KB	0.45KB
permissions (PermissionProvider.js)	4.42KB	1.42KB
permissions (evaluator.js)	5.12KB	1.74KB
permissions (index.js)	0.91KB	0.41KB
permissions (store.js)	0.91KB	0.42KB
permissions (useFieldPermissions.js)	1.28KB	0.52KB
permissions (usePermissions.js)	1.81KB	0.83KB
plugin-ai (index.js)	15.75KB	3.80KB
plugin-calendar (index.js)	46.62KB	12.83KB
plugin-charts (index.js)	64.75KB	18.37KB
plugin-chatbot (index.js)	181.21KB	43.14KB
plugin-dashboard (index.js)	127.92KB	32.80KB
plugin-designer (index.js)	212.39KB	42.83KB
plugin-detail (index.js)	241.46KB	60.56KB
plugin-editor (index.js)	2.46KB	1.10KB
plugin-form (index.js)	124.19KB	30.20KB
plugin-gantt (index.js)	164.10KB	39.87KB
plugin-grid (index.js)	198.22KB	53.28KB
plugin-kanban (index.js)	52.93KB	14.60KB
plugin-list (index.js)	111.66KB	27.13KB
plugin-map (index.js)	20.08KB	6.62KB
plugin-markdown (index.js)	13.72KB	4.69KB
plugin-report (index.js)	43.49KB	11.93KB
plugin-timeline (index.js)	26.68KB	7.66KB
plugin-tree (index.js)	8.50KB	2.88KB
plugin-view (index.js)	84.55KB	20.67KB
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.44KB	0.22KB
providers (types.js)	0.01KB	0.04KB
react-runtime (index.js)	5.62KB	2.34KB
react (LazyPluginLoader.js)	3.77KB	1.33KB
react (SchemaRenderer.js)	36.10KB	12.26KB
react (data-invalidation.js)	5.05KB	2.08KB
react (index.js)	1.33KB	0.69KB
react (schema-input.js)	1.45KB	0.83KB
react (spec-input.js)	0.20KB	0.18KB
sdui-parser (codegen.js)	5.41KB	2.34KB
sdui-parser (index.js)	4.77KB	2.16KB
sdui-parser (input-type.js)	2.84KB	1.40KB
sdui-parser (parse.js)	10.76KB	3.17KB
sdui-parser (provenance.js)	3.66KB	1.82KB
sdui-parser (types.js)	0.29KB	0.24KB
sdui-parser (validate.js)	6.92KB	2.40KB
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)	0.20KB	0.18KB
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-retry.js)	4.32KB	2.02KB
types (index.js)	3.08KB	1.53KB
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 (system-fields.js)	3.33KB	1.54KB
types (theme.js)	0.20KB	0.18KB
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

os-support-ai · 2026-08-19T15:38:40Z

ACCEPT — PM review, round 17. Sweep pack, two cards.

Path surface (git diff --name-only origin/main... @ 3fefe5f): 3 files — packages/plugin-gantt/src/GanttView.tsx (one comment line), scripts/check-doc-component-types.mjs (two reason strings), one changeset. Zero governed-surface hits. Nothing rode along; the sweep-pack rule held.
Gates: every gate job completed: success — Lint, Type Check, Test shards 1–4, Build & E2E, Build Docs, Doc Snippet / Doc Component Type Check, Changeset Declaration / Bump Policy / Fixed Group, Bundle Analysis, Control Byte Scan, Internal Docs Link Check, Skill Guide Path Check. No cancelled, no in_progress.
Bump: patch on @object-ui/plugin-gantt; scripts/ is not a released package, so finding: DOC_TYPE_EXEMPTIONS reasons cite ReportInput, a symbol @objectstack/spec does not export #5139's half owes none. check-changeset-presence.mjs was run and its verdict followed rather than guessed.
Diff verified line by line against the two cards. The exemption entries, their keys and every line of gate logic are untouched — only the reason prose moved. ReportSchema.type over the generic Report kind is the better call and it was defended from the current export surface rather than asserted.
Reverse-verification declared degenerate, plainly, instead of filled in. That is the correct report for a change with no reachable behaviour: the JSDoc is never read by any code path, and the exemption reason is data the gate prints but never branches on. Saying so beats a fabricated leg.

One note for the record, on the verification method rather than the change: the report reasons that because assertCanonicalVitestInvocation does not cover plugin-gantt, the package-scoped run is "its real invocation". The measurement was sound — 44 files, cross-checked against find … | wc -l = 44, which rules out the trap-1 signature — but the framing is off, and the repo's own docs are what mislead here. scripts/vitest-invocation-guard.mjs's header claims "Every per-package vitest.config.ts re-exports the root config … so no package-level path skips this file", and that is false for 17 packages including this one. The consequence is not miscollection; it is that those packages run under a different config than CI does, so package-scoped green is not CI green. Recorded on #5313 with the measurement. Nothing to change in this PR — CI ran the root config and is green.

Merging via the queue.

Generated by Claude Code

github-actionsBot added the plugin label Aug 19, 2026

os-support-ai mentioned this pull request Aug 19, 2026
finding: DOC_TYPE_EXEMPTIONS reasons cite ReportInput, a symbol @objectstack/spec does not export #5139
Closed

os-support-ai marked this pull request as ready for review August 19, 2026 15:38

os-support-ai added this pull request to the merge queue Aug 19, 2026

Merged via the queue into main with commit 449ffe8Aug 19, 2026
22 checks passed

os-support-ai deleted the claude/issue-5132-5139-stale-doc-text branch August 19, 2026 15:39

Navigation Menu

Uh oh!

docs: fix two stale-symbol doc/comment strings (GanttViewMode JSDoc, ReportInput exemption reasons) - #5331

docs: fix two stale-symbol doc/comment strings (GanttViewMode JSDoc, ReportInput exemption reasons)#5331
os-support-ai merged 1 commit into
mainfrom
claude/issue-5132-5139-stale-doc-text

os-support-ai commented Aug 19, 2026•
edited
Loading

Uh oh!

github-actionsBot commented Aug 19, 2026

Uh oh!

os-support-ai commented Aug 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

os-support-ai commented Aug 19, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before / after

#5132 — GanttViewMode JSDoc undercounted granularities

#5139 — DOC_TYPE_EXEMPTIONS reason cites a retired symbol

Verification

Scope note

Uh oh!

github-actionsBot commented Aug 19, 2026

✅ Console Performance Budget

📦 Bundle Size Report

Size Limits

Uh oh!

os-support-ai commented Aug 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

os-support-ai commented Aug 19, 2026•
edited
Loading