Derive package, tool-family, provider, setup-client, schema-version, and CLI facts from the runtime contract sources into a deterministic checked-in catalog. Add non-mutating generated-file checks, exact TypeDoc regenerate-and-compare validation, caller-visible documentation fact checks, and CI enforcement through docs:check. Cover command-router parity, source-derived catalog values, deliberate documentation drift, and stale generated artifacts while preserving runtime behavior.
11 lines
280 B
TypeScript
11 lines
280 B
TypeScript
import type { ProductCatalog } from "./product-catalog.mjs";
|
|
|
|
export function documentationFactIssues(
|
|
root: string,
|
|
catalog: ProductCatalog,
|
|
): Promise<readonly string[]>;
|
|
export function assertDocumentationFacts(
|
|
root: string,
|
|
catalog: ProductCatalog,
|
|
): Promise<void>;
|