bot/scripts/spec-scan.ts
openaliro/openaliro
Module

spec-scan.ts

bot/scripts/spec-scan.ts2 documented symbols

used by build-spec-index.ts spec-index.generated.ts

flowchart TD
  scanDocs --> scanText

API

Fexport function scanText(file: string, text: string): SpecCitation[]

bot/scripts/spec-scan.ts:52

read returns a docs/*.md file's contents, or null. Exposed for tests, so they can drive this against fixtures without touching the filesystem.

called by scanDocs  ·  calls tokensOn

Fexport function scanDocs(docsDir: string, repoRelativePrefix: string): SpecCitation[]

bot/scripts/spec-scan.ts:93

Every docs/*.md file, scanned. docsDir is docs/ itself so tests can point it at a fixture directory instead.

calls scanText
Undocumented (1)

tokensOn