Context
The current api-surface-lock.sh extracts public export names from .d.ts files using regex. This is pragmatic and catches accidental API removals/renames, but it only tracks export names, not full signatures.
Proposed improvement
For critical packages (@peac/kernel, @peac/schema, @peac/crypto, @peac/protocol), use one of:
- API Extractor (@microsoft/api-extractor): generates
.api.md rollup files with full type signatures
- ts-morph-based JSON signature model: extract function signatures, type parameters, and return types into a structured JSON format
This would catch signature changes (parameter additions, type narrowing) that name-only tracking misses.
Scope
Quality improvement for post-stable. The regex-based scanner is functional for the current release.
Related
Context
The current
api-surface-lock.shextracts public export names from.d.tsfiles using regex. This is pragmatic and catches accidental API removals/renames, but it only tracks export names, not full signatures.Proposed improvement
For critical packages (@peac/kernel, @peac/schema, @peac/crypto, @peac/protocol), use one of:
.api.mdrollup files with full type signaturesThis would catch signature changes (parameter additions, type narrowing) that name-only tracking misses.
Scope
Quality improvement for post-stable. The regex-based scanner is functional for the current release.
Related