All files / roosterjs-content-model-markdown/lib/markdownToModel/processor markdownProcessor.ts

89.41% Statements 76/85
91.04% Branches 61/67
100% Functions 4/4
92.41% Lines 73/79

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 2421x 1x 1x 1x 1x                                   1x                     1x                                     1x       34x 34x 34x   34x   34x 34x 34x   34x       12x   8x     34x                     162x         6x           6x 6x             6x     162x 69x         15x 15x 15x   15x     54x     18x   18x       10x 10x       4x     4x       4x   4x       18x     93x     115x 2x 2x             115x   64x 64x 64x           30x         30x 28x   30x   30x   30x   21x 21x 21x     115x 85x 85x                 34x         162x 162x 162x 935x 935x 935x 159x               159x 159x         162x 3x                   34x    
import { createBlockGroupFromMarkdown } from '../creators/createBlockGroupFromMarkdown';
import { createContentModelDocument, createDivider } from 'roosterjs-content-model-dom';
import { createParagraphFromMarkdown } from '../creators/createParagraphFromMarkdown';
import { createTableFromMarkdown } from '../creators/createTableFromMarkdown';
import { isMarkdownTable } from '../utils/isMarkdownTable';
 
import type { MarkdownToModelOptions } from '../types/MarkdownToModelOptions';
import type {
    ContentModelBlockType,
    ContentModelDocument,
    ContentModelFormatContainer,
    ContentModelListItem,
    ShallowMutableContentModelDocument,
} from 'roosterjs-content-model-types';
 
interface MarkdownContext {
    lastQuote?: ContentModelFormatContainer;
    lastList?: ContentModelListItem;
    emptyLineState?: 'notEmpty' | 'lineEnded' | 'empty';
    tableLines: string[];
}
 
