Splunk_Docker

History

Brett Woodruff 28c8d411ad Inital Commit		5 months ago
..
lib	Inital Commit	5 months ago
LICENSE	Inital Commit	5 months ago
README.md	Inital Commit	5 months ago
index.js	Inital Commit	5 months ago
package.json	Inital Commit	5 months ago

README.md

WHATWG HTML5 specification-compliant, fast and ready for production HTML parsing/serialization toolset for Node.

To build TestCafé we needed fast and ready for production HTML parser, which will parse HTML as a modern browser's parser. Existing solutions were either too slow or their output was too inaccurate. So, this is how parse5 was born.

Included tools:

Parser - HTML to DOM-tree parser.
SimpleApiParser - SAX-style parser for HTML.
TreeSerializer - DOM-tree to HTML serializer.

##Install

$ npm install parse5

##Usage

var Parser = require('parse5').Parser;

//Instantiate parser
var parser = new Parser();

//Then feed it with an HTML document
var document = parser.parse('<!DOCTYPE html><html><head></head><body>Hi there!</body></html>')

//Now let's parse HTML-snippet
var fragment = parser.parseFragment('<title>Parse5 is &#102;&#117;&#99;&#107;ing awesome!</title><h1>42</h1>');

##Is it fast? Check out this benchmark.

Starting benchmark. Fasten your seatbelts...
html5 (https://github.com/aredridel/html5) x 0.18 ops/sec ±5.92% (5 runs sampled)
htmlparser (https://github.com/tautologistics/node-htmlparser/) x 3.83 ops/sec ±42.43% (14 runs sampled)
htmlparser2 (https://github.com/fb55/htmlparser2) x 4.05 ops/sec ±39.27% (15 runs sampled)
parse5 (https://github.com/inikulin/parse5) x 3.04 ops/sec ±51.81% (13 runs sampled)
Fastest is htmlparser2 (https://github.com/fb55/htmlparser2),parse5 (https://github.com/inikulin/parse5)

So, parse5 is as fast as simple specification incompatible parsers and ~15-times(!) faster than the current specification compatible parser available for the node.

##API reference

###Enum: TreeAdapters Provides built-in tree adapters which can be passed as an optional argument to the Parser and TreeSerializer constructors.

####• TreeAdapters.default Default tree format for parse5.

####• TreeAdapters.htmlparser2 Quite popular htmlparser2 tree format (e.g. used in cheerio and jsdom).

###Class: Parser Provides HTML parsing functionality.

####• Parser.ctor([treeAdapter]) Creates new reusable instance of the Parser. Optional treeAdapter argument specifies resulting tree format. If treeAdapter argument is not specified, default tree adapter will be used.

Example:

var parse5 = require('parse5');

//Instantiate new parser with default tree adapter
var parser1 = new parse5.Parser();

//Instantiate new parser with htmlparser2 tree adapter
var parser2 = new parse5.Parser(parse5.TreeAdapters.htmlparser2);

####• Parser.parse(html) Parses specified html string. Returns document node.

Example:

var document = parser.parse('<!DOCTYPE html><html><head></head><body>Hi there!</body></html>');

####• Parser.parseFragment(htmlFragment, [contextElement]) Parses given htmlFragment. Returns documentFragment node. Optional contextElement argument specifies context in which given htmlFragment will be parsed (consider it as setting contextElement.innerHTML property). If contextElement argument is not specified, <div> element will be used.

Example:

var documentFragment = parser.parseFragment('<table></table>');

//Parse html fragment in context of the parsed <table> element
var trFragment = parser.parseFragment('<tr><td>Shake it, baby</td></tr>', documentFragment.childNodes[0]);

###Class: SimpleApiParser Provides SAX-style HTML parsing functionality.

####• SimpleApiParser.ctor(handlers) Creates new reusable instance of the SimpleApiParser. handlers argument specifies object that contains parser's event handlers. Possible events and their signatures are shown in the example.

Example:

var parse5 = require('parse5');

var parser = new parse5.SimpleApiParser({
    doctype: function(name, publicId, systemId) {
        //Handle doctype here
    },

    startTag: function(tagName, attrs, selfClosing) {
        //Handle start tags here
    },

    endTag: function(tagName) {
        //Handle end tags here
    },

    text: function(text) {
        //Handle texts here
    },

    comment: function(text) {
        //Handle comments here
    }
});

####• SimpleApiParser.parse(html) Raises parser events for the given html.

Example:

var parse5 = require('parse5');

var parser = new parse5.SimpleApiParser({
    text: function(text) {
        console.log(text);
    }
});

parser.parse('<body>Yo!</body>');

###Class: TreeSerializer Provides tree-to-HTML serialization functionality.

####• TreeSerializer.ctor([treeAdapter]) Creates new reusable instance of the TreeSerializer. Optional treeAdapter argument specifies input tree format. If treeAdapter argument is not specified, default tree adapter will be used.

Example:

var parse5 = require('parse5');

//Instantiate new serializer with default tree adapter
var serializer1 = new parse5.TreeSerializer();

//Instantiate new serializer with htmlparser2 tree adapter
var serializer2 = new parse5.TreeSerializer(parse5.TreeAdapters.htmlparser2);

####• TreeSerializer.serialize(node) Serializes the given node. Returns HTML string.

Example:

var document = parser.parse('<!DOCTYPE html><html><head></head><body>Hi there!</body></html>');

//Serialize document
var html = serializer.serialize(document);

//Serialize <body> element content
var bodyInnerHtml = serializer.serialize(document.childNodes[0].childNodes[1]);

##Testing Test data is adopted from html5lib project. Parser is covered by more than 8000 test cases. To run tests:

$ npm test

##Custom tree adapter You can create a custom tree adapter so parse5 can work with your own DOM-tree implementation. Just pass your adapter implementation to the parser's constructor as an argument:

var Parser = require('parse5').Parser;

var myTreeAdapter = {
   //Adapter methods...
};

//Instantiate parser
var parser = new Parser(myTreeAdapter);

Sample implementation can be found here. The custom tree adapter should implement all methods exposed via exports in the sample implementation.

##Questions or suggestions? If you have any questions, please feel free to create an issue here on github.

##Author Ivan Nikulin (ifaaan@gmail.com)