Skip to content

docs(cli): say the three code subpaths are ESM - #26352

Merged
objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-nhvl8m
Oct 26, 2026
Merged

objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-nhvl8m

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Requested by Steve · project thread
Part of #26206

Clause-②: no
Metadata-protocol: none

What changes

This is the follow-up #26321 named. packages/cli/README.md's "Public subpath exports" section gains one paragraph saying the three code subpaths (., ./console, ./hook-body) are ESM. Load them with import. A CommonJS caller reaches them through import(), or through require() only on a Node that loads ES modules synchronously (22.12 and later).

That is the written declaration for the three attw CJSResolvesToESM items #26321 left in place on purpose. Their export maps stay { types, default }: on Node 22.22.0, require() of all three loads today through require(esm), and an ESM-only map change would break those callers. No export map, code or build changes. There is one patch changeset for @objectstack/cli, because the README ships in its tarball.

The card's remaining half, retiring @objectstack/driver-memory's default export, is not touched here. It is Blocked-by #26324, so #26206 stays open for it.

Acceptance notes

  • At c8ee4e79, after a full turbo run build --filter='./packages/**' (75/75): all 55 dispatch-gates --commands families exit 0, each exit captured before any pipe. --ran reconciliation: 55 derived, 55 run, 0 NOT-MEASURED (a derived zero).
  • check-published-readme-exports exit 0. check-published-readme-links exit 0 (552 links, 234/234 relative targets found).
  • check-adr-0087-registration --base origin/main and check-changeset-no-major --base origin/main: both exit 0, as part of the family run.
  • No tests: the diff is one README paragraph and a changeset.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WTCPNVkuDk7DNaZSdM3DZv


Generated by Claude Code

@github-actions github-actions Bot added size/s documentation Improvements or additions to documentation tooling labels Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

⚠️ 1 changed file(s) yielded no anchor (packages/cli/README.md), so the pages documenting them are NOT COVERED by this run — this is not a clean bill of health for those files. Nothing else in this diff resolved to a documentable surface (no symbol, route or SDK anchor derived from 1 changed package(s)).

What this run could not see
  • 1 changed file(s) yielded no anchor (packages/cli/README.md) — pages documenting those are invisible to this run
  • 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.
  • a key NAME is not a key, so the hand re-read the line above prescribes can land on the wrong schema. The same spelling is authorable on one governed type and a [REMOVED] tombstone on another for each of active, aria, joins, objects, template, tools and version (censused on [finding] tools is a key on BOTH AgentSchema (tombstoned, dead) and SkillSchema (live, cloud-attested), so a name-based search attributes skill examples to the agent key — it produced a false stop-the-line alarm on PR #19059 #19093 over the liveness ledger's governed types, top-level keys); nothing in a search result distinguishes the two, so a grep hit on a LIVE example reads as evidence about the DEAD key. Measured on fix(spec): the agent.tools liveness row says dead — it claimed live on a key the schema tombstoned #19059: content/docs/ai/agents.mdx was reported as contradicting the agent.tools tombstone over its tools: example at :161, which is inside the defineSkill({ block opened at :155 — the page was already correct. Settle ownership by PARSING the value against both schemas, never by the name: that literal PASSES SkillSchema, and as an AgentSchema it FAILS at tools with the tombstone prescription. ⛔ These names are not the whole class — a key retired through a .strict() guidance map leaves no tombstone in the walked shape and none of them here (tool.category, live as AIToolDefinition.category).

Coarse fallback — 31 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 83e9d718718508cc27cc3e889ea594b2b0d1d221 → packageMentionDocs.

@objectstack-fleet

Copy link
Copy Markdown
Contributor Author

席位核对 · ACCEPT · devx seat 2 · 2026-10-26T22:41Z

Seat domain:devx#2 (#20163) · session_01Q4MDXRbEJCNdPAP4SiXwp9 · reviewed head c8ee4e7920 · card #26206, claim 6426288426 (wave 7, delta S, PR 2). PR carries Part of #26206.


Generated by Claude Code

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 size/s tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants