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 242 243 244 245 246 247 248 249 250 251 252 | 1x 40x 22x 22x 22x 1x 21x 21x 21x 21x 21x 14x 14x 14x 28x 28x 28x 14x 28x 28x 28x 1x 28x 28x 28x 14x 28x 28x 21x 21x 21x 1x 49x 49x 49x 49x 49x 2x 2x 2x 2x 3x 3x 3x 3x 49x 49x 49x 49x 49x 51x 5x 46x 49x 5x 49x 49x 1x | /**
* Copyright (c) Siemens 2016 - 2025
* SPDX-License-Identifier: MIT
*/
import { SecurityContext } from '@angular/core';
import { DomSanitizer } from '@angular/platform-browser';
/**
* Returns a markdown renderer function which_
* - Transforms markdown text into formatted HTML.
* - Returns a DOM node containing the formatted content.
*
* **Warning:** The returned Node is inserted without additional sanitization.
* Input content is sanitized before processing.
*
* @experimental
* @param sanitizer - Angular DomSanitizer instance
* @returns A function taking the markdown text to transform and returning a DOM div element containing the formatted HTML
*/
export const getMarkdownRenderer = (sanitizer: DomSanitizer): ((text: string) => Node) => {
return (text: string): Node => {
const div = document.createElement('div');
div.className = 'markdown-content text-break';
if (!text) {
return div;
}
// Generate a random placeholder for newlines to preserve them during HTML sanitization
const newlinePlaceholder = `--NEWLINE-${Math.random().toString(36).substring(2, 15)}--`;
// Replace newlines with placeholder before sanitization
const valueWithPlaceholders = text.replace(/\n/g, newlinePlaceholder);
// Sanitize the input using Angular's HTML sanitizer
const sanitizedInput = sanitizer.sanitize(SecurityContext.HTML, valueWithPlaceholders) ?? '';
// Restore newlines from placeholder for markdown processing.
let html = sanitizedInput.replace(new RegExp(newlinePlaceholder, 'g'), '\n');
// Process tables first
html = html
// Remove table separator lines first
.replace(/^\|\s*[-:]+.*\|\s*$/gm, '')
// Process table rows
.replace(/^\|(.+)\|\s*$/gm, (_match, htmlContent) => {
// Handle escaped pipes by temporarily replacing them
const escapedPipePlaceholder = `--ESCAPED-PIPE-${Math.random().toString(36).substring(2, 15)}--`;
const contentWithPlaceholders = htmlContent.replace(/\\\|/g, escapedPipePlaceholder);
const cells = contentWithPlaceholders.split('|').map((cell: string) => {
const trimmedCell = cell.trim();
// Restore escaped pipes
const cellWithPipes = trimmedCell.replace(new RegExp(escapedPipePlaceholder, 'g'), '|');
return cellWithPipes;
});
// Make cell ready for markdown processing by replacing code blocks with inline code and <br> with newlines
const cellsWithNewlines = cells.map((cell: string) => {
// Replace multiline code blocks with single line code blocks
const cellWithoutMultilineCode = cell.replace(
/```([\s\S]*?)```/g,
(_innerMatch, inlineCodeContent) => {
return '`' + inlineCodeContent.replace(/`/g, '') + '`';
}
);
// Temporarily replace single line code blocks to avoid replacing <br> inside them
const tableInlineCodeBrPlaceholder = `--INLINE-CODE-BR--${Math.random().toString(36).substring(2, 15)}--`;
const cellWithPlaceholders = cellWithoutMultilineCode.replace(
/(`[^`]*`)/g,
inlineCodeMatch => {
return inlineCodeMatch.replace(/<br>/g, tableInlineCodeBrPlaceholder);
}
);
// Replace <br> with newlines
const cellWithNewlines = cellWithPlaceholders.replace(/<br\s*\/?>/gi, '\n');
// Restore <br> in inline code placeholders
const preProcessedCell = cellWithNewlines.replace(
new RegExp(tableInlineCodeBrPlaceholder, 'g'),
'<br>'
);
return preProcessedCell;
});
// Recursively process cell content for markdown formatting
const processedCells = cellsWithNewlines.map((cell: string) => {
return transformMarkdownText(cell, false, sanitizer);
});
return `<tr>${processedCells.map((cell: string) => `<td>${cell}</td>`).join('')}</tr>`;
})
// Wrap table rows in table elements
.replace(/(<tr>.*?<\/tr>)/gs, '<table class="table table-hover">$1</table>')
// Remove duplicate table tags
.replace(/<\/table>\s*<table class="table table-hover">/g, '');
html = transformMarkdownText(html, true, sanitizer);
div.innerHTML = html;
return div;
};
};
const transformMarkdownText = (
html: string,
keepAdditionalNewlines = true,
sanitizer: DomSanitizer
): string => {
// Generate a random placeholder for inner code blocks to prevent markdown processing inside them
const innerCodeQuotePlaceholder = `--INNER-CODE-${Math.random().toString(36).substring(2, 15)}--`;
const codeSectionPlaceholderMap = new Map<string, string>();
const escapedAsteriskPlaceholder = `--ASTERISK-${Math.random().toString(36).substring(2, 15)}--`;
const escapedUnderscorePlaceholder = `--UNDERSCORE-${Math.random().toString(36).substring(2, 15)}--`;
// Apply markdown transformations to the sanitized content
html = html
// Multiline code blocks ```code``` with placeholder
.replace(/```[^\n]*\n?([\s\S]*?)\n?```/g, (match, content) => {
// Escape HTML special characters in code blocks (not for security, but for correct display) and preserve inner backticks
const code = `<pre><code>${content.replace(/</g, '<').replace(/>/g, '>').replace(/`/g, innerCodeQuotePlaceholder)}</code></pre>`;
const codePlaceholder = `--CODE-BLOCK-${Math.random().toString(36).substring(2, 15)}--`;
codeSectionPlaceholderMap.set(codePlaceholder, code);
return codePlaceholder;
})
// Inline code `text`
.replace(/`(.*?)`/g, (match, content) => {
// Escape HTML special characters in inline code (not for security, but for correct display)
const code = `<code>${content.replace(/</g, '<').replace(/>/g, '>')}</code>`;
const codePlaceholder = `--INLINE-CODE-${Math.random().toString(36).substring(2, 15)}--`;
codeSectionPlaceholderMap.set(codePlaceholder, code);
return codePlaceholder;
})
// Links [text](url)
.replace(/\[([^\]]+)\]\(([^)]+)\)/g, (_match, text, url) => {
const sanitizedUrl = sanitizeUrl(url, sanitizer);
return `<a href="${sanitizedUrl}" target="_blank" rel="noopener noreferrer">${text}</a>`;
})
// Auto-detect URLs and convert to links
.replace(/(?<!["'=(])\b(https?:\/\/[^\s<]+[^\s<.,;!?"')\]])/g, match => {
const sanitizedUrl = sanitizeUrl(match, sanitizer);
return `<a href="${sanitizedUrl}" target="_blank" rel="noopener noreferrer">${match}</a>`;
})
.replace(/(?<!\\)\\\*/g, escapedAsteriskPlaceholder)
.replace(/(?<!\\)\\_/g, escapedUnderscorePlaceholder)
// Bold **text** or __text__
.replace(/\*\*(.*?)\*\*/g, '<strong>$1</strong>')
.replace(/__(.*?)__/g, '<strong>$1</strong>')
// Italic *text* or _text_
.replace(/\*(.*?)\*/g, '<em>$1</em>')
.replace(/_(.*?)_/g, '<em>$1</em>')
.replace(new RegExp(escapedAsteriskPlaceholder, 'g'), '*')
.replace(new RegExp(escapedUnderscorePlaceholder, 'g'), '*')
// Headings #, ##, ###, etc.
.replace(/^###### (.*$)/gm, '<strong>$1</strong>')
.replace(/^##### (.*$)/gm, '<h5>$1</h5>')
.replace(/^#### (.*$)/gm, '<h4>$1</h4>')
.replace(/^### (.*$)/gm, '<h3>$1</h3>')
.replace(/^## (.*$)/gm, '<h2>$1</h2>')
.replace(/^# (.*$)/gm, '<h2><strong>$1</strong></h2>');
html = html
// Bullet points - handle each type separately (• gets converted to • by sanitizer)
.replace(/^• (.*$)/gm, '<li class="unordered">$1</li>')
.replace(/^- (.*$)/gm, '<li class="unordered">$1</li>')
// Ordered list items (1., 2., 3., etc.)
.replace(/^\d+\. (.*$)/gm, '<li class="ordered">$1</li>');
html = html.replace(/^\s*(?:>|>)\s*(.*)$/gm, '<blockquote>$1</blockquote>');
// Generate a random placeholder for newlines to differentiate them from those used for paragraphs
const finalNewlinePlaceholder = `--NEWLINE-${Math.random().toString(36).substring(2, 15)}--`;
html = html
// Wrap ordered lists
.replace(/(<li class="ordered">.*?<\/li>)/gs, '<ol>$1</ol>')
// Wrap unordered lists
.replace(/(<li class="unordered">.*?<\/li>)/gs, '<ul>$1</ul>')
// Remove duplicate ol/ul tags
.replace(/<\/ol>\s*<ol>/g, '')
.replace(/<\/ul>\s*<ul>/g, '')
// Clean up class attributes
.replace(/ class="ordered"/g, '')
.replace(/ class="unordered"/g, '');
html = html
// Convert double newlines to paragraphs (before single line breaks)
.split(/\n{2}/g)
// Wrap non-block elements in <p> tags
.map(segment => {
// If the segment starts with a block element, return as is
if (!segment.trim() || /^\s*<(h[1-6]|pre|blockquote|ul|ol)/.test(segment.trim())) {
// Replace newlines inside blocks with the placeholder
return segment.replace(/\n/g, finalNewlinePlaceholder);
}
// Otherwise, wrap in <p> tags
return `<p>${segment}</p>`;
})
// Use newline placeholder again so as not to replace newlines between blocks
.join(finalNewlinePlaceholder)
// Convert remaining newlines to line breaks (do this LAST)
.replace(/\n/g, '<br>')
// Restore newline placeholders
.replace(new RegExp(finalNewlinePlaceholder, 'g'), keepAdditionalNewlines ? '\n' : ' ');
// Restore code placeholders
codeSectionPlaceholderMap.forEach((code, placeholder) => {
html = html.replace(new RegExp(placeholder, 'g'), code);
});
// Restore inner code block placeholders
html = html.replace(new RegExp(innerCodeQuotePlaceholder, 'g'), '`');
return html;
};
/**
* Sanitizes a URL to prevent XSS attacks
* @param url - The URL to sanitize
* @param sanitizer - Angular DomSanitizer instance
* @returns The sanitized URL or '#' if invalid
*/
const sanitizeUrl = (url: string, sanitizer: DomSanitizer): string => {
// Remove any whitespace
url = url.trim();
// Allow only http, https, and mailto protocols
const allowed = /^(https?:\/\/|mailto:|\/(?!\/)|\.{1,2}\/|#)/i;
// Sanitize the URL using Angular's sanitizer
Iif (!allowed.test(url)) {
return '#';
}
// Sanitize the URL using Angular's sanitizer
const sanitized = sanitizer.sanitize(SecurityContext.URL, url);
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
return sanitized || '#';
};
|