docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

docs(spec): state the measured dependsOn spelling facts in the option-description docblock - #15055

Merged
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact
Sep 3, 2026
Merged

docs(spec): state the measured dependsOn spelling facts in the option-description docblock#15055
zhuangjianguo merged 4 commits into
mainfrom
claude/issue-13916-option-dependson-docblock-fact

Conversation

@claude

@claudeclaudeBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Fixes#13916
Fixes#14583

Clause ②: no — path limb fires (packages/spec/src/data/field.zod.ts, comment text); content limb no: no accept-set or surface change

Comment text plus one rotted doc anchor. No schema member moves and no expect() changes: the option shape accepts and refuses exactly what it did before this branch.

Files

  • packages/spec/src/data/field.zod.ts — the option-description docblock
  • packages/spec/src/data/field-rows-option-description.test.ts — the file-header docblock and the inline comment inside the refusal pin
  • content/docs/permissions/system-context.mdx — one line anchor, rewritten by check-system-context-census.mjs --fix (see "Anchor rot" below). This page is cross-lane shared and is re-dirtied by every landing on it, so origin/main was merged into the branch (no rebase) right before the final union and the census re-run after that merge.

The ruling this states

Maintainer, 2026-09-02, recorded on objectstack-ai/objectui#6153 (comment 5510108593, decision batch item 4, recommendation A, verbatim 「同意」): the contract's field-level cascade key is the camelCase dependsOn; objectui's BaseFieldMetadata mirrors it and its widgets lose their casts; objectui's snake_case twin retires on its own card under enforce-or-remove. That amends the 2026-09-01 ruling, whose premise had been inherited from the very comment this PR corrects — the sentence claiming a snake_case field-level key that this package has never declared.

Independently measured here against the built schema before the wording was written: FieldSchema accepts dependsOn and refuses the snake_case spelling with a rename hint to dependsOn; SelectOptionSchema refuses both spellings and accepts description. Prose and ruling agree, so nothing in the comments rests on a citation alone.

Before / after — the three prose sites

1. field.zod.ts, the option-description docblock

before

Per the same inherited ruling, `dependsOn` is NOT declared here — the canonical
spelling (snake_case) already exists at the field level, and a camelCase twin
would be a second spelling for a declared concept.

after

