Function buildToc

src/toc.ts:339–389

(doc: TextDocument)

}

export function buildToc(doc: TextDocument) {
    const replacer = (foundStr: string) => foundStr.replace(/[^\r\n]/g, '');
    let lines = doc.getText()
        .replace(REGEX_FENCED_CODE_BLOCK, replacer)                 //// Remove fenced code blocks (and #603, #675)
        .replace(/<!-- omit in (toc|TOC) -->/g, '&lt; omit in toc &gt;')    //// Escape magic comment
        .replace(/<!--[\W\w]+?-->/g, replacer)                      //// Remove comments
        .replace(/^---[\W\w]+?(\r?\n)---/, replacer)                //// Remove YAML front matter
        .split(/\r?\n/g);

    //// Some special cases that we need to look at multiple lines to decide
    lines.forEach((lineText, i, arr) => {
        //// Transform setext headings to ATX headings
        if (
            i < arr.length - 1
            && lineText.match(/^ {0,3}\S.*$/)
            && lineText.replace(/[ -]/g, '').length > 0  //// #629
            && arr[i + 1].match(/^ {0,3}(=+|-{2,}) *$/)
        ) {
            arr[i] = (arr[i + 1].includes('=') ? '# ' : '## ') + lineText;
        }
        //// Ignore headings following `<!-- omit in toc -->`
        if (
            i > 0
            && arr[i - 1] === '&lt; omit in toc &gt;'
        ) {
            arr[i] = '';
        }
    });

    const toc = lines.map((lineText, index) => {
        if (
            lineText.trim().startsWith('#')
            && !lineText.startsWith('    ')  //// The opening `#` character may be indented 0-3 spaces
            && lineText.includes('# ')
            && !lineText.includes('&lt; omit in toc &gt;')
        ) {
            lineText = lineText.replace(/^ +/, '');
            const matches = /^(#+) (.*)/.exec(lineText);
            const entry = {
                level: matches[1].length,
                text: matches[2].replace(/#+$/, '').trim(),
                lineNum: index,
            };
            return entry;
        } else {
            return null;
        }
    }).filter(entry => entry !== null);

    return toc;
}

class TocCodeLensProvider implements CodeLensProvider {
    public provideCodeLenses(document: TextDocument, _: CancellationToken):