Merge pull request #1386 from remarkablemark/refactor/client

refactor(client): remove exports `formatAttributes` and `CARRIAGE_RETURN`

Author: remarkablemark

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,7 +23,6 @@ assignees: remarkablemark
 Creating a bug demo will help speed up the process of resolving the issue:
 
 * JSFiddle: https://jsfiddle.net/remarkablemark/ff9yg1yz/
-* Replit: https://replit.com/@remarkablemark/html-dom-parser
 -->
 
 ## Environment

README.md

@@ -236,6 +236,10 @@ If you're parsing SVG, you can set `lowerCaseTags` to `true` without having to e
 
 ## Migration
 
+### v6
+
+Upgraded [domhandler](https://github.com/fb55/domhandler/releases/tag/v6.0.0) and [htmlparser2](https://github.com/fb55/htmlparser2/releases/tag/v11.0.0). Removed client exports `formatAttributes` and `CARRIAGE_RETURN` constants.
+
 ### v5
 
 Migrated to TypeScript. CommonJS imports require the `.default` key:
@@ -246,19 +250,19 @@ const parse = require('html-dom-parser').default;
 
 ### v4
 
-Upgraded [htmlparser2](https://github.com/fb55/htmlparser2) to v9.
+Upgraded [htmlparser2](https://github.com/fb55/htmlparser2/releases/tag/v9.0.0).
 
 ### v3
 
-Upgraded [domhandler](https://github.com/fb55/domhandler) to v5. [Parser options](https://github.com/fb55/htmlparser2/wiki/Parser-options) like `normalizeWhitespace` have been removed.
+Upgraded [domhandler](https://github.com/fb55/domhandler/releases/tag/v5.0.0). [Parser options](https://github.com/fb55/htmlparser2/wiki/Parser-options) like `normalizeWhitespace` have been removed.
 
 ### v2
 
 Removed Internet Explorer (IE11) support.
 
 ### v1
 
-Upgraded `domhandler` to v4 and `htmlparser2` to v6.
+Upgraded [domhandler](https://github.com/fb55/domhandler/releases/tag/v4.0.0) and [htmlparser2](https://github.com/fb55/htmlparser2/releases/tag/v6.0.0).
 
 ## Release
 

__tests__/server/client.test.ts

@@ -1,5 +1,4 @@
 // @vitest-environment jsdom
-import { CARRIAGE_RETURN_PLACEHOLDER } from '../../src/client/constants';
 import { formatDOM } from '../../src/client/utilities';
 import { revertEscapedCharacters } from '../../src/client/utilities';
 import { escapeSpecialCharacters } from '../../src/client/utilities';
@@ -15,8 +14,8 @@ describe('client utilities', () => {
 
   describe('escapeSpecialCharacters', () => {
     it('escapes carriage return characters', () => {
-      expect(escapeSpecialCharacters('Hello\rWorld')).to.equal(
-        `Hello${CARRIAGE_RETURN_PLACEHOLDER}World`,
+      expect(escapeSpecialCharacters('Hello\rWorld')).to.match(
+        /^Hello__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__World$/,
       );
     });
 
@@ -31,23 +30,30 @@ describe('client utilities', () => {
     });
 
     it('handles multiple carriage returns', () => {
-      expect(escapeSpecialCharacters('Hello\rDear\rWorld')).to.equal(
-        `Hello${CARRIAGE_RETURN_PLACEHOLDER}Dear${CARRIAGE_RETURN_PLACEHOLDER}World`,
+      const escaped = escapeSpecialCharacters('Hello\rDear\rWorld');
+      const placeholders = escaped.match(
+        /__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__/g,
       );
+
+      expect(escaped).to.match(
+        /^Hello__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__Dear__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__World$/,
+      );
+      expect(placeholders).to.have.length(2);
+      expect(placeholders?.[0]).to.equal(placeholders?.[1]);
     });
 
     it('only escapes carriage returns', () => {
       // `\n` and `\right` should not be affected
-      expect(escapeSpecialCharacters('Hello\rWorld\n\right')).to.equal(
-        `Hello${CARRIAGE_RETURN_PLACEHOLDER}World\n${CARRIAGE_RETURN_PLACEHOLDER}ight`,
+      expect(escapeSpecialCharacters('Hello\rWorld\n\right')).to.match(
+        /^Hello__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__World\n__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_\d+__ight$/,
       );
     });
   });
 
   describe('revertEscapedCharacters', () => {
     it('reverts escaped carriage return characters', () => {
       expect(
-        revertEscapedCharacters(`Hello${CARRIAGE_RETURN_PLACEHOLDER}World`),
+        revertEscapedCharacters(escapeSpecialCharacters('Hello\rWorld')),
       ).to.equal('Hello\rWorld');
     });
 
@@ -63,17 +69,15 @@ describe('client utilities', () => {
 
     it('handles multiple escaped carriage returns', () => {
       expect(
-        revertEscapedCharacters(
-          `Hello${CARRIAGE_RETURN_PLACEHOLDER}Dear${CARRIAGE_RETURN_PLACEHOLDER}World`,
-        ),
+        revertEscapedCharacters(escapeSpecialCharacters('Hello\rDear\rWorld')),
       ).to.equal('Hello\rDear\rWorld');
     });
 
     it('only reverts escaped carriage returns', () => {
       // `\n` and `\right` should not be affected
       expect(
         revertEscapedCharacters(
-          `Hello${CARRIAGE_RETURN_PLACEHOLDER}World\\n\\right`,
+          escapeSpecialCharacters('Hello\rWorld\\n\\right'),
         ),
       ).to.equal('Hello\rWorld\\n\\right');
     });

src/client/constants.ts

@@ -43,11 +43,3 @@ export const CASE_SENSITIVE_TAG_NAMES_MAP = CASE_SENSITIVE_TAG_NAMES.reduce<
   accumulator[tagName.toLowerCase()] = tagName;
   return accumulator;
 }, {});
-
-export const CARRIAGE_RETURN = '\r';
-export const CARRIAGE_RETURN_REGEX = new RegExp(CARRIAGE_RETURN, 'g');
-export const CARRIAGE_RETURN_PLACEHOLDER = `__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_${Date.now().toString()}__`;
-export const CARRIAGE_RETURN_PLACEHOLDER_REGEX = new RegExp(
-  CARRIAGE_RETURN_PLACEHOLDER,
-  'g',
-);

src/client/utilities.ts

@@ -1,13 +1,15 @@
 import { Comment, Element, ProcessingInstruction, Text } from 'domhandler';
 
 import type { DOMNode } from '../types';
-import {
-  CARRIAGE_RETURN,
+import { CASE_SENSITIVE_TAG_NAMES_MAP } from './constants';
+
+const CARRIAGE_RETURN = '\r';
+const CARRIAGE_RETURN_REGEX = new RegExp(CARRIAGE_RETURN, 'g');
+const CARRIAGE_RETURN_PLACEHOLDER = `__HTML_DOM_PARSER_CARRIAGE_RETURN_PLACEHOLDER_${Date.now().toString()}__`;
+const CARRIAGE_RETURN_PLACEHOLDER_REGEX = new RegExp(
   CARRIAGE_RETURN_PLACEHOLDER,
-  CARRIAGE_RETURN_PLACEHOLDER_REGEX,
-  CARRIAGE_RETURN_REGEX,
-  CASE_SENSITIVE_TAG_NAMES_MAP,
-} from './constants';
+  'g',
+);
 
 /**
  * Gets case-sensitive tag name.
@@ -25,7 +27,7 @@ function getCaseSensitiveTagName(tagName: string): string | undefined {
  * @param attributes - List of attributes.
  * @returns - Map of attribute name to value.
  */
-export function formatAttributes(attributes: NamedNodeMap) {
+function formatAttributes(attributes: NamedNodeMap) {
   const map: Record<string, string> = {};
   let index = 0;
   const attributesLength = attributes.length;