@web/parse5-utils is a utility library for working with the parse5 HTML parser. It provides a set of helper functions to manipulate and query the parse5 AST (Abstract Syntax Tree) more easily.

What are @web/parse5-utils's main functionalities?

Querying Elements

This feature allows you to query elements from the parse5 AST using CSS selectors. In the example, it queries all <p> elements from the parsed HTML.

const { parse } = require('parse5');
const { queryAll } = require('@web/parse5-utils');

const html = '<div><p>Hello</p><p>World</p></div>';
const document = parse(html);
const paragraphs = queryAll(document, 'p');
console.log(paragraphs.length); // 2

Manipulating Elements

This feature allows you to manipulate elements within the parse5 AST. In the example, it appends a new <p> element with text 'Hello World' to an existing <div>.

const { parse, serialize } = require('parse5');
const { append, createElement } = require('@web/parse5-utils');

const html = '<div></div>';
const document = parse(html);
const div = document.childNodes[0].childNodes[1];
const newElement = createElement('p', {}, 'Hello World');
append(div, newElement);
console.log(serialize(document)); // <html><head></head><body><div><p>Hello World</p></div></body></html>

Removing Elements

This feature allows you to remove elements from the parse5 AST. In the example, it removes the first <p> element from the parsed HTML.

const { parse, serialize } = require('parse5');
const { remove } = require('@web/parse5-utils');

const html = '<div><p>Hello</p><p>World</p></div>';
const document = parse(html);
const paragraph = document.childNodes[0].childNodes[1].childNodes[0];
remove(paragraph);
console.log(serialize(document)); // <html><head></head><body><div><p>World</p></div></body></html>

Other packages similar to @web/parse5-utils

parse5-utils

Utils for using parse5.

Usage

Examples:

import { parse } from 'parse5';
import { createElement, getTagName, appendChild, findElement } from '@web/parse5-utils';

const doc = parse(`
  <html>
    <body>
      <my-element></my-element>
      <div id="foo"></div>
    </body>
  </html>`);

const body = findElement(doc, e => getTagName(e) === 'body');
const script = createElement('script', { src: './foo.js' });
appendChild(body, script);

import { parse } from 'parse5';
import { getTagName, getAttribute, findElements } from '@web/parse5-utils';

const doc = parse(`
  <html>
    <body>
      <script src="./a.js"></script>
      <script type="module" src="./b.js"></script>
      <script type="module" src="./c.js"></script>
    </body>
  </html>`);

const allModuleScripts = findElements(
  doc,
  e => getTagName(e) === 'script' && getAttribute(e, 'type') === 'module',
);

appendToDocument and prependToDocument will inject a snippet of HTML into the page, making sure it is executed last or first respectively.

It tries to avoid changing the formatting of the original file, using parse5 to find out the location of body and head tags and string concatenation in the original code to do the actual injection. In case of incomplete or invalid HTML it may fall back parse5 to generate a valid document and inject using AST manipulation.

import { prependToDocument, appendToDocument } from '@web/parse5-utils';

const html = '<html><body></body></html>';
const htmlWithInjectedScript = appendToDocument(
  html,
  '<scrip type="module" src="./injected-script.js"></script>',
);

Available functions

createDocument
createDocumentFragment
createElement
createScript
createCommentNode
appendChild
insertBefore
setTemplateContent
getTemplateContent
setDocumentType
setDocumentMode
getDocumentMode
detachNode
insertText
insertTextBefore
adoptAttributes
getFirstChild
getChildNodes
getParentNode
getAttrList
getTagName
getNamespaceURI
getTextNodeContent
getCommentNodeContent
getDocumentTypeNodeName
getDocumentTypeNodePublicId
getDocumentTypeNodeSystemId
isTextNode
isCommentNode
isDocumentTypeNode
isElementNode
setNodeSourceCodeLocation
getNodeSourceCodeLocation
updateNodeSourceCodeLocation
isHtmlFragment
hasAttribute
getAttribute
getAttributes
setAttribute
setAttributes
setTextContent
getTextContent
removeAttribute
remove
findNode
findNodes
findElement
findElements
prependToDocument
appendToDocument

Keywords

FAQs

What is @web/parse5-utils?

Is @web/parse5-utils popular?

Is @web/parse5-utils well maintained?

Package last updated on 04 Apr 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install