Interface TreeFileNode

A markdown file leaf in the rendered tree.

Field order is the serialisation order used by the JSON output and is kept stable.

interface TreeFileNode {
    brokenInternalLinkCount: number;
    linkCount: number;
    name: string;
    orphaned: boolean;
    path: string;
    wordCount: number;
}

Properties

brokenInternalLinkCount: number

Internal links whose target file does not exist

linkCount: number

Total number of parsed links of every type

name: string

File name including extension

orphaned: boolean

Whether no other scanned file links to this file

path: string

Path relative to the scan root, with forward slashes

wordCount: number

Word count outside code spans and fences