/** * GLOSSARY.md parser. Two entry shapes are read: * * ### Order (sw-glossary) * A customer's request to buy ... * - Avoid: purchase, basket * - Data: `orders` table * - Code: `Order` in `src/orders/order.ts` * - UI: "Order" * * **Order**: (mattpocock/skills domain-modeling) * A customer's request to buy ... * _Avoid_: purchase, basket * * A root `GLOSSARY-MAP.md` links one GLOSSARY.md per context; each is read. * * @module core/glossary/parse */ export type GlossaryLevel = 'Data' | 'Code' | 'UI' | 'Rules'; export interface GlossaryTerm { term: string; /** Glossary file, relative to the project root (posix). */ file: string; line: number; definition: string; avoid: string[]; levels: Partial>; } /** Parse one glossary file's text. */ export declare function parseGlossary(text: string, file: string): GlossaryTerm[]; /** True when `rel` resolves, through any symlinks, to a file inside `root`. */ export declare function insideProject(root: string, rel: string): boolean; /** * Glossary files of a project: the root GLOSSARY.md plus those GLOSSARY-MAP.md * links to. Only files that really live inside the project are read; a link or * symlink that leads outside it is ignored. */ export declare function findGlossaryFiles(root: string): string[]; export declare function readGlossary(root: string): GlossaryTerm[]; //# sourceMappingURL=parse.d.ts.map