@ckeditor/ckeditor5-utils 45.1.0 → 45.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "45.1.0",
+  "version": "45.2.0-alpha.1",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-ui": "45.1.0",
+    "@ckeditor/ckeditor5-ui": "45.2.0-alpha.1",
     "es-toolkit": "1.32.0"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/areconnectedthroughproperties.js

@@ -5,7 +5,6 @@
 /**
  * @module utils/areconnectedthroughproperties
  */
-/* globals EventTarget, Event */
 /**
  * Traverses both structures to find out whether there is a reference that is shared between both structures.
  */
@@ -43,9 +42,8 @@ function getSubNodes(head) {
             try {
                 nodes.push(...node);
             }
-            catch (err) {
-                // eslint-disable-line no-empty
-            }
+            // eslint-disable-next-line no-empty
+            catch { }
         }
         else {
             nodes.push(...Object.values(node));

package/src/ckeditorerror.js

@@ -5,7 +5,6 @@
 /**
  * @module utils/ckeditorerror
  */
-/* globals console */
 /**
  * URL to the documentation with error codes.
  */

package/src/delay.js

@@ -5,7 +5,6 @@
 /**
  * @module utils/delay
  */
-/* globals setTimeout, clearTimeout */
 /**
  * Returns a function wrapper that will trigger a function after a specified wait time.
  * The timeout can be canceled by calling the cancel function on the returned wrapped function.

package/src/dom/getancestors.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-/* globals Node */
 /**
  * @module utils/dom/getancestors
  */

package/src/dom/getdatafromelement.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-/* globals HTMLTextAreaElement */
 /**
  * @module utils/dom/getdatafromelement
  */

package/src/dom/global.js

@@ -23,7 +23,7 @@ let globalVar; // named globalVar instead of global: https://github.com/ckeditor
 try {
     globalVar = { window, document };
 }
-catch (e) {
+catch {
     // It's not possible to mock a window object to simulate lack of a window object without writing extremely convoluted code.
     /* istanbul ignore next -- @preserve */
     // Let's cast it to not change module's API.

package/src/dom/iscomment.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-/* globals Node */
 /**
  * @module utils/dom/iscomment
  */

package/src/dom/isvalidattributename.js

@@ -15,7 +15,7 @@ export default function isValidAttributeName(name) {
     try {
         global.document.createAttribute(name);
     }
-    catch (error) {
+    catch {
         return false;
     }
     return true;

package/src/dom/setdatainelement.js

@@ -5,7 +5,6 @@
 /**
  * @module utils/dom/setdatainelement
  */
-/* globals HTMLTextAreaElement */
 /**
  * Sets data in a given element.
  *

package/src/env.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-/* globals navigator:false */
 /**
  * @module utils/env
  */
@@ -16,7 +15,7 @@ export function getUserAgent() {
     try {
         return navigator.userAgent.toLowerCase();
     }
-    catch (e) {
+    catch {
         return '';
     }
 }
@@ -122,7 +121,7 @@ export function isRegExpUnicodePropertySupported() {
         // Usage of regular expression literal cause error during build (ckeditor/ckeditor5-dev#534).
         isSupported = 'ć'.search(new RegExp('[\\p{L}]', 'u')) === 0;
     }
-    catch (error) {
+    catch {
         // Firefox throws a SyntaxError when the group is unsupported.
     }
     return isSupported;

package/src/focustracker.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-/* global setTimeout, clearTimeout */
 /**
  * @module utils/focustracker
  */

package/src/formathtml.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */
+/**
+ * @module utils/formathtml
+ */
+/**
+ * A simple (and naive) HTML code formatter that returns a formatted HTML markup that can be easily
+ * parsed by human eyes. It beautifies the HTML code by adding new lines between elements that behave like block elements
+ * (https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements
+ * and a few more like `tr`, `td`, and similar ones) and inserting indents for nested content.
+ *
+ * WARNING: This function works only on a text that does not contain any indentations or new lines.
+ * Calling this function on the already formatted text will damage the formatting.
+ *
+ * @param input An HTML string to format.
+ */
+export default function formatHtml(input: string): string;

package/src/formathtml.js

@@ -0,0 +1,164 @@
+/**
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */
+/**
+ * @module utils/formathtml
+ */
+/**
+ * A simple (and naive) HTML code formatter that returns a formatted HTML markup that can be easily
+ * parsed by human eyes. It beautifies the HTML code by adding new lines between elements that behave like block elements
+ * (https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements
+ * and a few more like `tr`, `td`, and similar ones) and inserting indents for nested content.
+ *
+ * WARNING: This function works only on a text that does not contain any indentations or new lines.
+ * Calling this function on the already formatted text will damage the formatting.
+ *
+ * @param input An HTML string to format.
+ */
+export default function formatHtml(input) {
+    // A list of block-like elements around which the new lines should be inserted, and within which
+    // the indentation of their children should be increased.
+    // The list is partially based on https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements that contains
+    // a full list of HTML block-level elements.
+    // A void element is an element that cannot have any child - https://html.spec.whatwg.org/multipage/syntax.html#void-elements.
+    // Note that <pre> element is not listed on this list to avoid breaking whitespace formatting.
+    // Note that <br> element is not listed and handled separately so no additional white spaces are injected.
+    const elementsToFormat = [
+        { name: 'address', isVoid: false },
+        { name: 'article', isVoid: false },
+        { name: 'aside', isVoid: false },
+        { name: 'blockquote', isVoid: false },
+        { name: 'details', isVoid: false },
+        { name: 'dialog', isVoid: false },
+        { name: 'dd', isVoid: false },
+        { name: 'div', isVoid: false },
+        { name: 'dl', isVoid: false },
+        { name: 'dt', isVoid: false },
+        { name: 'fieldset', isVoid: false },
+        { name: 'figcaption', isVoid: false },
+        { name: 'figure', isVoid: false },
+        { name: 'footer', isVoid: false },
+        { name: 'form', isVoid: false },
+        { name: 'h1', isVoid: false },
+        { name: 'h2', isVoid: false },
+        { name: 'h3', isVoid: false },
+        { name: 'h4', isVoid: false },
+        { name: 'h5', isVoid: false },
+        { name: 'h6', isVoid: false },
+        { name: 'header', isVoid: false },
+        { name: 'hgroup', isVoid: false },
+        { name: 'hr', isVoid: true },
+        { name: 'li', isVoid: false },
+        { name: 'main', isVoid: false },
+        { name: 'nav', isVoid: false },
+        { name: 'ol', isVoid: false },
+        { name: 'p', isVoid: false },
+        { name: 'section', isVoid: false },
+        { name: 'table', isVoid: false },
+        { name: 'tbody', isVoid: false },
+        { name: 'td', isVoid: false },
+        { name: 'th', isVoid: false },
+        { name: 'thead', isVoid: false },
+        { name: 'tr', isVoid: false },
+        { name: 'ul', isVoid: false }
+    ];
+    const elementNamesToFormat = elementsToFormat.map(element => element.name).join('|');
+    // It is not the fastest way to format the HTML markup but the performance should be good enough.
+    const lines = input
+        // Add new line before and after `<tag>` and `</tag>`.
+        // It may separate individual elements with two new lines, but this will be fixed below.
+        .replace(new RegExp(`</?(${elementNamesToFormat})( .*?)?>`, 'g'), '\n$&\n')
+        // Keep `<br>`s at the end of line to avoid adding additional whitespaces before `<br>`.
+        .replace(/<br[^>]*>/g, '$&\n')
+        // Divide input string into lines, which start with either an opening tag, a closing tag, or just a text.
+        .split('\n');
+    let indentCount = 0;
+    let isPreformattedLine = false;
+    return lines
+        .map(line => {
+        isPreformattedLine = isPreformattedBlockLine(line, isPreformattedLine);
+        // Ignore empty lines outside a <pre> block.
+        if (!line.length && !isPreformattedLine) {
+            return '';
+        }
+        if (isNonVoidOpeningTag(line, elementsToFormat)) {
+            return indentLine(line, indentCount++);
+        }
+        if (isClosingTag(line, elementsToFormat)) {
+            return indentLine(line, --indentCount);
+        }
+        if (isPreformattedLine === 'middle' || isPreformattedLine === 'last') {
+            return indentLine(line, 0);
+        }
+        return indentLine(line, indentCount);
+    })
+        .join('')
+        .trimEnd();
+}
+/**
+ * Checks, if an argument is an opening tag of a non-void element to be formatted.
+ *
+ * @param line String to check.
+ * @param elementsToFormat Elements to be formatted.
+ */
+function isNonVoidOpeningTag(line, elementsToFormat) {
+    return elementsToFormat.some(element => {
+        if (element.isVoid) {
+            return false;
+        }
+        if (!new RegExp(`<${element.name}( .*?)?>`).test(line)) {
+            return false;
+        }
+        return true;
+    });
+}
+/**
+ * Checks, if an argument is a closing tag.
+ *
+ * @param line String to check.
+ * @param elementsToFormat Elements to be formatted.
+ */
+function isClosingTag(line, elementsToFormat) {
+    return elementsToFormat.some(element => {
+        return new RegExp(`</${element.name}>`).test(line);
+    });
+}
+/**
+ * Indents a line by a specified number of characters.
+ *
+ * @param line Line to indent.
+ * @param indentCount Number of characters to use for indentation.
+ * @param indentChar Indentation character(s). 4 spaces by default.
+ */
+function indentLine(line, indentCount, indentChar = '    ') {
+    // More about Math.max() here in https://github.com/ckeditor/ckeditor5/issues/10698.
+    return `${indentChar.repeat(Math.max(0, indentCount))}${line}\n`;
+}
+/**
+ * Checks whether a line belongs to a preformatted (`<pre>`) block.
+ *
+ * @param line Line to check.
+ * @param isPreviousLinePreFormatted Information on whether the previous line was preformatted (and how).
+ */
+function isPreformattedBlockLine(line, isPreviousLinePreFormatted) {
+    const isPreOpen = /<pre( .*?)?>/.test(line);
+    const isPreClose = /<\/pre>/.test(line);
+    if (isPreOpen && isPreClose) {
+        // If both an opening and closing a <pre> tag, no special treatment needed.
+        return false;
+    }
+    else if (isPreOpen) {
+        return 'first';
+    }
+    else if (isPreClose) {
+        return 'last';
+    }
+    else if (isPreviousLinePreFormatted === 'first' || isPreviousLinePreFormatted === 'middle') {
+        // This line is just after a 'first' or 'middle' line of a multi-line pre-block.
+        return 'middle';
+    }
+    else {
+        return false;
+    }
+}

package/src/index.d.ts

@@ -65,5 +65,6 @@ export { default as wait } from './wait.js';
 export { default as parseBase64EncodedObject } from './parsebase64encodedobject.js';
 export { default as crc32, type CRCData } from './crc32.js';
 export { default as collectStylesheets } from './collectstylesheets.js';
+export { default as formatHtml } from './formathtml.js';
 export * from './unicode.js';
 export { default as version, releaseDate } from './version.js';

package/src/index.js

@@ -64,5 +64,6 @@ export { default as wait } from './wait.js';
 export { default as parseBase64EncodedObject } from './parsebase64encodedobject.js';
 export { default as crc32 } from './crc32.js';
 export { default as collectStylesheets } from './collectstylesheets.js';
+export { default as formatHtml } from './formathtml.js';
 export * from './unicode.js';
 export { default as version, releaseDate } from './version.js';

package/src/locale.js

@@ -5,7 +5,6 @@
 /**
  * @module utils/locale
  */
-/* globals console */
 import toArray from './toarray.js';
 import { _translate, _unifyTranslations } from './translation-service.js';
 import { getLanguageDirection } from './language.js';

package/src/parsebase64encodedobject.js

@@ -16,7 +16,7 @@ export default function parseBase64EncodedObject(encoded) {
         const decoded = atob(encoded.replace(/-/g, '+').replace(/_/g, '/'));
         return JSON.parse(decoded);
     }
-    catch (e) {
+    catch {
         return null;
     }
 }

package/src/version.d.ts

@@ -2,7 +2,7 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-declare const version = "45.1.0";
+declare const version = "45.2.0-alpha.1";
 export default version;
 export declare const releaseDate: Date;
 declare global {

package/src/version.js

@@ -6,10 +6,10 @@
  * @module utils/version
  */
 import CKEditorError from './ckeditorerror.js';
-const version = '45.1.0';
+const version = '45.2.0-alpha.1';
 export default version;
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-export const releaseDate = new Date(2025, 4, 14);
+export const releaseDate = new Date(2025, 4, 29);
 /* istanbul ignore next -- @preserve */
 if (globalThis.CKEDITOR_VERSION) {
     /**