Interface ScannedMarkdownFile

Per-file measurements gathered while scanning a markdown tree.

A scanned file carries everything the tree renderer and the statistics builder need, so both stay pure functions over this shape.

interface ScannedMarkdownFile {
    path: string;
    relativePath: string;
    wordCount: number;
    linkCount: number;
    internalLinkCount: number;
    externalLinkCount: number;
    brokenInternalLinkCount: number;
    inboundLinkCount: number;
}

Properties

path: string

Absolute file path

relativePath: string

Path relative to the scan root, with forward slashes regardless of platform

wordCount: number

Word count outside code spans and fences (see countWords)

linkCount: number

Total number of parsed links of every type

internalLinkCount: number

Number of parsed links whose type is internal

externalLinkCount: number

Number of parsed links whose type is external

brokenInternalLinkCount: number

Number of internal links whose target file does not exist

inboundLinkCount: number

Number of links from other scanned files that resolve to this file