Uh oh!
There was an error while loading. Please reload this page.
docs(core): name report-schema.mdx's subject ReportComponentSchema - #6192
Merged
Conversation
The page called its subject `ReportSchema` in four prose/frontmatter sites while its own example fence, its property tables (PR #6168) and the actual declaration all say `ReportComponentSchema` (packages/types/src/reports.ts:359). `ReportSchema` is not a dead name: `@objectstack/spec` exports it for the dataset-bound report shape (json-schema/ui/Report.json — name / label / dataset / rows / columns / values), which is what content/docs/plugins/plugin-report.mdx documents. A reader following the old name landed on a real but wrong declaration. `@object-ui/types` already re-exports that spec symbol under the prefixed name `SpecReportSchema` "to avoid collision", so the prose was the last place using the bare name for the component shape. Prose and frontmatter only. No source change, no fence touched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019b5UBNMtTzKbVtZZGvFuxe
yinlianghui-tw
marked this pull request as ready for review
August 24, 2026 23:56
Uh oh!
There was an error while loading. Please reload this page.
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes#6171
Renames the subject of
content/docs/core/report-schema.mdxfromReportSchematoReportComponentSchema. Prose and frontmatter only — no source change, no fence touched.Why this is more than a typo
ReportSchemais not a dead name, so a reader following it landed on a real but wrong declaration rather than on nothing. Stated from live readings in this tree rather than inherited from the card:@objectstack/spec17.2.0 does exportReportSchema, for the dataset-bound report shape shipped asjson-schema/ui/Report.json. Its top-level properties measure asname / label / description / type / dataset / rows / columns / values / runtimeFilter / order / drilldown / chart / blocks / …— a different shape, and the onecontent/docs/plugins/plugin-report.mdxdocuments, where the name is correct and untouched here.@object-ui/typesdoes not export the bare name. It imports the spec symbol and deliberately re-exports it prefixed —packages/types/src/spec-report.ts:103,export const SpecReportSchema = SpecReportSchema_;, under a comment reading "Spec* prefix to avoid collision with legacy reports.ts". The repo had already renamed around this collision everywhere except the prose on this page.ReportComponentSchema, declared atpackages/types/src/reports.ts:359.What changed — the set was measured, not taken on trust
The card named three sites; the measured set is four, all prose/frontmatter, none inside a fence:
title: "Report Schema (ReportSchema)"ReportSchemaenables creating…"Lines 14 and 458 are the two the card's explicit list did not name. After the edit: exact-word
ReportSchemaon the page = 0 (was 4);ReportComponentSchema= 12 (was 8, all 8 pre-existing ones left byte-identical — PR #6168 landed those tables and the example fence, and re-touching them would stack this diff on a sweep for no reason).The exclusion is measured, not asserted.
git status --porcelainreports exactly 1 changed file, andcontent/docs/plugins/plugin-report.mdxre-measures to the samesha256 6003c22e…e1bf3it had before the edit, still carrying its 1 correctReportSchemaoccurrence.Verification — at final head
0f04ff605Exit codes captured by redirect before any pipe; each gate quoted by its own verdict line, never a bare
$?.check:doc-snippetscheck:doc-typestypeliterals)docs:check-linkscheck:control-bytescheck:doc-fencescheck:doc-fenceswas not in the dispatch list — it was added by deriving scope from each gate's own configuration (DOCS_ROOT = 'content/docs'), which covers this file. Its #5867 shrink-only ratchet reading is unmoved: this diff touches no fence.Also note the dispatch named the gate
check:doc-snippet-types; the script exists but the package script is spelledcheck:doc-snippets(scripts/check-doc-snippet-types.mjs). The real spelling is what ran.First run of
check:doc-snippetsexited 1 and was not a failure of this diff — it printed "The snippet program was NOT run: the packages it resolves against are not built". Afterturbo run build(43/43 successful) it re-ran green. Recorded because the unbuilt-tree exit is indistinguishable from a real failure at the exit-code level.Changeset: none, per the presence gate's own verdict — objectui has no
skip-changesetlabel mechanism, so this verdict is the declaration form:Root vitest (per objectui#3378, never package-scoped) — run narrowed, and the narrowing is declared as a measurement rather than an omission:
vitest list --filesOnly= 1971 test files.core/report-schema.vitest.config.mtsinclude globs arepackages/**,examples/**,eslint-rules/**,scripts/**— the stringcontent/docsappears 0 times in the config, so no project can pick up an.mdxunder it.The one test file that even mentions this page does so in a prose comment and never reads it from disk; it was run anyway: 1 passed (1), 5 tests passed.
In-flight interest on this page
Per the repo's shared-surface guidance, two other cards hold interest in
content/docs/core/report-schema.mdx:content/docs/core/report-schemaauthoring example contradicts the types it annotates —dataSourceis typed as the runtimeDataSourceadapter, andexportsdemands all five formats #6121 covers this same page's authoring examples contradicting their types (dataSource,exports) and carriesneeds-user-decision. Out of scope here, and checked rather than assumed: its subject lines live inside the fences and the property table (lines 88, 231), while this diff is lines 2, 10, 14 and 458. No overlap, so nothing was decided on its behalf.coregroup (11 blocks / 1 file) covers this page'splaintextfences and is blocked behind finding(docs/types): everycontent/docs/core/report-schemaauthoring example contradicts the types it annotates —dataSourceis typed as the runtimeDataSourceadapter, andexportsdemands all five formats #6121. This diff changes no fence, andcheck:doc-fencesconfirms the ratchet population is unchanged.Neither is addressed by this PR; both remain open.
Generated by Claude Code