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

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