@ckeditor/ckeditor5-markdown-gfm 39.0.1 → 40.0.0

package/src/gfmdataprocessor.js

@@ -1,72 +1,72 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm/gfmdataprocessor
- */
-import { HtmlDataProcessor } from 'ckeditor5/src/engine';
-import markdown2html from './markdown2html/markdown2html';
-import html2markdown, { turndownService } from './html2markdown/html2markdown';
-/**
- * This data processor implementation uses GitHub Flavored Markdown as input/output data.
- *
- * See the {@glink features/markdown Markdown output} guide to learn more on how to enable it.
- */
-export default class GFMDataProcessor {
-    /**
-     * Creates a new instance of the Markdown data processor class.
-     */
-    constructor(document) {
-        this._htmlDP = new HtmlDataProcessor(document);
-    }
-    /**
-     * Keeps the specified element in the output as HTML. This is useful if the editor contains
-     * features producing HTML that is not a part of the Markdown standard.
-     *
-     * By default, all HTML tags are removed.
-     *
-     * @param element The element name to be kept.
-     */
-    keepHtml(element) {
-        turndownService.keep([element]);
-    }
-    /**
-     * Converts the provided Markdown string to a view tree.
-     *
-     * @param data A Markdown string.
-     * @returns The converted view element.
-     */
-    toView(data) {
-        const html = markdown2html(data);
-        return this._htmlDP.toView(html);
-    }
-    /**
-     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format — in this
-     * case to a Markdown string.
-     *
-     * @returns Markdown string.
-     */
-    toData(viewFragment) {
-        const html = this._htmlDP.toData(viewFragment);
-        return html2markdown(html);
-    }
-    /**
-     * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
-     * and not processed during the conversion from Markdown to view elements.
-     *
-     * The raw data can be later accessed by a
-     * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
-     *
-     * @param pattern The pattern matching all view elements whose content should
-     * be treated as raw data.
-     */
-    registerRawContentMatcher(pattern) {
-        this._htmlDP.registerRawContentMatcher(pattern);
-    }
-    /**
-     * This method does not have any effect on the data processor result. It exists for compatibility with the
-     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor `DataProcessor` interface}.
-     */
-    useFillerType() { }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/gfmdataprocessor
+ */
+import { HtmlDataProcessor } from 'ckeditor5/src/engine';
+import markdown2html from './markdown2html/markdown2html';
+import html2markdown, { turndownService } from './html2markdown/html2markdown';
+/**
+ * This data processor implementation uses GitHub Flavored Markdown as input/output data.
+ *
+ * See the {@glink features/markdown Markdown output} guide to learn more on how to enable it.
+ */
+export default class GFMDataProcessor {
+    /**
+     * Creates a new instance of the Markdown data processor class.
+     */
+    constructor(document) {
+        this._htmlDP = new HtmlDataProcessor(document);
+    }
+    /**
+     * Keeps the specified element in the output as HTML. This is useful if the editor contains
+     * features producing HTML that is not a part of the Markdown standard.
+     *
+     * By default, all HTML tags are removed.
+     *
+     * @param element The element name to be kept.
+     */
+    keepHtml(element) {
+        turndownService.keep([element]);
+    }
+    /**
+     * Converts the provided Markdown string to a view tree.
+     *
+     * @param data A Markdown string.
+     * @returns The converted view element.
+     */
+    toView(data) {
+        const html = markdown2html(data);
+        return this._htmlDP.toView(html);
+    }
+    /**
+     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format — in this
+     * case to a Markdown string.
+     *
+     * @returns Markdown string.
+     */
+    toData(viewFragment) {
+        const html = this._htmlDP.toData(viewFragment);
+        return html2markdown(html);
+    }
+    /**
+     * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
+     * and not processed during the conversion from Markdown to view elements.
+     *
+     * The raw data can be later accessed by a
+     * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
+     *
+     * @param pattern The pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern) {
+        this._htmlDP.registerRawContentMatcher(pattern);
+    }
+    /**
+     * This method does not have any effect on the data processor result. It exists for compatibility with the
+     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor `DataProcessor` interface}.
+     */
+    useFillerType() { }
+}

package/src/html2markdown/html2markdown.d.ts

@@ -1,10 +1,10 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-declare const turndownService: any;
-/**
- * Parses HTML to a markdown.
- */
-export default function html2markdown(html: string): string;
-export { turndownService };
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+declare const turndownService: any;
+/**
+ * Parses HTML to a markdown.
+ */
+export default function html2markdown(html: string): string;
+export { turndownService };

package/src/html2markdown/html2markdown.js

@@ -1,126 +1,126 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @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';
-// There no avaialble types for 'turndown-plugin-gfm' module and it's not worth to generate them on our own.
-// @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(
-// 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.
-    }
-}
-/**
- * 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--;
-        }
-        else if (char == ')') {
-            let openBrackets = 0;
-            for (let i = 0; i < length; i++) {
-                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;
-            }
-        }
-        else {
-            break;
-        }
-    }
-    return length;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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';
+// There no avaialble types for 'turndown-plugin-gfm' module and it's not worth to generate them on our own.
+// @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(
+// 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.
+    }
+}
+/**
+ * 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--;
+        }
+        else if (char == ')') {
+            let openBrackets = 0;
+            for (let i = 0; i < length; i++) {
+                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;
+            }
+        }
+        else {
+            break;
+        }
+    }
+    return length;
+}

package/src/index.d.ts

@@ -1,9 +1,9 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm
- */
-export { default as Markdown } from './markdown';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm
+ */
+export { default as Markdown } from './markdown';
+import './augmentation';

package/src/index.js

@@ -1,9 +1,9 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm
- */
-export { default as Markdown } from './markdown';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm
+ */
+export { default as Markdown } from './markdown';
+import './augmentation';

package/src/markdown.d.ts

@@ -1,23 +1,23 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm/markdown
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-/**
- * The GitHub Flavored Markdown (GFM) plugin.
- *
- * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
- */
-export default class Markdown extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Markdown";
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The GitHub Flavored Markdown (GFM) plugin.
+ *
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
+ */
+export default class Markdown extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Markdown";
+}

package/src/markdown.js

@@ -1,29 +1,29 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm/markdown
- */
-import { Plugin } from 'ckeditor5/src/core';
-import GFMDataProcessor from './gfmdataprocessor';
-/**
- * The GitHub Flavored Markdown (GFM) plugin.
- *
- * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
- */
-export default class Markdown extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.data.processor = new GFMDataProcessor(editor.data.viewDocument);
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Markdown';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import GFMDataProcessor from './gfmdataprocessor';
+/**
+ * The GitHub Flavored Markdown (GFM) plugin.
+ *
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
+ */
+export default class Markdown extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.data.processor = new GFMDataProcessor(editor.data.viewDocument);
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Markdown';
+    }
+}

package/src/markdown2html/markdown2html.d.ts

@@ -1,13 +1,13 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module markdown-gfm/markdown2html/markdown2html
- */
-import { marked } from 'marked';
-/**
- * Parses markdown string to an HTML.
- */
-export default function markdown2html(markdown: string): string;
-export { marked };
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown2html/markdown2html
+ */
+import { marked } from 'marked';
+/**
+ * Parses markdown string to an HTML.
+ */
+export default function markdown2html(markdown: string): string;
+export { marked };