unified

Project: syntax-tree/hast-util-to-parse5

Package: hast-util-to-parse5@6.0.0

  1. Dependencies: 5·Dependents: 1
  2. hast utility to transform hast to Parse5’s AST
  1. html 110
  2. unist 103
  3. util 98
  4. utility 96
  5. hast 60
  6. tree 42
  7. hast-util 40
  8. ast 29

hast-util-to-parse5

Build Coverage Downloads Size Sponsors Backers Chat

hast utility to transform to Parse5’s AST.

Q: Why not use a Parse5 adapter? A: Because it’s more code weight to use adapters, and much more fragile.

Install

npm:

npm install hast-util-to-parse5

Use

var toParse5 = require('hast-util-to-parse5')

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

console.log(ast)

Yields:

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

API

toParse5(tree[, space])

Transform a hast tree to Parse5’s 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.

Security

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

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