feat: fix trimify and configs, and export trimify

src/constants.js

@@ -2,8 +2,8 @@
  * @type {import('types').DefaultConfig}
  */
 export const CONFIG = {
-  ignore: {},
+  ignore: [],
   strict: false,
   tab_size: 2,
-  trim: {}
+  trim: []
 }

src/exports/index.js

@@ -2,3 +2,4 @@ export { closify } from '../closify.js'
 export { entify } from '../entify.js'
 export { minify } from '../minify.js'
 export { prettify } from '../prettify.js'
+export { trimify } from '../utils.js'

src/prettify.js

@@ -9,7 +9,7 @@ import { CONFIG } from './constants.js'
 let strict
 
 /**
- * @type {Record<string, string>}
+ * @type {string[]}
  */
 let trim
 
@@ -53,8 +53,8 @@ const enqueue = (html) => {
 const preprocess = (html) => {
   html = closify(html, false)
 
-  if (trim)
-    trimify(html, trim)
+  if (trim.length > 0)
+    html = trimify(html, trim)
 
   html = minify(html, false)
   html = enqueue(html)
@@ -156,7 +156,7 @@ export const prettify = (html, config) => {
   const validated_config = config ? validateConfig(config) : CONFIG
   strict = validated_config.strict
 
-  const ignore = Object.keys(validated_config.ignore).length > 0
+  const ignore = validated_config.ignore.length > 0
   trim = validated_config.trim
 
   /* Protect ignored elements. */

src/types/internal.d.ts

@@ -1,8 +1,8 @@
 export interface DefaultConfig {
-	ignore: Record<string, string>;
+	ignore: string[];
 	strict: boolean;
 	tab_size: number;
-	trim: Record<string, string>;
+	trim: string[];
 }
 
 type RecursiveRequired<T> = {

src/utils.js

@@ -21,17 +21,23 @@ export const isHtml = (content) => {
 const mergeObjects = (current, updates) => {
   if (!current || !updates)
     throw new Error("Both 'current' and 'updates' must be passed-in to merge()")
-  if (typeof current !== 'object' || typeof updates !== 'object')
-    throw new Error("Both 'current' and 'updates' must be passed-in as objects to merge()")
 
-  let merged = { ...current }
-
-  for (let key of Object.keys(updates)) {
-    if (typeof updates[key] !== 'object') {
-      merged[key] = updates[key]
-    } else {
-      /* key is an object, run mergeObjects again. */
-      merged[key] = mergeObjects(merged[key] || {}, updates[key])
+  /**
+   * @type {any}
+   */
+  let merged
+
+  if (Array.isArray(current)) {
+    merged = structuredClone(current).concat(updates)
+  } else if (typeof current === 'object') {
+    merged = { ...current }
+    for (let key of Object.keys(updates)) {
+      if (typeof updates[key] !== 'object') {
+        merged[key] = updates[key]
+      } else {
+        /* key is an object, run mergeObjects again. */
+        merged[key] = mergeObjects(merged[key] || {}, updates[key])
+      }
     }
   }
 
@@ -57,12 +63,12 @@ export const mergeConfig = (dconfig, config) => {
  * Ignores elements by protecting or unprotecting their entities.
  * 
  * @param {string} html 
- * @param {Record<string, string>} ignore
+ * @param {string[]} ignore
  * @param {string} [mode]
  * @returns {string}
  */
 export const ignoreElement = (html, ignore, mode = 'protect') => {
-  for (let e = 0; e < Object.keys(ignore).length; e++) {
+  for (let e = 0; e < ignore.length; e++) {
     const regex = new RegExp(`<${ignore[e]}[^>]*>((.|\n)*?)<\/${ignore[e]}>`, "g")
     html = html.replace(regex, mode === 'protect' ? protectElement : unprotectElement)
   }
@@ -92,11 +98,11 @@ const protectElement = (match, capture) => {
  * Trim leading and trailing whitespace characters.
  * 
  * @param {string} html
- * @param {Record<string, string>} trim
+ * @param {string[]} trim
  * @returns {string}
  */
 export const trimify = (html, trim) => {
-  for (let e = 0; e < Object.keys(trim).length; e++) {
+  for (let e = 0; e < trim.length; e++) {
     /* Whitespace character must be escaped with '\' or RegExp() won't include it. */
     const leading_whitespace = new RegExp(`(<${trim[e]}[^>]*>)\\s+`, "g")
     const trailing_whitespace = new RegExp(`\\s+(</${trim[e]}>)`, "g")

tests/all.spec.js

@@ -94,8 +94,12 @@ const testConfig = async (config) => {
 }
 
 test('Trimify', () => {
-  expect(trimify(trim_leading_whitespace, { '0': 'div' })).toBe('<div>Hello</div>')
-  expect(trimify(trim_trailing_whitespace, { '0': 'div' })).toBe('<div>Hello</div>')
+  expect(trimify(trim_leading_whitespace, ['div'])).toBe('<div>Hello</div>')
+  expect(trimify(trim_trailing_whitespace, ['div'])).toBe('<div>Hello</div>')
+  expect(prettify(entify_html, { trim: [ 'textarea' ]})).toBe(
+    `<textarea>Did&nbsp;&nbsp;&nbsp;you&nbsp;know&nbsp;that&nbsp;3&nbsp;&gt;&nbsp;&nbsp;&nbsp;2?&#10;&#10;This&nbsp;is&nbsp;another&nbsp;paragraph.</textarea>
+<textarea class="more stuff"></textarea>`
+  )
 })
 
 test('Prettify', () => {

types/index.d.ts

@@ -6,12 +6,7 @@ declare module 'htmlfy' {
     trim?: string[];
   }
 
-  export interface Config {
-    ignore: Record<string, string>;
-    strict: boolean;
-    tab_size: number;
-    trim: Record<string, string>;
-  }
+  export type Config = Required<UserConfig>
 
   /**
    * Ensure void elements are "self-closing".
@@ -55,4 +50,13 @@ declare module 'htmlfy' {
    * @returns A well-formed HTML string.
    */
   export function prettify(html: string, config?: UserConfig): string
+
+  /**
+   * Trim leading and trailing whitespace from the defined HTML elements.
+   * 
+   * @param {string} html
+   * @param {string[]} trim
+   * @returns A trimmed string.
+   */
+  export function trimify(html: string, trim: string[]): string
 }