Neovictorian Paisley Menswear

    hast-util-from-parse5
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.1 • Public • Published

    hast-util-from-parse5

    Build Coverage Downloads Size Sponsors Backers Chat

    hast utility to transform Parse5’s AST to a hast tree.

    Install

    npm:

    npm install hast-util-from-parse5

    Usage

    Say we have the following file, example.html:

    <!doctype html><title>Hello!</title><h1 id="world">World!<!--after-->

    And our script, example.js, looks as follows:

    var vfile = require('to-vfile')
    var parse5 = require('parse5')
    var inspect = require('unist-util-inspect')
    var fromParse5 = require('hast-util-from-parse5')
     
    var doc = vfile.readSync('example.html')
    var ast = parse5.parse(String(doc), {sourceCodeLocationInfo: true})
    var hast = fromParse5(ast, doc)
     
    console.log(inspect(hast))

    Now, running node example yields:

    root[2] (1:1-2:1, 0-70) [data={"quirksMode":false}]
    ├─ doctype (1:1-1:16, 0-15) [name="html"]
    └─ element[2] [tagName="html"]
       ├─ element[1] [tagName="head"]
       │  └─ element[1] (1:16-1:37, 15-36) [tagName="title"]
       │     └─ text: "Hello!" (1:23-1:29, 22-28)
       └─ element[1] [tagName="body"]
          └─ element[3] (1:37-2:1, 36-70) [tagName="h1"][properties={"id":"world"}]
             ├─ text: "World!" (1:52-1:58, 51-57)
             ├─ comment: "after" (1:58-1:70, 57-69)
             └─ text: "\n" (1:70-2:1, 69-70)

    API

    fromParse5(ast[, options])

    Transform Parse5’s AST to a hast tree.

    options

    If options is a VFile, it’s treated as {file: options}.

    options.space

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

    If an element in with the SVG namespace is found in ast, fromParse5 automatically switches to the SVG space when entering the element, and switches back when leaving.

    options.file

    VFile, used to add positional information to nodes. If given, the file should have the original HTML source as its contents.

    options.verbose

    Whether to add extra positional information about starting tags, closing tags, and attributes to elements (boolean, default: false). Note: not used without file.

    For the following HTML:

    <img src="http://example.com/fav.ico" alt="foo" title="bar">

    The verbose info would looks as follows:

    {
      type: 'element',
      tagName: 'img',
      properties: {src: 'http://example.com/fav.ico', alt: 'foo', title: 'bar'},
      children: [],
      data: {
        position: {
          opening: {
            start: {line: 1, column: 1, offset: 0},
            end: {line: 1, column: 61, offset: 60}
          },
          closing: null,
          properties: {
            src: {
              start: {line: 1, column: 6, offset: 5},
              end: {line: 1, column: 38, offset: 37}
            },
            alt: {
              start: {line: 1, column: 39, offset: 38},
              end: {line: 1, column: 48, offset: 47}
            },
            title: {
              start: {line: 1, column: 49, offset: 48},
              end: {line: 1, column: 60, offset: 59}
            }
          }
        }
      },
      position: {
        start: {line: 1, column: 1, offset: 0},
        end: {line: 1, column: 61, offset: 60}
      }
    }

    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, organisation, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i hast-util-from-parse5@5.0.1

    Version

    5.0.1

    License

    MIT

    Unpacked Size

    13.8 kB

    Total Files

    4

    Last publish

    Collaborators

    • wooorm
    • kmck