Have ideas to improve npm?Join in the discussion! »

    @starptech/webparser
    TypeScript icon, indicating that this package has built-in type declarations

    0.10.0 • Public • Published

    @starptech/webparser

    Optimized html parser for HTML5 Web Components. The parser supports features which are very useful if you want to implement a HTML formatter or anything else where a less strict parser is needed to keep all informations in the ast.

    Installation

    npm install --save @starptech/webparser
    

    Usage

    This example shows how we parse HTML

    const parser = new HtmlParser(options)
    const result = parser.parse('<div></div>')

    Representation

    There are four different types of nodes

    • Doctype
    {
      value: '<!doctype html>',
      sourceSpan: null
    }
    • Element
    {
      name: 'div',
      attrs: [],
      children: [],
      implicitNs: false,
      sourceSpan: null,
      startSourceSpan: null,
      endSourceSpan
    }

    Void or self-closing elements can be checked when the startSourceSpan is equals the endSourceSpan.

    • Attribute
    {
      name: 'div',
      value: 'foo',
      children: [],
      implicitNs: false,
      sourceSpan:null,
      valueSpan: null
    }
    • Comment
    {
      value: 'foo comment',
      sourceSpan: null
    }

    API

    HtmlParser.parse(doc: string): ParseTreeResult

    Parse a document and returns a ParseTreeResult result.

    options.decodeEntities (enabled by default)

    Decode html entities in text and attributes according to HTML5 specification.

    options.ignoreFirstLf (enabled by default)

    Ignore first line feed of pre, textarea and listing tags according to HTML5 specification.

    options.selfClosingCustomElements (disabled by default)

    Allow custom self-closing elements.

    options.selfClosingElements (disabled by default)

    Allow custom and known self closing HTML elements.

    options.insertRequiredParents (disabled by default)

    Insert the required parent element according to the HTML5 specification.

    Credits

    The parser is a modificated version of Angular 6 template parser.

    Install

    npm i @starptech/webparser

    DownloadsWeekly Downloads

    11,346

    Version

    0.10.0

    License

    MIT

    Unpacked Size

    175 kB

    Total Files

    48

    Last publish

    Collaborators

    • avatar