@ckeditor/ckeditor5-clipboard 40.0.0 → 40.2.0

package/src/utils/plaintexttohtml.js

@@ -1,37 +1,39 @@
-/**
- * @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 clipboard/utils/plaintexttohtml
- */
-/**
- * Converts plain text to its HTML-ized version.
- *
- * @param text The plain text to convert.
- * @returns HTML generated from the plain text.
- */
-export default function plainTextToHtml(text) {
-    text = text
-        // Encode <>.
-        .replace(/</g, '&lt;')
-        .replace(/>/g, '&gt;')
-        // Creates a paragraph for each double line break.
-        .replace(/\r?\n\r?\n/g, '</p><p>')
-        // Creates a line break for each single line break.
-        .replace(/\r?\n/g, '<br>')
-        // Replace tabs with four spaces.
-        .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')
-        // Preserve trailing spaces (only the first and last one – the rest is handled below).
-        .replace(/^\s/, '&nbsp;')
-        .replace(/\s$/, '&nbsp;')
-        // Preserve other subsequent spaces now.
-        .replace(/\s\s/g, ' &nbsp;');
-    if (text.includes('</p><p>') || text.includes('<br>')) {
-        // If we created paragraphs above, add the trailing ones.
-        text = `<p>${text}</p>`;
-    }
-    // TODO:
-    // * What about '\nfoo' vs ' foo'?
-    return text;
-}
+/**
+ * @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 clipboard/utils/plaintexttohtml
+ */
+/**
+ * Converts plain text to its HTML-ized version.
+ *
+ * @param text The plain text to convert.
+ * @returns HTML generated from the plain text.
+ */
+export default function plainTextToHtml(text) {
+    text = text
+        // Encode &.
+        .replace(/&/g, '&amp;')
+        // Encode <>.
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        // Creates a paragraph for each double line break.
+        .replace(/\r?\n\r?\n/g, '</p><p>')
+        // Creates a line break for each single line break.
+        .replace(/\r?\n/g, '<br>')
+        // Replace tabs with four spaces.
+        .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')
+        // Preserve trailing spaces (only the first and last one – the rest is handled below).
+        .replace(/^\s/, '&nbsp;')
+        .replace(/\s$/, '&nbsp;')
+        // Preserve other subsequent spaces now.
+        .replace(/\s\s/g, ' &nbsp;');
+    if (text.includes('</p><p>') || text.includes('<br>')) {
+        // If we created paragraphs above, add the trailing ones.
+        text = `<p>${text}</p>`;
+    }
+    // TODO:
+    // * What about '\nfoo' vs ' foo'?
+    return text;
+}

package/src/utils/viewtoplaintext.d.ts

@@ -1,15 +1,15 @@
-/**
- * @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 clipboard/utils/viewtoplaintext
- */
-import type { ViewDocumentFragment, ViewItem } from '@ckeditor/ckeditor5-engine';
-/**
- * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
- *
- * @param viewItem View item to convert.
- * @returns Plain text representation of `viewItem`.
- */
-export default function viewToPlainText(viewItem: ViewItem | ViewDocumentFragment): string;
+/**
+ * @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 clipboard/utils/viewtoplaintext
+ */
+import type { ViewDocumentFragment, ViewItem } from '@ckeditor/ckeditor5-engine';
+/**
+ * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
+ *
+ * @param viewItem View item to convert.
+ * @returns Plain text representation of `viewItem`.
+ */
+export default function viewToPlainText(viewItem: ViewItem | ViewDocumentFragment): string;

package/src/utils/viewtoplaintext.js

@@ -1,50 +1,67 @@
-/**
- * @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
- */
-// Elements which should not have empty-line padding.
-// Most `view.ContainerElement` want to be separate by new-line, but some are creating one structure
-// together (like `<li>`) so it is better to separate them by only one "\n".
-const smallPaddingElements = ['figcaption', 'li'];
-/**
- * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
- *
- * @param viewItem View item to convert.
- * @returns Plain text representation of `viewItem`.
- */
-export default function viewToPlainText(viewItem) {
-    let text = '';
-    if (viewItem.is('$text') || viewItem.is('$textProxy')) {
-        // If item is `Text` or `TextProxy` simple take its text data.
-        text = viewItem.data;
-    }
-    else if (viewItem.is('element', 'img') && viewItem.hasAttribute('alt')) {
-        // Special case for images - use alt attribute if it is provided.
-        text = viewItem.getAttribute('alt');
-    }
-    else if (viewItem.is('element', 'br')) {
-        // A soft break should be converted into a single line break (#8045).
-        text = '\n';
-    }
-    else {
-        // Other elements are document fragments, attribute elements or container elements.
-        // They don't have their own text value, so convert their children.
-        let prev = null;
-        for (const child of viewItem.getChildren()) {
-            const childText = viewToPlainText(child);
-            // Separate container element children with one or more new-line characters.
-            if (prev && (prev.is('containerElement') || child.is('containerElement'))) {
-                if (smallPaddingElements.includes(prev.name) ||
-                    smallPaddingElements.includes(child.name)) {
-                    text += '\n';
-                }
-                else {
-                    text += '\n\n';
-                }
-            }
-            text += childText;
-            prev = child;
-        }
-    }
-    return text;
-}
+/**
+ * @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
+ */
+// Elements which should not have empty-line padding.
+// Most `view.ContainerElement` want to be separate by new-line, but some are creating one structure
+// together (like `<li>`) so it is better to separate them by only one "\n".
+const smallPaddingElements = ['figcaption', 'li'];
+const listElements = ['ol', 'ul'];
+/**
+ * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
+ *
+ * @param viewItem View item to convert.
+ * @returns Plain text representation of `viewItem`.
+ */
+export default function viewToPlainText(viewItem) {
+    if (viewItem.is('$text') || viewItem.is('$textProxy')) {
+        return viewItem.data;
+    }
+    if (viewItem.is('element', 'img') && viewItem.hasAttribute('alt')) {
+        return viewItem.getAttribute('alt');
+    }
+    if (viewItem.is('element', 'br')) {
+        return '\n'; // Convert soft breaks to single line break (#8045).
+    }
+    /**
+     * Item is a document fragment, attribute element or container element. It doesn't
+     * have it's own text value, so we need to convert its children elements.
+     */
+    let text = '';
+    let prev = null;
+    for (const child of viewItem.getChildren()) {
+        text += newLinePadding(child, prev) + viewToPlainText(child);
+        prev = child;
+    }
+    return text;
+}
+/**
+ * Returns new line padding to prefix the given elements with.
+ */
+function newLinePadding(element, previous) {
+    if (!previous) {
+        // Don't add padding to first elements in a level.
+        return '';
+    }
+    if (element.is('element', 'li') && !element.isEmpty && element.getChild(0).is('containerElement')) {
+        // Separate document list items with empty lines.
+        return '\n\n';
+    }
+    if (listElements.includes(element.name) && listElements.includes(previous.name)) {
+        /**
+         * Because `<ul>` and `<ol>` are AttributeElements, two consecutive lists will not have any padding between
+         * them (see the `if` statement below). To fix this, we need to make an exception for this case.
+         */
+        return '\n\n';
+    }
+    if (!element.is('containerElement') && !previous.is('containerElement')) {
+        // Don't add padding between non-container elements.
+        return '';
+    }
+    if (smallPaddingElements.includes(element.name) || smallPaddingElements.includes(previous.name)) {
+        // Add small padding between selected container elements.
+        return '\n';
+    }
+    // Add empty lines between container elements.
+    return '\n\n';
+}