const MarkdownPattern: Record<string, RegExp> = {
    heading: /^#{1,6} .*/,
    horizontal_line: /^---$/,
    table: /^\|.*\|\s*$/,
    blockquote: /^>\s.*$/,
    unordered_list: /^\s*[\*\-\+] .*/,
    ordered_list: /^\s*\d+\. .*/,
    space: /^\s*$/,
    paragraph: /^[^#\-\*\d\|].*/,
};
 
const MarkdownBlockType: Record<string, ContentModelBlockType> = {
    heading: 'Paragraph',
    horizontal_line: 'Divider',
    paragraph: 'Paragraph',
    unordered_list: 'BlockGroup',
    ordered_list: 'BlockGroup',
    table: 'Table',
    blockquote: 'BlockGroup',
    space: 'Paragraph',
};
 
/**
 * @internal
 * Process markdown text and convert it to ContentModelDocument
 * @param text The markdown text
 * @param splitLinesPattern The pattern to split lines. Default is /\r\n|\r|\\n|\n/
 * @returns The ContentModelDocument
 */
 
export function markdownProcessor(
    text: string,
    options: MarkdownToModelOptions
): ContentModelDocument {
    const splitLinesPattern = options.splitLinesPattern || /\r\n|\r|\\n|\n/;
    const emptyLine = options.emptyLine ?? 'merge';
    const markdownText = text.split(splitLinesPattern);
 
    markdownText.push(''); // Add an empty line to make sure the last block is processed
 
    const doc = createContentModelDocument();
    const model = convertMarkdownText(doc, markdownText, options);
    const lastBlock = model.blocks[model.blocks.length - 1];
 
    if (
        emptyLine != 'remove' &&
        lastBlock &&
        lastBlock.blockType == 'Paragraph' &&
        lastBlock.segments.every(x => x.segmentType == 'Br')
    ) {
        model.blocks.pop();
    }
 
    return model;
}
 
function addMarkdownBlockToModel(
    model: ShallowMutableContentModelDocument,
    blockType: ContentModelBlockType,
    markdown: string,
    patternName: string,
    markdownContext: MarkdownContext,
    options: MarkdownToModelOptions
) {
    if (
        blockType !== 'Table' &&
        markdownContext.tableLines &&
        markdownContext.tableLines.length > 0
    ) {
        Eif (
            markdownContext.tableLines.length > 2 &&
            markdownContext.tableLines[1].trim().length > 0 &&
            isMarkdownTable(markdownContext.tableLines[1]) &&
            markdownContext.tableLines.length > 1
        ) {
            const tableModel = createTableFromMarkdown(markdownContext.tableLines);
            model.blocks.push(tableModel);
        } else {
            for (const line of markdownContext.tableLines) {
                const paragraph = createParagraphFromMarkdown(line);
                model.blocks.push(paragraph);
            }
        }
        markdownContext.tableLines.length = 0;
    }
 
    if (patternName == 'space') {
        if (
            markdownContext.tableLines.length > 0 ||
            markdownContext.lastQuote ||
            markdownContext.lastList
        ) {
            markdownContext.tableLines = [];
            markdownContext.lastQuote = undefined;
            markdownContext.lastList = undefined;
 
            return;
        }
 
        switch (options.emptyLine) {
            case 'remove':
                // no op, ignore this line
                return;
            case 'merge':
                switch (markdownContext.emptyLineState) {
                    case 'notEmpty':
                    default:
                        // Last line is not empty line, so this empty line is treated as the line end of last paragraph
                        markdownContext.emptyLineState = 'lineEnded';
                        return;
 
                    case 'lineEnded':
                        // We already see an empty line for paragraph ends, so this line is treated as a real empty line
                        markdownContext.emptyLineState = 'empty';
 
                        // Keep going, process as a normal paragraph
                        break;
 
                    case 'empty':
                        // Already processed empty line, so this one should be ignored
                        return;
                }
                break;
            case 'preserve':
            default:
                // no op, treat it as paragraph
                break;
        }
    } else {
        markdownContext.emptyLineState = 'notEmpty';
    }
 
    if (blockType == 'Paragraph' && (markdownContext.lastList || markdownContext.lastQuote)) {
        blockType = 'BlockGroup';
        patternName = markdownContext.lastList
            ? markdownContext.lastList.levels[0].listType == 'OL'
                ? 'ordered_list'
                : 'unordered_list'
            : 'blockquote';
    }
 
    switch (blockType) {
        case 'Paragraph':
            const paragraph = createParagraphFromMarkdown(markdown);
            model.blocks.push(paragraph);
            break;
        case 'Divider':
            const divider = createDivider('hr');
            model.blocks.push(divider);
            break;
        case 'BlockGroup':
            const blockGroup = createBlockGroupFromMarkdown(
                markdown,
                patternName,
                markdownContext.lastQuote
            );
            if (!markdownContext.lastQuote) {
                model.blocks.push(blockGroup);
            }
            markdownContext.lastQuote =
                blockGroup.blockGroupType == 'FormatContainer' ? blockGroup : undefined;
            markdownContext.lastList =
                blockGroup.blockGroupType == 'ListItem' ? blockGroup : undefined;
            break;
        case 'Table':
            markdownContext.tableLines = markdownContext.tableLines || [];
            markdownContext.tableLines.push(markdown);
            break;
    }
 
    if (blockType !== 'BlockGroup') {
        markdownContext.lastQuote = undefined;
        markdownContext.lastList = undefined;
    }
}
 
function convertMarkdownText(
    model: ContentModelDocument,
    lines: string[],
    options: MarkdownToModelOptions
): ContentModelDocument {
    const markdownContext: MarkdownContext = {
        lastQuote: undefined,
        lastList: undefined,
        tableLines: [],
    };
    for (const line of lines) {
        let matched = false;
        for (const patternName in MarkdownPattern) {
            Eif (MarkdownPattern.hasOwnProperty(patternName)) {
                const pattern = MarkdownPattern[patternName];
                if (pattern.test(line)) {
                    addMarkdownBlockToModel(
                        model,
                        MarkdownBlockType[patternName],
                        line,
                        patternName,
                        markdownContext,
                        options
                    );
                    matched = true;
                    break;
                }
            }
        }
 
        if (!matched) {
            addMarkdownBlockToModel(
                model,
                'Paragraph',
                line,
                'paragraph',
                markdownContext,
                options
            );
        }
    }
    return model;
}