verify-package-readme-model-experience.ts 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. /**
  2. * Doc-sync gate for package README Model Experience sections. It validates
  3. * audited package classifications, model/token/KV-cache fields, package-owned
  4. * text blocks, generated-catalog links, and final-section order. See the
  5. * [Model Experience Agent Note](../.agents/notes/implemented/process/2026-07-12-package-model-experience-contract.md).
  6. */
  7. import { existsSync, globSync, readFileSync } from 'node:fs'
  8. import { relative, resolve, sep } from 'node:path'
  9. import { markdownHeadingLines, markdownProseLines, type MarkdownProseLine } from './markdown.ts'
  10. const root = resolve(import.meta.dirname, '..')
  11. const HEADING = '## Model Experience'
  12. const LIMITATIONS_HEADING = '## Known Limitations and Deferred Work'
  13. const MODEL_VIEW_HEADING = '#### What the model sees'
  14. const TOKEN_EFFECT_HEADING = '#### Token effect'
  15. const KV_CACHE_EFFECT_HEADING = '#### KV Cache effect'
  16. const FIELD_HEADINGS = [MODEL_VIEW_HEADING, TOKEN_EFFECT_HEADING, KV_CACHE_EFFECT_HEADING] as const
  17. type SentenceKind = 'none' | 'indirect'
  18. interface SentenceContract {
  19. kind: SentenceKind
  20. reason: string
  21. }
  22. /**
  23. * Generic packages whose public contract is model-agnostic. Their READMEs omit
  24. * Model Experience entirely; the reason stays here as reviewable audit evidence
  25. * so an absent section cannot be mistaken for forgotten documentation.
  26. */
  27. const NO_MODEL_EXPERIENCE_SECTION: Readonly<Record<string, string>> = {
  28. 'packages/core/scope': 'The package is a model-agnostic registration and lifecycle primitive; model-facing consumers own any context selection.',
  29. 'packages/util/brand': 'The package is a type-only primitive erased at compile time.',
  30. 'packages/util/paths': 'The package only resolves harness-owned host paths; model-facing consumers own any rendered use.',
  31. }
  32. /**
  33. * Packages whose Model Experience is simple enough for one gated sentence plus
  34. * a KV-cache field. Every other package must carry canonical context-surface
  35. * blocks. A package moves on or off this list with its context behavior.
  36. */
  37. const SENTENCE_MODEL_EXPERIENCE: Readonly<Record<string, SentenceContract>> = {
  38. 'packages/bash/bash': { kind: 'indirect', reason: 'The service interface delegates all model rendering to dsh-tool-bash.' },
  39. 'packages/bash/bash-env': { kind: 'indirect', reason: 'The env service surfaces managed DSH_* facts through the shell tools (dsh-tool-bash/dsh-tool-pwsh); it registers no prompt or schema of its own.' },
  40. 'packages/bash/bash-local': { kind: 'indirect', reason: 'The executor backend delegates model rendering to dsh-tool-bash.' },
  41. 'packages/bash/pwsh-local': { kind: 'indirect', reason: 'The executor backend delegates model rendering to dsh-tool-pwsh.' },
  42. 'packages/code-runtime/code-runtime': { kind: 'indirect', reason: 'The service interface delegates model rendering to Code Mode in dsh-tools.' },
  43. 'packages/code-runtime/code-runtime-worker': { kind: 'indirect', reason: 'The worker backend delegates model rendering to Code Mode in dsh-tools.' },
  44. 'packages/typert/registry': { kind: 'none', reason: 'Runtime type registry; consumers (cordis_inspect, wire faces, gates) own any model-visible projection of registry contents.' },
  45. 'packages/typert/loader': { kind: 'none', reason: 'Loader integration only registers generated artifacts; consumers own any model-visible projection.' },
  46. 'packages/client/hmr': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  47. 'packages/client/modules': { kind: 'none', reason: 'Browser-side module-loading kernel machinery; registers no model surface.' },
  48. 'packages/client/test-runtime': { kind: 'none', reason: 'Browser-side test infrastructure (jsdom bench); registers no model surface.' },
  49. 'packages/client/ui-slots': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  50. 'packages/client/ui-primitives': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  51. 'packages/client/web-react': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  52. 'packages/client/schema-form': { kind: 'none', reason: 'Browser-side form-rendering library; registers no model surface.' },
  53. 'packages/client/connection': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  54. 'packages/client/runtime': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  55. 'packages/client/ui-layout': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  56. 'packages/client/ui-sidebar': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  57. 'packages/client/ui-conversation': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  58. 'packages/client/ui-slash': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  59. 'packages/client/ui-command': { kind: 'indirect', reason: 'The dispatch paths trigger the host command.execute RPC; each command handler\'s host package owns any model-visible effect.' },
  60. 'packages/client/ui-model': { kind: 'indirect', reason: 'Selection routes session.selectModel; the host snapshots the target at the next prompt-assembly boundary and owns the model-visible effect.' },
  61. 'packages/client/ui-goal': { kind: 'indirect', reason: 'The strip verbs route goal.* mutations; the host GoalService owns the model-visible goal/change context message.' },
  62. 'packages/client/ui-permission': { kind: 'indirect', reason: 'The picker submits the host /permission command; the knob events it appends own the model-visible effect through the sandbox/approval consumers.' },
  63. 'packages/client/ui-plan': { kind: 'indirect', reason: 'The chip dispatches /plan off; dsh-plan-mode owns the model-visible policy, exit tool, and logged state.' },
  64. 'packages/client/ui-question': { kind: 'indirect', reason: 'The package mounts dsh-tool-ask-user; that tool owns the model-visible schema and answer rendering.' },
  65. 'packages/client/ui-trajectory': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  66. 'packages/client/ui-workspace': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  67. 'packages/client/ui-theme': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  68. 'packages/client/ui-settings': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  69. 'packages/client/ui-settings-general': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  70. 'packages/client/ui-models': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  71. 'packages/client/locale': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  72. 'packages/client/web': { kind: 'none', reason: 'Browser-side UI plugin layer; registers no model surface.' },
  73. 'packages/examples/agent-spine-demo': { kind: 'indirect', reason: 'The bundle only mounts model-facing child plugins.' },
  74. 'packages/fs/fs': { kind: 'indirect', reason: 'The service interface delegates model rendering to dsh-tool-fs.' },
  75. 'packages/fs/fs-local': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-tool-fs.' },
  76. 'packages/hooks/hook-protocol': { kind: 'indirect', reason: 'Only the hook bridge plugins render decoded hook output to a model.' },
  77. 'packages/host/apiproxy': { kind: 'none', reason: 'The wire contract and fetch carriers move already-composed messages and register no model surface.' },
  78. 'packages/host/directory-picker': { kind: 'none', reason: 'The GUI-host picking seam registers no model surface.' },
  79. 'packages/host/directory-picker-auto': { kind: 'none', reason: 'The GUI-host picking chooser only mounts a backend row; registers no model surface.' },
  80. 'packages/host/directory-picker-browse': { kind: 'none', reason: 'The GUI-host picking backend registers no model surface.' },
  81. 'packages/host/directory-picker-native': { kind: 'none', reason: 'The GUI-host picking backend registers no model surface.' },
  82. 'packages/host/webserver': { kind: 'none', reason: 'The HTTP carrier bridges browser and API handler and registers no model surface.' },
  83. 'packages/host/frontend-static': { kind: 'none', reason: 'The SPA dist server answers browser asset requests and registers no model surface.' },
  84. 'packages/bundle/base': { kind: 'indirect', reason: 'The bundle is a patch-list carrier; each inserted row\'s package owns its model surface.' },
  85. 'packages/bundle/headless': { kind: 'none', reason: 'The one-shot runner submits the task as an ordinary user message; prompts and tools belong to the composed base/web bundles.' },
  86. 'packages/llm/llm': { kind: 'none', reason: 'The adapter registry forwards already-assembled requests unchanged.' },
  87. 'packages/llm/token-meter': { kind: 'indirect', reason: 'The measurement service leaves model-visible changes to its consumers.' },
  88. 'packages/lsp/lsp': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-lsp.' },
  89. 'packages/lsp/lsp-local': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-tool-lsp.' },
  90. 'packages/subprocess/subprocess': { kind: 'indirect', reason: 'The seam delegates all model rendering to consumer seams such as the bash executor family.' },
  91. 'packages/subprocess/subprocess-local': { kind: 'indirect', reason: 'The spawn backend delegates model rendering to consumer seams such as the bash executor family.' },
  92. 'packages/sandbox/sandbox-local': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-bash-sandbox and dsh-tool-bash.' },
  93. 'packages/sdk/create-sdk': { kind: 'indirect', reason: 'The initializer only writes project files; selected runtime plugins provide the generated project model surface.' },
  94. 'packages/sdk/helper': { kind: 'none', reason: 'The project domain edits files and registers no live agent or model surface.' },
  95. 'packages/sdk/scripts': { kind: 'indirect', reason: 'The launcher delegates model context to the loaded project plugin tree.' },
  96. 'packages/sdk/sdk-client': { kind: 'none', reason: 'Client-process library; the model surface lives in the spawned runtime\'s composed plugins.' },
  97. 'packages/sdk/sdk-protocol': { kind: 'none', reason: 'Client-facing wire library; the runtime plugins behind the serving entry own the model surface.' },
  98. 'packages/sdk/telemetry': { kind: 'none', reason: 'The launcher-side reporter sends developer-cycle telemetry and registers no live agent or model surface.' },
  99. 'packages/session-projection/session-projection': { kind: 'none', reason: 'The projection registry serves client-facing read models of already-logged session state and registers no model surface.' },
  100. 'packages/session-projection/session-projection-cache': { kind: 'none', reason: 'The persisted cache accelerates host-side cold reads of projection state and registers no model surface.' },
  101. 'packages/session-query/session-query': { kind: 'none', reason: 'The trusted query service exposes cloned records only to callers and registers no model surface.' },
  102. 'packages/session-query/session-query-sqlite': { kind: 'none', reason: 'The search backend returns hits only to callers and registers no model surface.' },
  103. 'packages/settings/settings': { kind: 'indirect', reason: 'The seam stores and resolves user settings; consumer plugins own any model surface a value feeds.' },
  104. 'packages/settings/settings-local': { kind: 'indirect', reason: 'The file provider stores and publishes namespace sections; consumers of ctx.settings own any model surface.' },
  105. 'packages/credentials/credentials': { kind: 'indirect', reason: 'The seam resolves credential references; the consuming adapter owns every model surface a value authorizes.' },
  106. 'packages/credentials/credentials-local': { kind: 'indirect', reason: 'The file/environment provider stores credential values; consumers of ctx.credentials own any model surface.' },
  107. 'packages/util/atomic-write': { kind: 'none', reason: 'Pure filesystem write primitive; registers no model surface.' },
  108. 'packages/telemetry/session-telemetry': { kind: 'none', reason: 'The seam observes the session stream and hands redacted copies outward; it registers no model surface.' },
  109. 'packages/telemetry/session-telemetry-otel': { kind: 'none', reason: 'The backend forwards seam records into the OTel SDK pipeline and registers no model surface.' },
  110. 'packages/skill/skill': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-skill.' },
  111. 'packages/skill/skill-local': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-tool-skill.' },
  112. 'packages/spill/spill': { kind: 'indirect', reason: 'The storage seam delegates model rendering to spill consumers.' },
  113. 'packages/spill/spill-local': { kind: 'indirect', reason: 'The storage backend delegates model rendering to spill consumers.' },
  114. 'packages/subagent/subagent': { kind: 'indirect', reason: 'The provider registry delegates parent-model rendering to dsh-tool-subagent.' },
  115. 'packages/support/acp-snapshot': { kind: 'none', reason: 'The test harness observes and normalizes transcripts without changing live requests.' },
  116. 'packages/support/agent-loop-testkit': { kind: 'none', reason: 'The test helper mounts services but neither drives nor modifies model requests.' },
  117. 'packages/support/invariants': { kind: 'none', reason: 'The observer validates requests but never rewrites their context.' },
  118. 'packages/support/loader-smoke': { kind: 'none', reason: 'The test harness observes child-process streams without changing live requests.' },
  119. 'packages/support/llm-mock-server': { kind: 'none', reason: 'The test server substitutes provider wire behavior without invoking a real model.' },
  120. 'packages/support/llm-replay': { kind: 'none', reason: 'The keyless adapter invokes no provider model.' },
  121. 'packages/typert/generator': { kind: 'none', reason: 'The build-time generator runs outside any agent runtime and touches no model request.' },
  122. 'packages/tasks/tasks': { kind: 'indirect', reason: 'Producer and control-surface plugins own all model rendering over the task registry.' },
  123. 'packages/tasks/tasks-local': { kind: 'indirect', reason: 'The registry backend delegates model rendering to producer plugins and dsh-tool-tasks.' },
  124. 'packages/examples/acp-demo': { kind: 'indirect', reason: 'The app bundle delegates request composition to dsh-agent-spine-demo and dsh-acp.' },
  125. 'packages/ui/app-boot': { kind: 'indirect', reason: 'Only the loaded plugin tree contributes model context.' },
  126. 'packages/examples/jsonrpc-demo': { kind: 'indirect', reason: 'Only the externally configured plugin tree contributes model context.' },
  127. 'packages/ui/permission': { kind: 'indirect', reason: 'The service writes mechanism events rendered by dsh-user-approval and dsh-tool-bash.' },
  128. 'packages/ui/user-interaction': { kind: 'indirect', reason: 'Model-facing consumers render provider answers and seam errors.' },
  129. 'packages/util/timeout': { kind: 'indirect', reason: 'Only timeout consumers render timeout outcomes.' },
  130. 'packages/util/retention': { kind: 'indirect', reason: 'Only retention consumers render retained content and omission metadata.' },
  131. 'packages/util/native-command': { kind: 'none', reason: 'The host-side subprocess runner registers no model surface.' },
  132. 'packages/web/web': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-web.' },
  133. 'packages/web/web-fetch-local': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-tool-web.' },
  134. 'packages/web/web-search-exa': { kind: 'indirect', reason: 'The provider backend delegates model rendering to dsh-tool-web.' },
  135. 'packages/workflow/workflow': { kind: 'indirect', reason: 'The service delegates parent and child model rendering to its consumer and engine.' },
  136. }
  137. interface Failure {
  138. path: string
  139. message: string
  140. }
  141. type Line = MarkdownProseLine
  142. interface ContextSurface {
  143. heading: Line
  144. modelView: Line
  145. tokenEffect: Line
  146. kvCacheEffect: Line
  147. title: string
  148. modelViewVerbatimBlocks: number
  149. verbatimBlocks: number
  150. }
  151. interface ParsedField {
  152. value: Line
  153. verbatimBlocks: number
  154. }
  155. /** Validate H5-plus-markdown literals nested under one Model Experience field. */
  156. function validateNestedVerbatim(raw: readonly string[], fragments: Set<string>): { blocks: number; error?: string } {
  157. let cursor = 0
  158. while (raw[cursor]?.trim().length === 0) cursor += 1
  159. if (cursor === raw.length) return { blocks: 0 }
  160. let blocks = 0
  161. while (true) {
  162. while (raw[cursor]?.trim().length === 0) cursor += 1
  163. if (cursor === raw.length) break
  164. if (!/^##### \S/.test(raw[cursor] ?? '')) {
  165. return { blocks, error: 'content after a field paragraph must be a titled H5 verbatim block' }
  166. }
  167. const title = (raw[cursor] as string).slice('##### '.length)
  168. const fragment = headingFragment(title)
  169. if (fragment.length === 0) return { blocks, error: 'verbatim H5 title must be non-empty' }
  170. if (fragments.has(fragment)) {
  171. return { blocks, error: `verbatim H5 title ${JSON.stringify(title)} is duplicated within its context surface` }
  172. }
  173. fragments.add(fragment)
  174. cursor += 1
  175. while (raw[cursor]?.trim().length === 0) cursor += 1
  176. if (raw[cursor] !== '```markdown') {
  177. return { blocks, error: 'each nested verbatim H5 requires an exact ```markdown fence' }
  178. }
  179. cursor += 1
  180. const contentStart = cursor
  181. while (cursor < raw.length && raw[cursor] !== '```') cursor += 1
  182. if (cursor === raw.length) return { blocks, error: 'unterminated nested ```markdown fence' }
  183. if (cursor === contentStart) return { blocks, error: 'nested ```markdown fence must not be empty' }
  184. cursor += 1
  185. blocks += 1
  186. }
  187. return { blocks }
  188. }
  189. /** GitHub-style fragment for the simple ASCII nested titles allowed by this contract. */
  190. function headingFragment(title: string): string {
  191. return title.toLowerCase().replaceAll('`', '').replaceAll(/[^a-z0-9 _-]/g, '').trim().replaceAll(/\s+/g, '-')
  192. }
  193. /** A direct stable system-prompt contribution, as named by the README contract. */
  194. function isDirectSystemPromptSurface(title: string): boolean {
  195. return /\bsystem prompt\b/i.test(title)
  196. }
  197. /** Anchored generated-catalog links in one model-view field. */
  198. function toolCatalogLinkFragments(text: string): string[] {
  199. return [...text.matchAll(/\]\(\.\.\/\.\.\/\.\.\/docs\/tool-catalog\.md#([a-z0-9_-]+)\)/g)]
  200. .map(match => match[1] as string)
  201. }
  202. const toolCatalogFragments = new Set<string>()
  203. for (const line of readFileSync(resolve(root, 'docs/tool-catalog.md'), 'utf8').split('\n')) {
  204. const title = /^## (.+)$/.exec(line)?.[1]
  205. if (title !== undefined) toolCatalogFragments.add(headingFragment(title))
  206. }
  207. const failures: Failure[] = []
  208. const packageJsons = globSync('packages/*/*/package.json', { cwd: root }).map(path => path.split(sep).join('/')).sort()
  209. const scannedPackages = new Set(packageJsons.map(path => path.slice(0, -'/package.json'.length)))
  210. let structuredCount = 0
  211. let contextSurfaceCount = 0
  212. let omittedSectionCount = 0
  213. let explainedNoneCount = 0
  214. let indirectCount = 0
  215. let verbatimBlockCount = 0
  216. let systemPromptSurfaceCount = 0
  217. let toolSchemaSurfaceCount = 0
  218. let kvCacheEffectCount = 0
  219. for (const [pkg, reason] of Object.entries(NO_MODEL_EXPERIENCE_SECTION)) {
  220. if (!scannedPackages.has(pkg)) {
  221. failures.push({ path: `${pkg}/README.md`, message: 'no-section allowlist entry does not name a scanned package' })
  222. }
  223. if (reason.trim().length === 0) {
  224. failures.push({ path: `${pkg}/README.md`, message: 'no-section allowlist entry must retain its audit justification' })
  225. }
  226. if (SENTENCE_MODEL_EXPERIENCE[pkg] !== undefined) {
  227. failures.push({ path: `${pkg}/README.md`, message: 'package cannot appear in both Model Experience allowlists' })
  228. }
  229. }
  230. for (const [pkg, contract] of Object.entries(SENTENCE_MODEL_EXPERIENCE)) {
  231. if (!scannedPackages.has(pkg)) {
  232. failures.push({ path: `${pkg}/README.md`, message: 'sentence allowlist entry does not name a scanned package' })
  233. }
  234. if (contract.reason.trim().length === 0) {
  235. failures.push({ path: `${pkg}/README.md`, message: 'sentence allowlist entry must justify why structured context surfaces are unnecessary' })
  236. }
  237. }
  238. for (const packageJson of packageJsons) {
  239. const pkg = packageJson.slice(0, -'/package.json'.length)
  240. const readme = packageJson.replace(/package\.json$/, 'README.md')
  241. const abs = resolve(root, readme)
  242. if (!existsSync(abs)) {
  243. failures.push({ path: readme, message: 'missing package README' })
  244. continue
  245. }
  246. const text = readFileSync(abs, 'utf8')
  247. const rawLines = text.split('\n')
  248. const lines = markdownProseLines(text)
  249. const headings = markdownHeadingLines(text)
  250. const h2Headings = headings.filter(heading => heading.depth === 2)
  251. const modelExperienceHeadings = headings.filter(heading => heading.text
  252. .trim().replaceAll(/\s+/g, ' ').toLowerCase() === 'model experience')
  253. const modelHeadings = modelExperienceHeadings.filter(heading => heading.depth === 2 && heading.raw === HEADING)
  254. if (NO_MODEL_EXPERIENCE_SECTION[pkg] !== undefined) {
  255. if (modelExperienceHeadings.length !== 0) {
  256. for (const heading of modelExperienceHeadings) {
  257. failures.push({ path: readme, message: `line ${heading.index}: audited model-agnostic package must omit every Model Experience heading; found ${JSON.stringify(heading.raw)}` })
  258. }
  259. } else {
  260. omittedSectionCount += 1
  261. }
  262. continue
  263. }
  264. const nonCanonicalModelHeading = modelExperienceHeadings.find(heading => heading.depth !== 2 || heading.raw !== HEADING)
  265. if (nonCanonicalModelHeading !== undefined) {
  266. failures.push({ path: readme, message: `line ${nonCanonicalModelHeading.index}: non-canonical Model Experience heading ${JSON.stringify(nonCanonicalModelHeading.raw)}; use exactly ${JSON.stringify(HEADING)}` })
  267. continue
  268. }
  269. const modelHeading = modelHeadings.at(0)
  270. if (modelHeading === undefined) {
  271. failures.push({
  272. path: readme,
  273. message: `missing ${HEADING}`,
  274. })
  275. continue
  276. }
  277. if (modelHeadings.length !== 1) {
  278. failures.push({ path: readme, message: `contains ${modelHeadings.length} copies of ${HEADING}` })
  279. continue
  280. }
  281. const modelH2Index = h2Headings.indexOf(modelHeading)
  282. const limitationsH2Index = h2Headings.findIndex(heading => heading.depth === 2 && heading.raw === LIMITATIONS_HEADING)
  283. if (limitationsH2Index >= 0) {
  284. if (modelH2Index !== h2Headings.length - 2 || limitationsH2Index !== h2Headings.length - 1) {
  285. failures.push({
  286. path: readme,
  287. message: `${HEADING} and ${LIMITATIONS_HEADING} must be the final two H2 sections, in that order`,
  288. })
  289. continue
  290. }
  291. } else if (modelH2Index !== h2Headings.length - 1) {
  292. failures.push({ path: readme, message: `${HEADING} must be the final H2 when ${LIMITATIONS_HEADING} is absent` })
  293. continue
  294. }
  295. const modelHeadingAt = lines.findIndex(line => line.index === modelHeading.index)
  296. const body = lines.slice(modelHeadingAt + 1)
  297. const h2Lines = new Set(h2Headings.map(heading => heading.index))
  298. const nextH2 = body.findIndex(line => h2Lines.has(line.index))
  299. const section = nextH2 < 0 ? body : body.slice(0, nextH2)
  300. const nextH2Line = nextH2 < 0 ? rawLines.length + 1 : (body[nextH2] as Line).index
  301. const rawSection = rawLines.slice(modelHeading.index, nextH2Line - 1)
  302. const content = section.filter(line => line.raw.trim().length > 0)
  303. const sentenceContract = SENTENCE_MODEL_EXPERIENCE[pkg]
  304. if (sentenceContract !== undefined) {
  305. const pattern = sentenceContract.kind === 'none' ? /^None, as .+\.$/ : /^Indirectly, through .+\.$/
  306. const rawContent = rawSection.filter(line => line.trim().length > 0)
  307. const sentence = content[0]
  308. const kvCacheHeading = content[1]
  309. const kvCacheEffect = content[2]
  310. if (content.length !== 3 || rawContent.length !== 3 || !pattern.test(sentence?.raw ?? '')) {
  311. const prefix = sentenceContract.kind === 'none' ? 'None, as ' : 'Indirectly, through '
  312. failures.push({ path: readme, message: `must contain exactly one sentence beginning ${JSON.stringify(prefix)} and ending with a period, followed by ${KV_CACHE_EFFECT_HEADING} and one non-empty paragraph` })
  313. continue
  314. }
  315. if (kvCacheHeading?.raw !== KV_CACHE_EFFECT_HEADING
  316. || kvCacheEffect === undefined
  317. || /^#{1,6} /.test(kvCacheEffect.raw)
  318. || kvCacheEffect.raw.trim().length === 0) {
  319. failures.push({ path: readme, message: `line ${kvCacheHeading?.index ?? sentence?.index ?? modelHeading.index}: short Model Experience form requires exact ${KV_CACHE_EFFECT_HEADING} and one non-empty paragraph` })
  320. continue
  321. }
  322. if (sentence === undefined
  323. || sentence.index !== modelHeading.index + 2
  324. || kvCacheHeading.index !== sentence.index + 2
  325. || kvCacheEffect.index !== kvCacheHeading.index + 2) {
  326. failures.push({ path: readme, message: 'short Model Experience sentence, KV-cache H4, and paragraph require one blank line between each element' })
  327. continue
  328. }
  329. if (sentenceContract.kind === 'none') explainedNoneCount += 1
  330. else indirectCount += 1
  331. kvCacheEffectCount += 1
  332. continue
  333. }
  334. const shortSentence = content.find(line => line.raw === 'None.' || /^None, as |^Indirectly, through /.test(line.raw))
  335. if (shortSentence !== undefined) {
  336. failures.push({ path: readme, message: `line ${shortSentence.index}: short Model Experience form requires an audited entry in SENTENCE_MODEL_EXPERIENCE` })
  337. continue
  338. }
  339. const surfaceStarts = content
  340. .map((line, index) => ({ line, index }))
  341. .filter(entry => /^### \S/.test(entry.line.raw))
  342. if (surfaceStarts.length === 0 || surfaceStarts[0]?.index !== 0) {
  343. failures.push({ path: readme, message: 'must contain one or more complete context-surface blocks' })
  344. continue
  345. }
  346. const surfaces: ContextSurface[] = []
  347. const surfaceFragments = new Set<string>()
  348. let surfaceError = false
  349. for (let surfaceIndex = 0; surfaceIndex < surfaceStarts.length; surfaceIndex += 1) {
  350. const start = surfaceStarts[surfaceIndex] as { line: Line; index: number }
  351. const end = surfaceStarts[surfaceIndex + 1]?.index ?? content.length
  352. const entries = content.slice(start.index, end)
  353. const heading = entries[0] as Line
  354. const title = heading.raw.slice('### '.length)
  355. const fragment = headingFragment(title)
  356. if (fragment.length === 0) {
  357. failures.push({ path: readme, message: `line ${heading.index}: each context surface requires a non-empty H3 heading` })
  358. surfaceError = true
  359. break
  360. }
  361. if (surfaceFragments.has(fragment)) {
  362. failures.push({ path: readme, message: `line ${heading.index}: duplicate context-surface link fragment ${JSON.stringify(fragment)}` })
  363. surfaceError = true
  364. break
  365. }
  366. const fieldStarts = entries
  367. .map((line, index) => ({ line, index }))
  368. .filter(entry => /^#### \S/.test(entry.line.raw))
  369. if (fieldStarts.length !== FIELD_HEADINGS.length || fieldStarts[0]?.index !== 1) {
  370. failures.push({ path: readme, message: `line ${heading.index}: context surface requires exactly three ordered H4 fields: ${FIELD_HEADINGS.join(', ')}` })
  371. surfaceError = true
  372. break
  373. }
  374. if ((surfaceIndex === 0 && heading.index !== modelHeading.index + 2)
  375. || rawLines[heading.index - 2]?.trim().length !== 0
  376. || fieldStarts[0].line.index !== heading.index + 2) {
  377. failures.push({ path: readme, message: `line ${heading.index}: context-surface heading and first field require one blank line between them` })
  378. surfaceError = true
  379. break
  380. }
  381. const parsedFields: ParsedField[] = []
  382. const verbatimFragments = new Set<string>()
  383. for (let fieldIndex = 0; fieldIndex < FIELD_HEADINGS.length; fieldIndex += 1) {
  384. const fieldStart = fieldStarts[fieldIndex] as { line: Line; index: number }
  385. const expectedHeading = FIELD_HEADINGS[fieldIndex] as string
  386. if (fieldStart.line.raw !== expectedHeading) {
  387. failures.push({ path: readme, message: `line ${fieldStart.line.index}: expected exact field heading ${JSON.stringify(expectedHeading)}, found ${JSON.stringify(fieldStart.line.raw)}` })
  388. surfaceError = true
  389. break
  390. }
  391. const fieldEnd = fieldStarts[fieldIndex + 1]?.index ?? entries.length
  392. const fieldEntries = entries.slice(fieldStart.index, fieldEnd)
  393. const value = fieldEntries[1]
  394. if (value === undefined || /^#{1,6} /.test(value.raw) || value.raw.trim().length === 0) {
  395. failures.push({ path: readme, message: `line ${fieldStart.line.index}: ${expectedHeading} requires one non-empty paragraph` })
  396. surfaceError = true
  397. break
  398. }
  399. if (value.index !== fieldStart.line.index + 2) {
  400. failures.push({ path: readme, message: `line ${fieldStart.line.index}: ${expectedHeading} and its paragraph require one blank line between them` })
  401. surfaceError = true
  402. break
  403. }
  404. const unexpected = fieldEntries.slice(2).find(line => !/^##### \S/.test(line.raw))
  405. if (unexpected !== undefined) {
  406. failures.push({ path: readme, message: `line ${unexpected.index}: content after ${expectedHeading} paragraph must be a titled H5 plus \`markdown\` fence owned by that field` })
  407. surfaceError = true
  408. break
  409. }
  410. const nextHeadingLine = fieldStarts[fieldIndex + 1]?.line.index
  411. ?? surfaceStarts[surfaceIndex + 1]?.line.index
  412. ?? nextH2Line
  413. if (rawLines[nextHeadingLine - 2]?.trim().length !== 0) {
  414. failures.push({ path: readme, message: `line ${nextHeadingLine}: Model Experience headings require a preceding blank line` })
  415. surfaceError = true
  416. break
  417. }
  418. const verbatim = validateNestedVerbatim(rawLines.slice(value.index, nextHeadingLine - 1), verbatimFragments)
  419. if (verbatim.error !== undefined) {
  420. failures.push({ path: readme, message: `line ${value.index}: ${verbatim.error}` })
  421. surfaceError = true
  422. break
  423. }
  424. if (fieldEntries.length - 2 !== verbatim.blocks) {
  425. failures.push({ path: readme, message: `line ${value.index}: every nested H5 must own exactly one \`markdown\` fence` })
  426. surfaceError = true
  427. break
  428. }
  429. parsedFields.push({ value, verbatimBlocks: verbatim.blocks })
  430. }
  431. if (surfaceError) break
  432. const modelViewField = parsedFields[0] as ParsedField
  433. const tokenEffectField = parsedFields[1] as ParsedField
  434. const kvCacheEffectField = parsedFields[2] as ParsedField
  435. const modelView = modelViewField.value
  436. const tokenEffect = tokenEffectField.value
  437. const kvCacheEffect = kvCacheEffectField.value
  438. if (/\]\(#[^)]+\)/.test(modelView.raw) || /\]\(#[^)]+\)/.test(tokenEffect.raw) || /\]\(#[^)]+\)/.test(kvCacheEffect.raw)) {
  439. failures.push({ path: readme, message: `line ${heading.index}: Model Experience fields must not link between local subsections; nest the H5 in its owning H4 field` })
  440. surfaceError = true
  441. break
  442. }
  443. surfaceFragments.add(fragment)
  444. surfaces.push({
  445. heading,
  446. modelView,
  447. tokenEffect,
  448. kvCacheEffect,
  449. title,
  450. modelViewVerbatimBlocks: modelViewField.verbatimBlocks,
  451. verbatimBlocks: parsedFields.reduce((total, field) => total + field.verbatimBlocks, 0),
  452. })
  453. }
  454. if (surfaceError) continue
  455. const promptWithoutVerbatim = surfaces.find(surface => isDirectSystemPromptSurface(surface.title)
  456. && surface.modelViewVerbatimBlocks === 0)
  457. if (promptWithoutVerbatim !== undefined) {
  458. failures.push({ path: readme, message: `line ${promptWithoutVerbatim.heading.index}: system-prompt surface must contain a titled H5 plus verbatim \`markdown\` block under ${MODEL_VIEW_HEADING}` })
  459. continue
  460. }
  461. const hasConcreteLiteral = surfaces.some(surface => surface.verbatimBlocks > 0
  462. || surface.modelView.raw.includes('`')
  463. || surface.tokenEffect.raw.includes('`')
  464. || toolCatalogLinkFragments(surface.modelView.raw).length > 0)
  465. if (!hasConcreteLiteral) {
  466. failures.push({ path: readme, message: 'structured Model Experience must ground at least one surface with inline code, a nested `markdown` block, or an anchored tool-catalog link' })
  467. continue
  468. }
  469. let catalogError = false
  470. for (const surface of surfaces) {
  471. if (!/\bschemas?\b/i.test(surface.title)) continue
  472. const fragments = toolCatalogLinkFragments(surface.modelView.raw)
  473. if (fragments.length === 0) {
  474. failures.push({ path: readme, message: `line ${surface.heading.index}: tool-schema surface must link an anchored section of ../../../docs/tool-catalog.md` })
  475. catalogError = true
  476. break
  477. }
  478. const invalid = fragments.find(fragment => !toolCatalogFragments.has(fragment))
  479. if (invalid !== undefined) {
  480. failures.push({ path: readme, message: `line ${surface.modelView.index}: tool-catalog link fragment ${JSON.stringify(invalid)} does not name an H2 section` })
  481. catalogError = true
  482. break
  483. }
  484. }
  485. if (catalogError) continue
  486. verbatimBlockCount += surfaces.reduce((total, surface) => total + surface.verbatimBlocks, 0)
  487. contextSurfaceCount += surfaces.length
  488. systemPromptSurfaceCount += surfaces.filter(surface => isDirectSystemPromptSurface(surface.title)).length
  489. toolSchemaSurfaceCount += surfaces.filter(surface => /\bschemas?\b/i.test(surface.title)).length
  490. kvCacheEffectCount += surfaces.length
  491. structuredCount += 1
  492. }
  493. if (failures.length === 0) {
  494. console.log(`verify-package-readme-model-experience: ${packageJsons.length} README(s) checked (${omittedSectionCount} audited omissions, ${structuredCount} structured, ${contextSurfaceCount} context surfaces, ${kvCacheEffectCount} KV-cache fields, ${systemPromptSurfaceCount} fenced system-prompt surfaces, ${toolSchemaSurfaceCount} catalog-linked tool-schema surfaces, ${explainedNoneCount} explained none, ${indirectCount} indirect, ${verbatimBlockCount} verbatim markdown blocks), all conform.`)
  495. process.exit(0)
  496. }
  497. console.error('verify-package-readme-model-experience failed:')
  498. for (const failure of failures) {
  499. console.error(` ${relative(root, resolve(root, failure.path))}: ${failure.message}`)
  500. }
  501. process.exit(1)