Per the same inherited ruling this option shape declares `description` and no
cascade key of its own — `field-rows-option-description.test.ts` pins that
refusal. The cascade key this package declares is the camelCase `dependsOn`,
the `FieldSchema` member below; objectui mirrors that spelling on its own
metadata type (maintainer ruling 2026-09-02 on objectui#6153).

2. The pin file's header docblock

before

honest. Per the same inherited ruling, `dependsOn` is deliberately NOT
declared (the canonical snake_case spelling already exists at the field level).

after

honest. Per the same inherited ruling the option shape declares
`description` and no cascade key of its own; the cascade key lives on
`FieldSchema` as the camelCase `dependsOn`, which objectui mirrors
(maintainer ruling 2026-09-02 on objectui#6153).

3. The inline comment inside the refusal pin (a third site triage did not list)

before

`dependsOn`: the inherited #6153 ruling resolves it objectui-side (the widget
reads the canonical field-level snake_case spelling); declaring a camelCase
twin here is explicitly not licensed.

after

`dependsOn`: this option shape carries no cascade key of its own, per the
inherited #6140 / #6153 ruling. The cascade key is `FieldSchema`'s camelCase
`dependsOn`, which refuses the snake_case `depends_on` with a rename hint, and
objectui mirrors that spelling (maintainer ruling 2026-09-02 on objectui#6153).

The before-blocks above spell the snake_case token out in words where quoting it verbatim would defeat the grep below; the diff carries the literal text. No justification sentence replaces the falsified one — the conclusion is stated as what the shape does, with the inherited ruling cited and nothing invented.

Acceptance

#14583's criterion is that grep -n depends_on packages/spec/src/data/field.zod.ts return zero lines. At daf2fd30:

$ grep -n depends_on packages/spec/src/data/field.zod.ts
$ echo $?
1
$ grep -c dependsOn packages/spec/src/data/field.zod.ts # instrument control
4

Repo-wide under packages/spec/src, git grep -n depends_on now returns three lines and none of them is in field.zod.ts:

packages/spec/src/data/field-rows-option-description.test.ts:208: // which refuses the snake_case `depends_on` with a rename hint, and
packages/spec/src/ui/view.test.ts:234: dependenciesField: 'depends_on',
packages/spec/src/ui/view.test.ts:434: dependenciesField: 'depends_on',

The first is the single permitted mention — the spelling FieldSchema refuses, named where the refusal is pinned. The two view.test.ts lines are dependenciesField: 'depends_on': a gantt fixture naming a user field whose machine name is snake_case, which is correct for a data value (Prime Directive #3) and was never part of the false claim.

Anchor rot

Lint & Repo Gates went red on the previous head in the check:doc-anchors step, at node scripts/check-system-context-census.mjs: the docblock's new height moved the readonly declaration, so content/docs/permissions/system-context.mdx cited a line the census no longer calls an elevation read while the ledger row excusing the real line went unused. Repaired by the fixer the gate names, not by hand:

node scripts/check-system-context-census.mjs --fix
re-anchored content/docs/permissions/system-context.mdx:199 `field.zod.ts:1537` -> `field.zod.ts:1540`
check-system-context-census --fix: 1 anchor(s) rewritten

All three legs the CI step runs are green at daf2fd30, the census re-run after the origin/main merge: pnpm check:doc-anchors ("298 internal fragment links across 409 source files all resolve"), check-system-context-census.mjs --self-test, and the census itself ("OK — 106 elevation read sites in 20 packages across 45 files, all anchored; 140 anchors resolve, 27 declared non-read").

Changeset

pnpm --filter @objectstack/spec run check:generated (no --fix), after rebuilding dist from the edited source: "✓ All 15 generated artifacts are up to date." The JSDoc is not the JSON-Schema projection (.describe() is, and none changed), and the docs page is not a published package artifact. No changeset; the skip-changeset label stays on this PR.

Verification record — everything below at daf2fd30

  • pnpm --filter '@objectstack/spec^...' build + pnpm --filter @objectstack/spec buildVERDICT command-exit 0
  • pnpm --filter @objectstack/spec exec vitest run --maxWorkers=2465 files / 12396 tests passed
  • pnpm --filter @objectstack/spec run typecheck — clean, including check:test-typecheck ("OK — @objectstack/spec's test layer compiles under packages/spec/tsconfig.test.json"), so the edited test file sits inside a program that was really checked
  • pnpm --filter @objectstack/spec run check:generated — 15/15 up to date
  • node scripts/pm/dispatch-gates.mjs --repo objectstack-ai/objectstack re-derived on the post-merge diff (which now includes the docs page, and pulled in the docs family it adds), then 46 gate invocations, all exit 0: spec check:docscheck:api-surfacecheck:authorable-surfacecheck:export-originscheck:livenesscheck:llms-txtcheck:skill-refscheck:strictness-ledgercheck:variant-docscheck:yaml-examplescheck:empty-statecheck:exported-anycheck:dual-source-exportscheck:entry-nameabilitycheck:browser-reachable-entriescheck:skill-examples; repo check:nul-bytescheck:merge-drivercheck:published-filescheck:doc-authoringcheck:cross-package-test-inputscheck:test-source-aliascheck:spec-parsed-aliascheck:partof-closing-keywordcheck:changeset-gate-self-testscheck:objectql-double-limitcheck:where-matchercheck:page-declaration-shapecheck:slot-lookupcheck:type-source-resolutioncheck:logger-receiver-detachcheck:engine-double-contractcheck:doc-anchorscheck:corpus-claim-driftcheck:docs-audit-scopecheck:docs-redirectscheck:docs-single-h1check:published-readme-linkscheck:react-page-adapter-contractcheck:role-wordcheck:skill-identifier-livenesscheck:vendor-version-stamps; @objectstack/lintcheck:doc-formula-expressions and check:doc-security-posture; and the census self-test plus the census

Three gates first exited on their own PREREQUISITE paths (nothing measured, never recorded as findings) and went green after the build they name: check:doc-formula-expressions needed @objectstack/formula and @objectstack/lint built, and check:skill-examples needed @objectstack/client-react built with its dependency closure. Naming note: the dispatch's check:closing-keyword-parity is spelled check:partof-closing-keyword here. Declared narrowing: the repo-wide pnpm lint sweep and the remaining families of the 204 discovered are left to CI, which runs the farm.

Still open elsewhere

#15058 — the pending .changeset/field-rows-and-option-description-declared.md carries a fourth copy of the same false sentence and is release-notes input. It is filed unassigned and stays out of this PR: editing .changeset/** pulls in gate families (check:objectui-changeset, check:pm-half-states) outside this card's verification surface.

🤖 Generated with Claude Code

https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i


Generated by Claude Code

…-description docblock
The option-description docblock and the two prose sites in its pin file
said the canonical spelling `depends_on` already exists at the field
level. Measured against the schema it does not: `FieldSchema` declares
the camelCase `dependsOn` and refuses `depends_on`, and neither spelling
is declared on the option shape. Rewrite the three sites to state only
what is measured, and leave the option-face question with objectui#6153
rather than substituting a new justification for the conclusion.
Comment text only — no schema member moves.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@claudeclaudeBot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 3, 2026
@github-actions

github-actionsBot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

1 anchor(s) derived from 1 changed package(s); no hand-written page names any of them, so this run has nothing to listnot a clean bill of health. This check sees only pages that NAME a derived anchor: one that documents this change in prose, or enumerates it in an authoring dialect, names none and stays invisible to it on every run.

What this run could not see
  • the SDK route bridge reached 47 of 219 client-bound route-ledger rows — the other 172 have no registrar path: tail to select them, so pages documenting THEIR client methods cannot appear above, on this or any run. Of those 172: 14 are remediable by widening that discovery convention (an in-repo file declares the path; the convention did not scan it); 56 are structural — on a ledger where NOT ONE row is declared in-repo, so no discovery change reaches them at any price; 102 are undecided (no in-repo declaration, on a ledger that has other in-repo registrars — absence and an unreadable spelling are not distinguishable here). The rows themselves: node scripts/docs-audit/affected-docs.mjs --bridge-coverage
  • a page that states a rule by its inputs shares no identifier with the emitter that implements the rule, so an emitter-only diff cannot list it — not on this run and not on any run. Measured on fix(driver-sql): emit varchar(maxLength) for a text field a declared index keys on #11430: content/docs/protocol/objectql/types.mdx documents the text-family column mapping by the ObjectQL type names it maps FROM (text / textarea / html) while the diff changed createColumn; it went unlisted, and it was the page that diff falsified, in four places. No shared token exists to detect this on, so a rule your change carries has to be re-read by hand in the pages that restate it.

Coarse fallback — 128 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832packageMentionDocs.

Which tree this was computed on

This run read content/docs from 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 — the merge of head daf2fd30d62d402649c72c15e12ff0e28bef8323 into base 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832, which is what actions/checkout gives a pull_request run. Not the PR head.

A worktree cut from an older main holds a different content/docs, so re-deriving there can legitimately return a different list — that is a different tree, not a wrong row. To answer on the same tree:

# while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3 && git checkout 9827f714d5e1f8dcde89b7a5213fccd863c7ebd3
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 daf2fd30d62d402649c72c15e12ff0e28bef8323 && git checkout -B drift-repro 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832 && git merge --no-ff daf2fd30d62d402649c72c15e12ff0e28bef8323
node scripts/docs-audit/affected-docs.mjs --json 101ad2cc13fafd8a3879ffc4a6ce6133c02ed832

⚠️ That checkout carried uncommitted changes, so the commit above does not fully identify what was read.

…de-key ruling
The maintainer amended the inherited reading on 2026-09-02: the contract's
field-level cascade key is the camelCase `dependsOn`, objectui mirrors that
spelling on its own metadata type, and objectui's snake_case twin retires on
its own card. Re-word the three prose sites to that: the option shape declares
`description` and no cascade key of its own (the pin file asserts the refusal),
and the cascade key is `FieldSchema`'s `dependsOn`.
`field.zod.ts` now carries no snake_case occurrence at all; the test file keeps
one, naming the spelling `FieldSchema` refuses with a rename hint. No `expect()`
changes, no schema member changes.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

CI note (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T19:28Z) — Lint & Repo Gates is red on head 9300bca5 at the check:doc-anchors step: check-system-context-census reports [anchor-is-not-a-read-site] for packages/spec/src/data/field.zod.ts:1537 and [ledger-row-unused] for :1542 (job 100779705679). Root cause: this PR's docblock rewrite adds net lines above the readonly declaration that content/docs/permissions/system-context.mdx anchors, so the citation shifted from :1537 to :1542 — pure line rot, repaired by the gate's own --fix.

This PR is already in a patch round (REWORK verdict on #13916, 5530907654: wording moves to the 2026-09-02 ruling A on objectui#6153, Fixes #14583 added). The dev has been told to fold the census --fix into that same push and to declare the rewritten permissions page in the file list. No separate push for the red; the next head carries both.


Generated by Claude Code

… the docblock reflow
`check-system-context-census.mjs --fix` rewrote the one rotted line anchor
(`field.zod.ts:1537` to `:1540`): the option-description docblock above the
`readonly` declaration changed height, so the page cited a line the census no
longer calls a read site while the ledger row it excuses went unused. Pure line
rot, repaired by the fixer, not by hand.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0174WZTU6XcFcS7g2kykC53i
@zhuangjianguoClaude

Copy link
Copy Markdown
Collaborator

Landing provenance (PM seat domain:spec, session_0174WZTU6XcFcS7g2kykC53i, 2026-09-03T20:24Z) — flipping to ready and enabling auto-merge (squash).


Generated by Claude Code

@zhuangjianguo
zhuangjianguo marked this pull request as ready for review September 3, 2026 20:24
@zhuangjianguo
zhuangjianguo added this pull request to the merge queueSep 3, 2026
Merged via the queue into main with commit d261cefSep 3, 2026
39 checks passed
@zhuangjianguo
zhuangjianguo deleted the claude/issue-13916-option-dependson-docblock-fact branch September 3, 2026 20:51
os-trump pushed a commit that referenced this pull request Sep 3, 2026
…arity
Brings in PR #15062 (`os i18n check --help`), which lands in packages/cli
while this branch is open — the dispatch named it as the one to merge and
re-verify against. Also #15065 (rest), #15063/#15067 (docs) and #15055 (spec).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016yfqQh2dBgPAymYd7xipza
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationprotocol:datasize/sskip-changesetPR has no user-facing published change; bypasses the changeset gatetests

Projects

None yet

2 participants

@zhuangjianguo@claude