|
|
@@ -1,6 +1,8 @@
|
|
|
/**
|
|
|
* Doc-sync gate: require every workspace package README to explain its exact
|
|
|
- * model-visible context surface and token behavior in the canonical table.
|
|
|
+ * model-visible context surface and token behavior. Most packages require the
|
|
|
+ * canonical table; an audited allowlist requires one concise zero-effect or
|
|
|
+ * indirect-only sentence instead.
|
|
|
*
|
|
|
* Run: `tsx scripts/verify-package-readme-model-experience.ts`.
|
|
|
*/
|
|
|
@@ -15,6 +17,37 @@ const TABLE_HEADER = '| Context surface | What the model sees | Token effect |'
|
|
|
const TABLE_DIVIDER = '|---|---|---|'
|
|
|
const H2_HEADING = /^## .+$/
|
|
|
|
|
|
+type SentenceKind = 'none' | 'indirect'
|
|
|
+
|
|
|
+interface SentenceContract {
|
|
|
+ kind: SentenceKind
|
|
|
+ reason: string
|
|
|
+}
|
|
|
+
|
|
|
+/**
|
|
|
+ * Packages whose Model Experience is simple enough for one gated sentence.
|
|
|
+ * Every other package must carry the canonical table. A package moves on or
|
|
|
+ * off this list in the same change that changes its context behavior.
|
|
|
+ */
|
|
|
+const SENTENCE_MODEL_EXPERIENCE: Readonly<Record<string, SentenceContract>> = {
|
|
|
+ 'packages/bash/bash': { kind: 'indirect', reason: 'The service interface delegates all model rendering to dsh-tool-bash.' },
|
|
|
+ 'packages/code-runtime/code-runtime': { kind: 'indirect', reason: 'The service interface delegates model rendering to Code Mode in dsh-tools.' },
|
|
|
+ 'packages/fs/fs': { kind: 'indirect', reason: 'The service interface delegates model rendering to dsh-tool-fs.' },
|
|
|
+ 'packages/hooks/hook-protocol': { kind: 'indirect', reason: 'Only the hook bridge plugins render decoded hook output to a model.' },
|
|
|
+ 'packages/sandbox/sandbox': { kind: 'indirect', reason: 'Only sandbox-consuming capabilities render enforcement facts.' },
|
|
|
+ 'packages/skill/skill': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-skill.' },
|
|
|
+ 'packages/subagent/subagent': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-subagent.' },
|
|
|
+ 'packages/subagent/subagent-subprocess': { kind: 'indirect', reason: 'Only process-based subagent backends compose a child model request.' },
|
|
|
+ 'packages/support/acp-snapshot': { kind: 'none', reason: 'The test harness observes and normalizes transcripts without changing live requests.' },
|
|
|
+ 'packages/support/invariants': { kind: 'none', reason: 'The observer validates requests but never rewrites their context.' },
|
|
|
+ 'packages/ui/app-boot': { kind: 'indirect', reason: 'Only the loaded plugin tree contributes model context.' },
|
|
|
+ 'packages/ui/user-interaction': { kind: 'indirect', reason: 'Only a model-facing consumer renders human answers.' },
|
|
|
+ 'packages/util/brand': { kind: 'none', reason: 'The type-only primitive is erased at compile time.' },
|
|
|
+ 'packages/util/timeout': { kind: 'indirect', reason: 'Only timeout consumers render timeout outcomes.' },
|
|
|
+ 'packages/web/web': { kind: 'indirect', reason: 'The provider registry delegates model rendering to dsh-tool-web.' },
|
|
|
+ 'packages/workflow/workflow': { kind: 'indirect', reason: 'The service delegates parent and child model rendering to its consumer and engine.' },
|
|
|
+}
|
|
|
+
|
|
|
interface Failure {
|
|
|
path: string
|
|
|
message: string
|
|
|
@@ -47,8 +80,22 @@ function proseLines(text: string): Line[] {
|
|
|
|
|
|
const failures: Failure[] = []
|
|
|
const packageJsons = globSync('packages/*/*/package.json', { cwd: root }).sort()
|
|
|
+const scannedPackages = new Set(packageJsons.map(path => path.slice(0, -'/package.json'.length)))
|
|
|
+let tableCount = 0
|
|
|
+let noneCount = 0
|
|
|
+let indirectCount = 0
|
|
|
+
|
|
|
+for (const [pkg, contract] of Object.entries(SENTENCE_MODEL_EXPERIENCE)) {
|
|
|
+ if (!scannedPackages.has(pkg)) {
|
|
|
+ failures.push({ path: `${pkg}/README.md`, message: 'sentence allowlist entry does not name a scanned package' })
|
|
|
+ }
|
|
|
+ if (contract.reason.trim().length === 0) {
|
|
|
+ failures.push({ path: `${pkg}/README.md`, message: 'sentence allowlist entry must justify why a table is unnecessary' })
|
|
|
+ }
|
|
|
+}
|
|
|
|
|
|
for (const packageJson of packageJsons) {
|
|
|
+ const pkg = packageJson.slice(0, -'/package.json'.length)
|
|
|
const readme = packageJson.replace(/package\.json$/, 'README.md')
|
|
|
const abs = resolve(root, readme)
|
|
|
if (!existsSync(abs)) {
|
|
|
@@ -86,10 +133,30 @@ for (const packageJson of packageJsons) {
|
|
|
const body = lines.slice(lines.indexOf(modelHeading) + 1)
|
|
|
const nextH2 = body.findIndex(line => H2_HEADING.test(line.raw))
|
|
|
const section = nextH2 < 0 ? body : body.slice(0, nextH2)
|
|
|
+ const content = section.filter(line => line.raw.trim().length > 0)
|
|
|
+ const sentenceContract = SENTENCE_MODEL_EXPERIENCE[pkg]
|
|
|
+ if (sentenceContract !== undefined) {
|
|
|
+ const pattern = sentenceContract.kind === 'none' ? /^None, as .+\.$/ : /^Indirectly, through .+\.$/
|
|
|
+ if (content.length !== 1 || !pattern.test(content[0]?.raw ?? '')) {
|
|
|
+ const prefix = sentenceContract.kind === 'none' ? 'None, as ' : 'Indirectly, through '
|
|
|
+ failures.push({ path: readme, message: `must contain exactly one sentence beginning ${JSON.stringify(prefix)} and ending with a period` })
|
|
|
+ continue
|
|
|
+ }
|
|
|
+ if (sentenceContract.kind === 'none') noneCount += 1
|
|
|
+ else indirectCount += 1
|
|
|
+ continue
|
|
|
+ }
|
|
|
+
|
|
|
+ const shortSentence = content.find(line => /^None, as |^Indirectly, through /.test(line.raw))
|
|
|
+ if (shortSentence !== undefined) {
|
|
|
+ failures.push({ path: readme, message: `line ${shortSentence.index}: short Model Experience form requires an audited entry in SENTENCE_MODEL_EXPERIENCE` })
|
|
|
+ continue
|
|
|
+ }
|
|
|
+
|
|
|
const headers = section.filter(line => line.raw === TABLE_HEADER)
|
|
|
const header = headers[0]
|
|
|
const headerIndex = header === undefined ? -1 : section.indexOf(header)
|
|
|
- if (headers.length !== 1 || headerIndex < 0 || section[headerIndex + 1]?.raw !== TABLE_DIVIDER) {
|
|
|
+ if (header === undefined || headers.length !== 1 || headerIndex < 0 || section[headerIndex + 1]?.raw !== TABLE_DIVIDER) {
|
|
|
failures.push({ path: readme, message: `must contain the exact table header ${TABLE_HEADER}` })
|
|
|
continue
|
|
|
}
|
|
|
@@ -109,10 +176,17 @@ for (const packageJson of packageJsons) {
|
|
|
failures.push({ path: readme, message: `line ${row.index}: invalid three-column Model Experience row: ${row.raw}` })
|
|
|
}
|
|
|
}
|
|
|
+ const tableLines = new Set([header, section[headerIndex + 1], ...rows])
|
|
|
+ const extra = content.find(line => !tableLines.has(line))
|
|
|
+ if (extra !== undefined) {
|
|
|
+ failures.push({ path: readme, message: `line ${extra.index}: Model Experience table section contains non-table content: ${extra.raw}` })
|
|
|
+ continue
|
|
|
+ }
|
|
|
+ tableCount += 1
|
|
|
}
|
|
|
|
|
|
if (failures.length === 0) {
|
|
|
- console.log(`verify-package-readme-model-experience: ${packageJsons.length} README(s) carry the canonical ${HEADING} table.`)
|
|
|
+ console.log(`verify-package-readme-model-experience: ${packageJsons.length} README(s) checked (${tableCount} tables, ${noneCount} none, ${indirectCount} indirect), all conform.`)
|
|
|
process.exit(0)
|
|
|
}
|
|
|
|
Tianyi Cui