hast-util-raw
Advanced tools
Package description
The hast-util-raw package is a utility for working with HAST (Hypertext Abstract Syntax Tree) trees. It can parse and transform raw HTML into a HAST tree, allowing for manipulation and analysis of the structure of HTML documents. This package is particularly useful for developers working with virtual DOMs or needing to preprocess or clean HTML content programmatically.
Parsing HTML to HAST
This feature allows for the parsing of HTML strings embedded within HAST trees. The `raw` function takes a HAST tree that may contain raw HTML as part of its nodes and returns a new HAST tree with the raw HTML parsed into HAST nodes. This is useful for integrating unescaped HTML strings into a HAST-based workflow.
const raw = require('hast-util-raw');
const h = require('hastscript');
const tree = h('div', [h('span', 'Hello'), '<strong>world!</strong>']);
const result = raw(tree);Transforming HAST with embedded raw HTML
This demonstrates how `hast-util-raw` can transform a HAST tree that includes a 'raw' node containing HTML into a fully parsed HAST structure. This is particularly useful for scenarios where raw HTML is mixed with HAST content and a uniform HAST structure is needed for further processing.
const raw = require('hast-util-raw');
const u = require('unist-builder');
const tree = u('root', [u('element', {tagName: 'div'}, [u('text', 'Some text'), u('raw', '<span>More text</span>')])]);
const result = raw(tree);Similar to hast-util-raw, `rehype-parse` is used for parsing HTML into HAST. However, `rehype-parse` is more focused on being a full HTML parser as part of the rehype ecosystem, offering more comprehensive parsing options and better integration with rehype plugins.
This package also converts HTML into HAST trees, similar to what hast-util-raw offers. The main difference is that `html-to-hast` focuses solely on the conversion from HTML to HAST without the additional utility functions for manipulating HAST trees that hast-util-raw provides.
Readme
hast utility to parse the tree again, now supporting
embedded raw nodes.
One of the reasons to do this is for “malformed” syntax trees: for example, say
there’s an h1 element in a p element, this utility will make them siblings.
Another reason to do this is if raw HTML/XML is embedded in a syntax tree, which
can occur when coming from Markdown using mdast-util-to-hast.
If you’re working with remark and/or
remark-rehype, use rehype-raw instead.
npm:
npm install hast-util-raw
var h = require('hastscript')
var raw = require('hast-util-raw')
var tree = h('div', [h('h1', ['Foo ', h('h2', 'Bar'), ' Baz'])])
var clean = raw(tree)
console.log(clean)
Yields:
{ type: 'element',
tagName: 'div',
properties: {},
children:
[ { type: 'element',
tagName: 'h1',
properties: {},
children: [Object] },
{ type: 'element',
tagName: 'h2',
properties: {},
children: [Object] },
{ type: 'text', value: ' Baz' } ] }
raw(tree[, file])Given a hast tree and an optional vfile (for positional info), return a new parsed-again hast tree.
Use of hast-util-raw can open you up to a cross-site scripting (XSS)
attack as raw nodes are unsafe.
The following example shows how a raw node is used to inject a script that runs
when loaded in a browser.
raw(u('root', [u('raw', '<script>alert(1)</script>')]))
Yields:
<script>alert(1)</script>
Do not use this utility in combination with user input or use
hast-util-santize.
mdast-util-to-hast
— transform mdast to hastrehype-raw
— wrapper plugin for rehypeSee 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.
FAQs
hast utility to reparse a tree
The npm package hast-util-raw receives a total of 2,088,878 weekly downloads. As such, hast-util-raw popularity was classified as popular.
We found that hast-util-raw demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.