coralite 0.6.1 → 0.6.3

package/README.md

@@ -3,10 +3,10 @@
 coralite is a static site generator library built around the emerging [HTML modules proposal](https://github.com/WICG/webcomponents/blob/gh-pages/proposals/html-modules-explainer.md).
 
 - Getting started
-  [Basic templating](./docs/basic-templating.md)
+  - [Basic templating](./docs/basic-templating.md)
 - Reference
-  [Coralite CLI](./docs/coralite-cli.md)
-  [Coralite](./docs/coralite.md)
+  - [Coralite CLI](./docs/coralite-cli.md)
+  - [Coralite](./docs/coralite.md)
 
 ## Installation
 
@@ -30,20 +30,6 @@ yarn add -D coralite
 pnpm add -D coralite
 ```
 
-## Requirements
-
-Coralite uses **ECMAScript Modules** which requires to run Node.js with the **`--experimental-vm-modules`** option enabled.
-
-```bash
-node --experimental-vm-modules node_modules/coralite/bin/coralite.js [options]
-```
-
-or using NODE_OPTIONS
-
-```bash
-NODE_OPTIONS=--experimental-vm-modules coralite [options]
-```
-
 ## Basic Syntax
 
 Coralite is executed using the following command:
@@ -65,7 +51,7 @@ To generate a website using Coralite, you must provide three essential options:
 Here's an example of how these options might look:
 
 ```bash
-coralite --templates ./src/templates --pages ./src/pages --output ./dist
+coralite --templates ./path/to/templates --pages ./path/to/pages --output ./dist
 ```
 
 ## Optional Options
@@ -75,5 +61,20 @@ coralite --templates ./src/templates --pages ./src/pages --output ./dist
 Run the CLI in dry-run mode to preview the actions that would be performed without actually generating the website. This is useful for debugging or when you want to check potential issues before committing changes:
 
 ```bash
-coralite --templates ./src/templates --pages ./src/pages --output ./dist --dry-run
+coralite --templates ./path/to/templates --pages ./path/to/pages --output ./dist --dry-run
 ```
+
+## Troubleshooting
+
+
+Coralite uses **ECMAScript Modules** which requires to run Node.js with the **`--experimental-vm-modules`** option enabled.
+
+```bash
+node --experimental-vm-modules node_modules/coralite/bin/coralite.js [options]
+```
+
+or using NODE_OPTIONS
+
+```bash
+NODE_OPTIONS=--experimental-vm-modules coralite [options]
+```

package/bin/coralite.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node --experimental-vm-modules
 
 import { getSubDirectory, getPkg, coralite } from '#lib'
 import { Command } from 'commander'
@@ -6,6 +6,9 @@ import { join } from 'node:path'
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs'
 import kleur from 'kleur'
 
+// Remove all Node warnings before doing anything else
+process.removeAllListeners('warning')
+
 const pkg = await getPkg()
 const program = new Command()
 

package/change-logs.md

@@ -0,0 +1,80 @@
+# 🎁 Release notes (`v0.6.3`)
+
+## Changes
+- 6fe640d (HEAD -> main, tag: v0.6.3, origin/main) test: cover ignore by attribute - (*[Thomas David](https://github.com/tjdav)*)
+- a47ff8f types: add IgnoreByAttribute type - (*[Thomas David](https://github.com/tjdav)*)
+- 8547c37 feat: ignore element by attributes inside meta and component parsers - (*[Thomas David](https://github.com/tjdav)*)
+- f61ae88 docs: update ignore-attribute example with quotes - (*[Thomas David](https://github.com/tjdav)*)
+- d4a277d docs: create consistent path names in example - (*[Thomas David](https://github.com/tjdav)*)
+- 566463f docs: remove requirements section - (*[Thomas David](https://github.com/tjdav)*)
+- 2493ab3 style: import type new line - (*[Thomas David](https://github.com/tjdav)*)
+- 2e44174 ci: test before publish - (*[Thomas David](https://github.com/tjdav)*)
+- c1d5ce7 fix: add template id to script module error - (*[Thomas David](https://github.com/tjdav)*)
+- 4fabac1 ci: include self to test script - (*[Thomas David](https://github.com/tjdav)*)
+- efd34d0 fix: add --experimental-vm-modules to shebang - (*[Thomas David](https://github.com/tjdav)*)
+- 7da5d98 refactor: add type check before splicing children. - (*[Thomas David](https://github.com/tjdav)*)
+- 2e39027 fix: catch bad options for aggregate function - (*[Thomas David](https://github.com/tjdav)*)
+
+## Metadata
+```
+This version -------- v0.6.3
+Previous version ---- v0.6.2
+Total commits ------- 13
+```
+# 🎁 Release notes (`v0.6.2`)
+
+## Changes
+- be6c54c (HEAD -> main, tag: v0.6.2, origin/main) fix: update lock - (*[Thomas David](https://github.com/tjdav)*)
+- 15d9b4e chore: version bump - (*[Thomas David](https://github.com/tjdav)*)
+- fac695e fix: node v18 requires globalThis reference for crypto - (*[Thomas David](https://github.com/tjdav)*)
+- d7c551e doc: format doc links - (*[Thomas David](https://github.com/tjdav)*)
+
+## Metadata
+```
+This version -------- v0.6.2
+Previous version ---- v0.6.1
+Total commits ------- 4
+```
+# 🎁 Release notes (`v0.6.1`)
+
+## Changes
+- bcc1637 (HEAD -> main, tag: v0.6.1, origin/main) chore: version bump - (*[Thomas David](https://github.com/tjdav)*)
+- 95cfdba docs: add doc links - (*[Thomas David](https://github.com/tjdav)*)
+- 101a305 fix: render computedSlot nodes - (*[Thomas David](https://github.com/tjdav)*)
+- 11a35d8 feat: dynamically import modules - (*[Thomas David](https://github.com/tjdav)*)
+- e1364b9 docs: add CoraliteResult type - (*[Thomas David](https://github.com/tjdav)*)
+- 11c6405 docs: add @example to coralite - (*[Thomas David](https://github.com/tjdav)*)
+- a050263 docs: basic technical documentation - (*[Thomas David](https://github.com/tjdav)*)
+- 83fdddd docs: update dry run option - (*[Thomas David](https://github.com/tjdav)*)
+
+## Metadata
+```
+This version -------- v0.6.1
+Previous version ---- v0.6.0
+Total commits ------- 8
+```
+# 🎁 Release notes (`v0.6.0`)
+
+## Changes
+- 22d75e2 (HEAD -> main, tag: v0.6.0, origin/main) chore: version bump - (*[Thomas David](https://github.com/tjdav)*)
+- c5cc7cc lint: ignore playwright-report - (*[Thomas David](https://github.com/tjdav)*)
+- fdb3697 docs: add dry run option - (*[Thomas David](https://github.com/tjdav)*)
+- 891db2e feat: export coralite utils - (*[Thomas David](https://github.com/tjdav)*)
+- 9265681 test: cover ignore attribute - (*[Thomas David](https://github.com/tjdav)*)
+- 5d44661 fix: allow missing component to compile - (*[Thomas David](https://github.com/tjdav)*)
+- f3d6e65 docs: add remove prop to CoraliteElement - (*[Thomas David](https://github.com/tjdav)*)
+- 229fef5 feat: new option to ignore element by attribute name value pair - (*[Thomas David](https://github.com/tjdav)*)
+- c78dde1 chore: include kleur dep - (*[Thomas David](https://github.com/tjdav)*)
+- b10bbe8 feat: update cli to use coralite module - (*[Thomas David](https://github.com/tjdav)*)
+- 48fe816 docs: make defineComponent param tokens and slots optional - (*[Thomas David](https://github.com/tjdav)*)
+- 02a5e8f feat: move coralite to a module - (*[Thomas David](https://github.com/tjdav)*)
+- d336090 feat: get package.json util function - (*[Thomas David](https://github.com/tjdav)*)
+- e210844 feat: add document used in error message - (*[Thomas David](https://github.com/tjdav)*)
+- 1556a3b chore: version bump - (*[Thomas David](https://github.com/tjdav)*)
+
+## Metadata
+```
+This version -------- v0.6.0
+Previous version ---- v0.5.1
+Total commits ------- 15
+```

package/lib/coralite.js

@@ -8,7 +8,8 @@ import render from 'dom-serializer'
  *  CoraliteAggregateTemplate,
  *  CoraliteAnyNode,
  *  CoraliteModule,
- *  CoraliteResult} from '#types'
+ *  CoraliteResult
+ * } from '#types'
  */
 
 /**
@@ -98,7 +99,7 @@ export async function coralite ({
   // create templates
   for (let i = 0; i < htmlTemplates.length; i++) {
     const html = htmlTemplates[i]
-    const coraliteModule = parseModule(html.content)
+    const coraliteModule = parseModule(html.content, ignoreByAttribute)
 
     coraliteModules[coraliteModule.id] = coraliteModule
   }

package/lib/html-module.js

@@ -1,9 +1,10 @@
 import { join } from 'node:path'
 import getHTML from './get-html.js'
 import { createComponent, parseHTMLMeta } from './parse.js'
+import { existsSync } from 'node:fs'
 
 /**
- * @import { CoraliteTokenOptions, CoraliteModule, CoraliteDocument, CoraliteModuleValues } from '#types'
+ * @import { CoraliteTokenOptions, CoraliteModule, CoraliteDocument, CoraliteModuleValues, CoraliteAggregateTemplate } from '#types'
  */
 
 /**
@@ -11,8 +12,7 @@ import { createComponent, parseHTMLMeta } from './parse.js'
  *
  * @param {Object} options - Configuration object for the aggregation process
  * @param {string} options.path - The path to aggregate, relative to pages directory
- * @param {Object} options.template - Templates used to display the result
- * @param {string} options.template.item - Unique identifier for the component used for each document
+ * @param {CoraliteAggregateTemplate | string} options.template - Templates used to display the result
  * @param {boolean} [options.recursive] - Whether to recursively search subdirectories
  * @param {CoraliteTokenOptions} [options.tokens] - Token configuration options
  * @param {CoraliteModuleValues} values - Default token values
@@ -25,15 +25,39 @@ import { createComponent, parseHTMLMeta } from './parse.js'
  * aggregate({
  *   path: 'button',
  *   recursive: true,
- *   template: { item: 'my-component' }
+ *   template: 'my-component'
  * }, {
  *   className: 'btn'
  * }, components, document);
  * ```
  */
 export async function aggregate (options, values, components, document) {
+  if (!document.path.pages) {
+    throw new Error('Document page path was undefined')
+  }
+
+  const path = join(document.path.pages, options.path)
+
+  if (!existsSync(path)) {
+    /** @TODO Refer to documentation */
+    throw new Error('Aggregate path does not exist: "' + path + '"')
+  }
+
+  let componentId
+
+  if (typeof options.template === 'string') {
+    componentId = options.template
+  } else if (typeof options.template === 'object') {
+    componentId = options.template.item
+  }
+
+  if (!componentId) {
+    /** @TODO Refer to documentation */
+    throw new Error('Aggregate template was undefined')
+  }
+
   const pages = await getHTML({
-    path: join(document.path.pages, options.path),
+    path,
     recursive: options.recursive,
     exclude: [document.name]
   })
@@ -42,7 +66,7 @@ export async function aggregate (options, values, components, document) {
 
   for (let i = 0; i < pages.length; i++) {
     const page = pages[i]
-    const meta = parseHTMLMeta(page.content)
+    const meta = parseHTMLMeta(page.content, document.ignoreByAttribute)
     const pageValues = Object.assign({}, values)
 
     for (const key in meta) {
@@ -63,13 +87,16 @@ export async function aggregate (options, values, components, document) {
     }
 
     const component = await createComponent({
-      id: options.template.item,
+      id: componentId,
       values: pageValues,
       components,
       document
     })
 
-    result = result.concat(component.children)
+    if (typeof component === 'object') {
+      // concat rendered components
+      result = result.concat(component.children)
+    }
   }
 
   return result

package/lib/parse.js

@@ -3,6 +3,7 @@ import { aggregate } from './html-module.js'
 import vm from 'node:vm'
 import { invalidCustomTags, validTags } from './tags.js'
 
+
 /**
  * @import {Module} from 'node:vm'
  * @import {
@@ -18,7 +19,8 @@ import { invalidCustomTags, validTags } from './tags.js'
  *  CoraliteDocumentRoot,
  *  CoraliteContentNode,
  *  CoraliteModuleValues,
- *  CoraliteAggregateTemplate
+ *  CoraliteAggregateTemplate,
+ *  IgnoreByAttribute
  * } from '#types'
  */
 
@@ -31,7 +33,7 @@ const customElementTagTokenRegExp = /^[^-].*[-._a-z0-9\u00B7\u00C0-\u00D6\u00D8-
  *
  * @param {HTMLData} html - The HTML data containing the content to parse
  * @param {CoralitePath} path - The path object containing the file path information
- * @param {Array<string[]>} [ignoreByAttribute] - Ignore element with attribute name value pair
+ * @param {IgnoreByAttribute} [ignoreByAttribute] - Ignore element with attribute name value pair
  * @returns {CoraliteDocument} An object representing the parsed document structure
  *
  * @example
@@ -75,17 +77,13 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
     },
     onopentag (originalName, attributes) {
       const parent = stack[stack.length - 1]
-      const element = createElement(originalName, attributes, customElements, parent)
-
-      if (ignoreByAttribute) {
-        for (let i = 0; i < ignoreByAttribute.length; i++) {
-          const [key, value] = ignoreByAttribute[i]
-
-          if (attributes[key] && attributes[key].includes(value)) {
-            element.remove = true
-          }
-        }
-      }
+      const element = createElement({
+        name: originalName,
+        attributes,
+        customElements,
+        parent,
+        ignoreByAttribute
+      })
 
       // push element to stack as it may have children
       stack.push(element)
@@ -98,10 +96,8 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
     onclosetag () {
       const element = stack[stack.length - 1]
 
-      // @ts-ignore
-      if (element.remove) {
+      if (element.type === 'tag' && element.remove) {
         // remove element from tree
-        // @ts-ignore
         element.parent.children.pop()
       }
 
@@ -148,7 +144,8 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
     parentPath: html.parentPath,
     root,
     customElements,
-    path
+    path,
+    ignoreByAttribute
   }
 }
 
@@ -156,6 +153,7 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
  * Parses HTML string containing meta tags and extracts associated metadata.
  *
  * @param {string} string - HTML content containing meta tags
+ * @param {IgnoreByAttribute} ignoreByAttribute - IgnoreByAttribute option (optional) - If provided and true then the HTML tags will be ignored by this attribute name(s)
  * @returns {Object.<string, CoraliteToken[]>}
  *
  * @example
@@ -170,7 +168,7 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
  * //}
  * ```
  */
-export function parseHTMLMeta (string) {
+export function parseHTMLMeta (string, ignoreByAttribute) {
   // stack to keep track of current element hierarchy
   const stack = []
   /** @type {Object.<string, CoraliteToken[]>} */
@@ -181,6 +179,15 @@ export function parseHTMLMeta (string) {
     onopentag (name, attributes) {
       if (name === 'meta') {
         if (attributes.content) {
+          if (ignoreByAttribute) {
+            // ignore meta tags by attribute name
+            const ignore = findAttributesToIgnore(ignoreByAttribute, attributes)
+
+            if (ignore) {
+              return
+            }
+          }
+
           if (attributes.property) {
             addMetadata(meta, attributes.property, attributes.content)
           }
@@ -217,6 +224,7 @@ export function parseHTMLMeta (string) {
  * Parses HTML string containing meta tags or generates Coralite module structure from markup.
  *
  * @param {string} string - HTML content containing meta tags or module markup
+ * @param {IgnoreByAttribute} ignoreByAttribute
  * @returns {CoraliteModule} - Parsed module information, including template, script, tokens, and slot configurations
  *
  * @example
@@ -244,7 +252,7 @@ export function parseHTMLMeta (string) {
  * //}
  * ```
  */
-export function parseModule (string) {
+export function parseModule (string, ignoreByAttribute) {
   // root element reference
   /** @type {CoraliteDocumentRoot} */
   const root = {
@@ -268,7 +276,13 @@ export function parseModule (string) {
   const parser = new Parser({
     onopentag (originalName, attributes) {
       const parent = stack[stack.length -1]
-      const element = createElement(originalName, attributes, customElements, parent)
+      const element = createElement({
+        name: originalName,
+        attributes,
+        customElements,
+        parent,
+        ignoreByAttribute
+      })
       const attributeNames = Object.keys(attributes)
 
       // push element to stack as it may have children
@@ -351,6 +365,13 @@ export function parseModule (string) {
       }
     },
     onclosetag () {
+      const element = stack[stack.length - 1]
+
+      if (element.type === 'tag' && element.remove) {
+        // remove element from tree
+        element.parent.children.pop()
+      }
+
       // remove current element from stack as we're done with its children
       stack.pop()
     },
@@ -387,7 +408,7 @@ export function parseModule (string) {
 
       } else if (node.name == 'script') {
         if (node.attribs.type !== 'module') {
-          throw new Error('Script tag must contain the `type="module"` attribute')
+          throw new Error('Template "'+ templateId + '" script tag must contain the `type="module"` attribute')
         }
         const scriptString = node.children[0]
 
@@ -456,10 +477,13 @@ export async function createComponent ({
     return console.warn('Could not find component "' + id +'" used in document "' + document.parentPath + '/' + document.name + '"')
   }
 
+  // clone the component to avoid mutations during replacement process.
   component = structuredClone(component)
+
   const template = component.template
   const computedTokens = []
 
+  // replace tokens in the template with their values from `values` object and store them into computedTokens array for later use if needed (e.g., to be injected back).
   for (let i = 0; i < component.tokens.attributes.length; i++) {
     const item = component.tokens.attributes[i]
 
@@ -479,7 +503,7 @@ export async function createComponent ({
 
           continue
         } else {
-          console.error('Token "' + token.name +'" was empty used on "' + component.id + '"')
+          console.log('Token "' + token.name +'" was empty used on "' + component.id + '"')
           value = ''
         }
       }
@@ -523,7 +547,13 @@ export async function createComponent ({
 
   // merge values from component script
   if (component.script) {
-    const computedValues = await parseScript(component, values, element, components, document)
+    const computedValues = await parseScript({
+      component,
+      values,
+      element,
+      components,
+      document
+    })
 
     values = Object.assign(values, computedValues)
 
@@ -587,7 +617,9 @@ export async function createComponent ({
     }
 
     // replace custom element with component
-    children.splice(childIndex, 1, ...component.children)
+    if (typeof component === 'object') {
+      children.splice(childIndex, 1, ...component.children)
+    }
   }
 
   const slots = component.slotElements[id]
@@ -638,16 +670,23 @@ export async function createComponent ({
 /**
  * Parses a Coralite module script and compiles it into JavaScript.
  *
- * @param {CoraliteModule} component - The Coralite module to parse
- * @param {CoraliteModuleValues} values - Replacement tokens for the component
- * @param {CoraliteElement} element - Element
- * @param {Object.<string, CoraliteModule>} components - Mapping of other components that might be referenced
- * @param {CoraliteDocument} document - The current document being processed
+ * @param {Object} data
+ * @param {CoraliteModule} data.component - The Coralite module to parse
+ * @param {CoraliteModuleValues} data.values - Replacement tokens for the component
+ * @param {CoraliteElement} data.element - Element
+ * @param {Object.<string, CoraliteModule>} data.components - Mapping of other components that might be referenced
+ * @param {CoraliteDocument} data.document - The current document being processed
  * @returns {Promise<Object.<string,(string|(CoraliteElement|CoraliteTextNode)[])>>}
  */
-export async function parseScript (component, values, element, components, document) {
+export async function parseScript ({
+  component,
+  values,
+  element,
+  components,
+  document
+}) {
   const contextifiedObject = vm.createContext({
-    crypto,
+    crypto: globalThis.crypto,
     coralite: {
       tokens: values,
       /**
@@ -732,7 +771,7 @@ export async function parseScript (component, values, element, components, docum
 
         if (typeof options.template === 'string') {
           templateId = options.template
-        } else {
+        } else if (typeof options.template === 'object') {
           templateId = options.template.item
         }
 
@@ -841,12 +880,20 @@ function addMetadata (meta, name, content) {
 }
 
 /**
- * @param {string} name
- * @param {Object.<string, string>} attributes
- * @param {CoraliteElement[]} customElements
- * @param {CoraliteElement | CoraliteDocumentRoot} parent
+ * @param {Object} data
+ * @param {string} data.name
+ * @param {Object.<string, string>} data.attributes
+ * @param {CoraliteElement[]} data.customElements
+ * @param {CoraliteElement | CoraliteDocumentRoot} data.parent
+ * @param {IgnoreByAttribute} data.ignoreByAttribute
  */
-function createElement (name, attributes, customElements, parent) {
+function createElement ({
+  name,
+  attributes,
+  customElements,
+  parent,
+  ignoreByAttribute
+}) {
   const sanitisedName = name.toLowerCase()
 
   /** @type {CoraliteElement} */
@@ -859,6 +906,14 @@ function createElement (name, attributes, customElements, parent) {
     parentChildIndex: parent.children.length
   }
 
+  if (ignoreByAttribute) {
+    const ignore = findAttributesToIgnore(ignoreByAttribute, attributes)
+
+    if (ignore) {
+      element.remove = true
+    }
+  }
+
   if (!validTags[sanitisedName]) {
     if (invalidCustomTags[sanitisedName]) {
       throw new Error('Element name is reserved: "'+ sanitisedName +'"')
@@ -900,3 +955,22 @@ function createTextNode (data, parent) {
 
   return textNode
 }
+
+/**
+ * Find attributes to be ignored by the parser.
+ *
+ * @param {Array<Array<string, string>>} ignore - An array of attribute pairs to be ignored by the parser
+ * @param {Object<string, string>} attributes - The HTML attribute object to be parsed by the parser
+ * @returns {boolean}
+ */
+function findAttributesToIgnore (ignore, attributes) {
+  for (let i = 0; i < ignore.length; i++) {
+    const [key, value] = ignore[i]
+
+    if (attributes[key] && attributes[key].includes(value)) {
+      return true
+    }
+  }
+
+  return false
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "HTML modules static site generator",
   "main": "./lib/coralite.js",
   "type": "module",
@@ -31,7 +31,7 @@
     "test-e2e": "playwright test",
     "test-e2e-report": "playwright show-report",
     "test-e2e-ui": "playwright test --ui",
-    "html": "node --experimental-vm-modules bin/coralite.js -t tests/fixtures/templates -p tests/fixtures/pages -o dist -i 'data-dev=true'",
+    "html": "coralite -t tests/fixtures/templates -p tests/fixtures/pages -o dist -i 'data-dev=true'",
     "server": "sirv dist --dev --port 3000"
   },
   "bin": "bin/coralite.js",
@@ -56,6 +56,8 @@
     "@stylistic/eslint-plugin-js": "^2.12.1",
     "@stylistic/eslint-plugin-plus": "^2.12.1",
     "@types/node": "^22.10.5",
+    "coralite": "link:",
+    "highlight.js": "^11.11.1",
     "kleur": "^4.1.5",
     "sirv-cli": "^3.0.0"
   },

package/scripts/change-log.sh

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+export VERSION=$(git tag --sort=-committerdate | head -1)
+export PREVIOUS_VERSION=$(git tag --sort=-committerdate | head -2 | awk '{split($0, tags, "\n")} END {print tags[1]}')
+export CHANGES=$(git log --pretty="- %h%d %s - (*%an*)" $VERSION...$PREVIOUS_VERSION)
+printf "# 🎁 Release notes (\`$VERSION\`)\n\n## Changes\n$CHANGES\n\n## Metadata\n\`\`\`\nThis version -------- $VERSION\nPrevious version ---- $PREVIOUS_VERSION\nTotal commits ------- $(echo "$CHANGES" | wc -l)\n\`\`\`\n" > change-logs.md

package/types/index.js

@@ -123,6 +123,7 @@
  * @property {CoraliteDocumentRoot} root - Array of elements and text nodes in the document
  * @property {CoraliteElement[]} customElements - Custom elements defined in the document
  * @property {CoralitePath} path - Document's file path
+ * @property {IgnoreByAttribute} ignoreByAttribute - An array of attribute names and values to ignore by element type.
  */
 
 /**
@@ -136,3 +137,7 @@
  * @property {string} html - Raw HTML content of the render process as a string
  * @property {number} duration - The duration of the render process in milliseconds
  */
+
+/**
+ * @typedef {Array<Array<string, string>>} IgnoreByAttribute - An array of attribute names and values to ignore by element type.
+ */