@ckeditor/ckeditor5-markdown-gfm 41.4.1 → 42.0.0-alpha.0

package/src/html2markdown/html2markdown.js

@@ -5,122 +5,130 @@
 /**
  * @module markdown-gfm/html2markdown/html2markdown
  */
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-// Importing types for this package is problematic, so it's omitted.
-// @ts-ignore
-import TurndownService from 'turndown/lib/turndown.browser.es.js';
+import Turndown from 'turndown';
 // There no avaialble types for 'turndown-plugin-gfm' module and it's not worth to generate them on our own.
+/* eslint-disable @typescript-eslint/ban-ts-comment */
 // @ts-ignore
 import { gfm } from 'turndown-plugin-gfm';
-// Override the original escape method by not escaping links.
-const originalEscape = TurndownService.prototype.escape;
-function escape(string) {
-    string = originalEscape(string);
-    // Escape "<".
-    string = string.replace(/</g, '\\<');
-    return string;
-}
-TurndownService.prototype.escape = function (string) {
-    // Urls should not be escaped. Our strategy is using a regex to find them and escape everything
-    // which is out of the matches parts.
-    let escaped = '';
-    let lastLinkEnd = 0;
-    for (const match of matchAutolink(string)) {
-        const index = match.index;
-        // Append the substring between the last match and the current one (if anything).
-        if (index > lastLinkEnd) {
-            escaped += escape(string.substring(lastLinkEnd, index));
-        }
-        const matchedURL = match[0];
-        escaped += matchedURL;
-        lastLinkEnd = index + matchedURL.length;
-    }
-    // Add text after the last link or at the string start if no matches.
-    if (lastLinkEnd < string.length) {
-        escaped += escape(string.substring(lastLinkEnd, string.length));
-    }
-    return escaped;
-};
-const turndownService = new TurndownService({
-    codeBlockStyle: 'fenced',
-    hr: '---',
-    headingStyle: 'atx'
-});
-turndownService.use([
-    gfm,
-    todoList
-]);
-/**
- * Parses HTML to a markdown.
- */
-export default function html2markdown(html) {
-    return turndownService.turndown(html);
-}
-export { turndownService };
-// This is a copy of the original taskListItems rule from turdown-plugin-gfm, with minor changes.
-function todoList(turndownService) {
-    turndownService.addRule('taskListItems', {
-        filter(node) {
-            return node.type === 'checkbox' &&
-                // Changes here as CKEditor outputs a deeper structure.
-                (node.parentNode.nodeName === 'LI' || node.parentNode.parentNode.nodeName === 'LI');
-        },
-        replacement(content, node) {
-            return (node.checked ? '[x]' : '[ ]') + ' ';
-        }
-    });
-}
-// Autolink matcher.
-const regex = new RegExp(
+const autolinkRegex = /* #__PURE__ */ new RegExp(
 // Prefix.
 /\b(?:(?:https?|ftp):\/\/|www\.)/.source +
     // Domain name.
     /(?![-_])(?:[-_a-z0-9\u00a1-\uffff]{1,63}\.)+(?:[a-z\u00a1-\uffff]{2,63})/.source +
     // The rest.
     /(?:[^\s<>]*)/.source, 'gi');
-/**
- * Trimming end of link.
- * https://github.github.com/gfm/#autolinks-extension-
- */
-function* matchAutolink(string) {
-    for (const match of string.matchAll(regex)) {
-        const matched = match[0];
-        const length = autolinkFindEnd(matched);
-        yield Object.assign([matched.substring(0, length)], { index: match.index });
-        // We could adjust regex.lastIndex but it's not needed because what we skipped is for sure not a valid URL.
+class UpdatedTurndown extends Turndown {
+    escape(string) {
+        const originalEscape = super.escape;
+        function escape(string) {
+            string = originalEscape(string);
+            // Escape "<".
+            string = string.replace(/</g, '\\<');
+            return string;
+        }
+        // Urls should not be escaped. Our strategy is using a regex to find them and escape everything
+        // which is out of the matches parts.
+        let escaped = '';
+        let lastLinkEnd = 0;
+        for (const match of this._matchAutolink(string)) {
+            const index = match.index;
+            // Append the substring between the last match and the current one (if anything).
+            if (index > lastLinkEnd) {
+                escaped += escape(string.substring(lastLinkEnd, index));
+            }
+            const matchedURL = match[0];
+            escaped += matchedURL;
+            lastLinkEnd = index + matchedURL.length;
+        }
+        // Add text after the last link or at the string start if no matches.
+        if (lastLinkEnd < string.length) {
+            escaped += escape(string.substring(lastLinkEnd, string.length));
+        }
+        return escaped;
     }
-}
-/**
- * Returns the new length of the link (after it would trim trailing characters).
- */
-function autolinkFindEnd(string) {
-    let length = string.length;
-    while (length > 0) {
-        const char = string[length - 1];
-        if ('?!.,:*_~\'"'.includes(char)) {
-            length--;
+    /**
+     * Trimming end of link.
+     * https://github.github.com/gfm/#autolinks-extension-
+     */
+    *_matchAutolink(string) {
+        for (const match of string.matchAll(autolinkRegex)) {
+            const matched = match[0];
+            const length = this._autolinkFindEnd(matched);
+            yield Object.assign([matched.substring(0, length)], { index: match.index });
+            // We could adjust regex.lastIndex but it's not needed because what we skipped is for sure not a valid URL.
         }
-        else if (char == ')') {
-            let openBrackets = 0;
-            for (let i = 0; i < length; i++) {
-                if (string[i] == '(') {
-                    openBrackets++;
+    }
+    /**
+     * Returns the new length of the link (after it would trim trailing characters).
+     */
+    _autolinkFindEnd(string) {
+        let length = string.length;
+        while (length > 0) {
+            const char = string[length - 1];
+            if ('?!.,:*_~\'"'.includes(char)) {
+                length--;
+            }
+            else if (char == ')') {
+                let openBrackets = 0;
+                for (let i = 0; i < length; i++) {
+                    if (string[i] == '(') {
+                        openBrackets++;
+                    }
+                    else if (string[i] == ')') {
+                        openBrackets--;
+                    }
                 }
-                else if (string[i] == ')') {
-                    openBrackets--;
+                // If there is fewer opening brackets then closing ones we should remove a closing bracket.
+                if (openBrackets < 0) {
+                    length--;
+                }
+                else {
+                    break;
                 }
-            }
-            // If there is fewer opening brackets then closing ones we should remove a closing bracket.
-            if (openBrackets < 0) {
-                length--;
             }
             else {
                 break;
             }
         }
-        else {
-            break;
-        }
+        return length;
+    }
+}
+/**
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert HTML to Markdown.
+ */
+export class HtmlToMarkdown {
+    constructor() {
+        this._parser = this._createParser();
+    }
+    parse(html) {
+        return this._parser.turndown(html);
+    }
+    keep(elements) {
+        this._parser.keep(elements);
+    }
+    _createParser() {
+        const parser = new UpdatedTurndown({
+            codeBlockStyle: 'fenced',
+            hr: '---',
+            headingStyle: 'atx'
+        });
+        parser.use([
+            gfm,
+            this._todoList
+        ]);
+        return parser;
+    }
+    // This is a copy of the original taskListItems rule from turndown-plugin-gfm, with minor changes.
+    _todoList(turndown) {
+        turndown.addRule('taskListItems', {
+            filter(node) {
+                return node.type === 'checkbox' &&
+                    // Changes here as CKEditor outputs a deeper structure.
+                    (node.parentNode.nodeName === 'LI' || node.parentNode.parentNode.nodeName === 'LI');
+            },
+            replacement(content, node) {
+                return (node.checked ? '[x]' : '[ ]') + ' ';
+            }
+        });
     }
-    return length;
 }

package/src/markdown2html/markdown2html.d.ts

@@ -3,11 +3,11 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module markdown-gfm/markdown2html/markdown2html
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert Markdown to HTML.
  */
-import { marked } from 'marked';
-/**
- * Parses markdown string to an HTML.
- */
-export default function markdown2html(markdown: string): string;
-export { marked };
+export declare class MarkdownToHtml {
+    private _parser;
+    private _options;
+    constructor();
+    parse(markdown: string): string;
+}

package/src/markdown2html/markdown2html.js

@@ -6,39 +6,43 @@
  * @module markdown-gfm/markdown2html/markdown2html
  */
 import { marked } from 'marked';
-// Overrides.
-marked.use({
-    tokenizer: {
-        // Disable the autolink rule in the lexer.
-        autolink: () => null,
-        url: () => null
-    },
-    renderer: {
-        checkbox(...args) {
-            // Remove bogus space after <input type="checkbox"> because it would be preserved
-            // by DomConverter as it's next to an inline object.
-            return Object.getPrototypeOf(this).checkbox.call(this, ...args).trimRight();
-        },
-        code(...args) {
-            // Since marked v1.2.8, every <code> gets a trailing "\n" whether it originally
-            // ended with one or not (see https://github.com/markedjs/marked/issues/1884 to learn why).
-            // This results in a redundant soft break in the model when loaded into the editor, which
-            // is best prevented at this stage. See https://github.com/ckeditor/ckeditor5/issues/11124.
-            return Object.getPrototypeOf(this).code.call(this, ...args).replace('\n</code>', '</code>');
-        }
-    }
-});
 /**
- * Parses markdown string to an HTML.
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert Markdown to HTML.
  */
-export default function markdown2html(markdown) {
-    const options = {
-        gfm: true,
-        breaks: true,
-        tables: true,
-        xhtml: true,
-        headerIds: false
-    };
-    return marked.parse(markdown, options);
+export class MarkdownToHtml {
+    constructor() {
+        this._options = {
+            gfm: true,
+            breaks: true,
+            tables: true,
+            xhtml: true,
+            headerIds: false
+        };
+        // Overrides.
+        marked.use({
+            tokenizer: {
+                // Disable the autolink rule in the lexer.
+                autolink: () => null,
+                url: () => null
+            },
+            renderer: {
+                checkbox(...args) {
+                    // Remove bogus space after <input type="checkbox"> because it would be preserved
+                    // by DomConverter as it's next to an inline object.
+                    return Object.getPrototypeOf(this).checkbox.call(this, ...args).trimRight();
+                },
+                code(...args) {
+                    // Since marked v1.2.8, every <code> gets a trailing "\n" whether it originally
+                    // ended with one or not (see https://github.com/markedjs/marked/issues/1884 to learn why).
+                    // This results in a redundant soft break in the model when loaded into the editor, which
+                    // is best prevented at this stage. See https://github.com/ckeditor/ckeditor5/issues/11124.
+                    return Object.getPrototypeOf(this).code.call(this, ...args).replace('\n</code>', '</code>');
+                }
+            }
+        });
+        this._parser = marked;
+    }
+    parse(markdown) {
+        return this._parser.parse(markdown, this._options);
+    }
 }
-export { marked };