Skip to content

syntax-tree/hast-util-to-parse5

main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

hast-util-to-parse5

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to generate parse5s AST.

Contents

What is this?

This package is a utility that can turn a hast syntax tree into parse5s AST. Why not use a Parse5 adapter, you might ask? Well, because it’s more code weight to use adapters, and more fragile.

When should I use this?

This package is useful when working with parse5, and for some reason want to generate its AST again. The inverse utility, hast-util-from-parse5, is more likely what you want.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install hast-util-to-parse5

In Deno with esm.sh:

import {toParse5} from 'https://esm.sh/hast-util-to-parse5@7'

In browsers with esm.sh:

<script type="module">
  import {toParse5} from 'https://esm.sh/hast-util-to-parse5@7?bundle'
</script>

Use

import {toParse5} from 'hast-util-to-parse5'

const tree = toParse5({
  type: 'element',
  tagName: 'h1',
  properties: {},
  children: [{type: 'text', value: 'World!'}]
})

console.log(tree)

Yields:

{ nodeName: 'h1',
  tagName: 'h1',
  attrs: [],
  namespaceURI: 'http://www.w3.org/1999/xhtml',
  childNodes: [ { nodeName: '#text', value: 'World!', parentNode: [Circular] } ] }

API

This package exports the identifier toParse5. There is no default export.

toParse5(tree[, space])

hast utility to transform to parse5s ast.

space

Whether the root of the given tree is in the HTML or SVG space (enum, 'svg' or 'html', default: 'html').

If an svg element is found in the HTML space, toParse5 automatically switches to the SVG space when entering the element, and switches back when exiting.

Types

This package is fully typed with TypeScript. It exports the additional type Space.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

Use of hast-util-to-parse5 can open you up to a cross-site scripting (XSS) attack if the hast tree is unsafe.

Related

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer