Repository files navigation

hast utility to parse the tree and semistandardraw nodes(strings of HTML) again,keeping positional info okay.

• What is this?
• When should I use this?
• Install
• Use
• API
  • Options
  • raw(tree, options)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a utility to parse a document again.It passes each node and embedded raw HTML through an HTML parser(parse5),to recreate a tree exactly as how a browser would parse it,while keeping the original data and positional info intact.

This utility is particularly useful when coming from markdown and wanting tosupport HTML embedded inside that markdown(which requires passingallowDangerousHtml: true tomdast-util-to-hast).Markdown dictates how,say,a list item or emphasis can be parsed.We can use that to turn the markdown syntax tree into an HTML syntax tree.But markdown also dictates that things that look like HTML,are passed through untouched,even when it just looks like XML but doesn’t really make sense,so we can’t normally use these strings of “HTML” to create an HTML syntax tree.This utility can.It can be used to take those strings of HTML and include them into the syntaxtree as actual nodes.

If your final result is HTML and you trust content,then “strings” are fine(you can passallowDangerousHtml: true tohast-util-to-html,which passes HTML through untouched).But there are two main cases where a proper syntax tree is preferred:

• hast utilities need a proper syntax tree as they operate on actual nodes toinspect or transform things,they can’t operate on strings of HTML
• other output formats(React, MDX, etc)need actual nodes and can’t handle strings of HTML

The pluginrehype-raw wraps this utility at ahigher-level (easier) abstraction.

This package isESM only.In Node.js (version 16+),install withnpm:

npm install hast-util-raw

In Deno withesm.sh:

import{raw}from'https://esm.sh/hast-util-raw@9'

In browsers withesm.sh:

<scripttype="module">import{raw}from'https://esm.sh/hast-util-raw@9?bundle'</script>

import{h}from'hastscript'import{raw}from'hast-util-raw'consttree=h('div',[h('h1',['Foo ',h('h2','Bar'),' Baz'])])constreformatted=raw(tree)console.log(reformatted)

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'}]}

Configuration.

• file? (VFile | null | undefined)— corresponding virtual file representing the input document (optional)

• passThrough? (Array<string> | null | undefined)

  List of custom hast node types to pass through (as in, keep) (optional).

  If the passed through nodes have children, those children are expected tobe hast again and will be handled.

• tagfilter? (boolean | null | undefined)

  Whether to disallow irregular tags inraw nodes according to GFMtagfilter(default:false).

  This affects the following tags,grouped by their kind:

  • RAWTEXT:iframe,noembed,noframes,style,xmp
  • RCDATA:textarea,title
  • SCRIPT_DATA:script
  • PLAINTEXT:plaintextWhen you know that you do not want authors to write these tags,you can enable this option to prevent their use from running amok.

  See:Disallowed Raw HTML incmark-gfm.

Pass a hast tree through an HTML parser,which will fix nesting,and turn raw nodes into actual nodes.

• tree (Root | RootContent)— original hast tree to transform
• options? (Options | null | undefined)— configuration (optional)

Parsed again tree (Root | RootContent).

This package is fully typed withTypeScript.It exports the additional typeOptions.

TheRaw node type is registered by and exposed frommdast-util-to-hast.

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release,we drop support for unmaintained versions of Node.This means we try to keep the current release line,hast-util-raw@9,compatible with Node.js 16.

Use ofhast-util-raw can open you up to across-site scripting (XSS)attack asraw nodes are unsafe.The following example shows how a raw node is used to inject a script that runswhen loaded in a browser.

raw({type:'root',children:[{type:'raw',value:'<script>alert(1)</script>'}]})

Yields:

<script>alert(1)</script>

Either do not use this utility in combination with user input,or usehast-util-santize.

• mdast-util-to-hast— transform mdast to hast
• rehype-raw— rehype plugin

Seecontributing.md insyntax-tree/.githubfor ways to get started.Seesupport.md for ways to get help.

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

MIT ©Titus Wormer