Skip to content

fix(spec): correct console route spellings in JSDoc to /_console/… - #9155

Merged
os-zhuang merged 1 commit into
mainfrom
claude/issue-9078-console-route-spelling
Aug 16, 2026
Merged

fix(spec): correct console route spellings in JSDoc to /_console/…#9155
os-zhuang merged 1 commit into
mainfrom
claude/issue-9078-console-route-spelling

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Fixes #9078

What

Three JSDoc sites in packages/spec/src/ui/{view,action}.zod.ts spelled the console form routes without the /_console underscore, against the measured mount (CONSOLE_PATH = '/_console' in packages/cli/src/utils/console.ts:43). No bare /console route resolves.

  • view.zod.ts:2446`/console/f/:slug``/_console/f/:slug` (inside the FormViewSchema.submitBehavior doc, including the 2026-08-10 #7245 ruling sentence — the ruling itself pins the mode-aware submitBehavior default, not path spelling, so only the incidental path text changed; the ruling's substance is byte-identical)
  • view.zod.ts:2449`/console/forms/:name``/_console/forms/:name` (same doc block)
  • action.zod.ts:500`/console/forms/:name``/_console/forms/:name` (the type: 'form' action target doc)

Sweep guard: grepped both files for any other bare /console/ spelling — none found beyond the three named sites.

Why

These are JSDoc comments, not .describe() strings, so this is a comment-only, byte-identical-behavior change — no schema/accept/reject-path is touched.

Products follow source

Ran the regen pipeline per AGENTS.md: pnpm --filter @objectstack/spec build then pnpm --filter @objectstack/spec check:generated. All 13 generated artifacts (including check:docscontent/docs/references/**) report up to date — no diff produced. This confirms the issue's premise: these JSDoc blocks are not currently published to any reference page, so the regen step is a no-op here. Nothing to commit under content/docs/references/.

Tests

At head a3ddfeee7:

  • pnpm --filter @objectstack/spec build — green
  • pnpm --filter @objectstack/spec check:generated — all 13 generated artifacts up to date (no-op, as expected for a comment-only change)
  • pnpm --filter @objectstack/spec typecheck — green (tsc --noEmit, check:scripts-typecheck, check:test-typecheck)
  • pnpm --filter @objectstack/spec test — 406 test files / 10807 tests passed
  • pnpm check:cross-package-test-inputs — green
  • pnpm check:merge-driver — green
  • pnpm check:spec-parsed-alias — green (ADR-0122 alias convention: 1518 bare aliases, 837 pinned isomorphic, 681 paired)
  • pnpm check:type-source-resolution — green
  • pnpm check:i18n — green (built @objectstack/cli first per the gate's own prerequisite message; 9 packages, all bundles in sync, no undeclared authoring keys)
  • pnpm check:nul-bytes — green (5998 tracked text files scanned)
  • pnpm --filter @objectstack/lint run check:doc-formula-expressions — green

Gate union derived from actual changed paths via node scripts/pm/dispatch-gates.mjs packages/spec/src/ui/view.zod.ts packages/spec/src/ui/action.zod.ts — all 7 matched families run above; nothing further implicated by this diff.

Changeset

.changeset/console-route-jsdoc-spelling.md@objectstack/spec patch.

Generated by Claude Code


Generated by Claude Code

Three JSDoc sites in packages/spec/src/ui/{view,action}.zod.ts spelled
the console form routes without the /_console underscore, against the
measured mount (CONSOLE_PATH = '/_console' in packages/cli/src/utils/
console.ts). No route resolves at a bare /console prefix.

- view.zod.ts:2446 and :2449 (FormViewSchema.submitBehavior JSDoc,
  including the 2026-08-10 #7245 ruling sentence — the ruling itself
  pins the mode-aware submitBehavior default, not path spelling, so
  only the incidental path text changed)
- action.zod.ts:500 (the type: 'form' action target doc)

Comment-only change: these are JSDoc blocks, not .describe() strings,
so accept/reject behaviour and the generated references pipeline are
both unaffected (verified: pnpm --filter @objectstack/spec
check:generated reports all 13 generated artifacts up to date, no
diff under content/docs/references/).

Fixes #9078
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/spec.

106 hand-written doc(s) reference the affected code — list omitted above 15 rows. Re-derive: node scripts/docs-audit/affected-docs.mjs --json origin/main.

7 release-owned page(s) also affected — read-only, see AGENTS.md Documentation Guardrails.

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@github-actions github-actions Bot added documentation Improvements or additions to documentation protocol:ui tooling labels Aug 16, 2026
@os-zhuang
os-zhuang marked this pull request as ready for review August 16, 2026 15:56
@os-zhuang
os-zhuang added this pull request to the merge queue Aug 16, 2026
Merged via the queue into main with commit d9813a9 Aug 16, 2026
27 checks passed
@os-zhuang
os-zhuang deleted the claude/issue-9078-console-route-spelling branch August 16, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation protocol:ui size/s tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

packages/spec schema comments still spell the console form routes /console/… (no underscore) — a path that does not resolve

2 participants