parse5 3.0.3 → 5.1.0

package/README.md

@@ -4,31 +4,29 @@
     </a>
 </p>
 
-<p align="center">
-<i>HTML parsing/serialization toolset for Node.js. <a href="https://html.spec.whatwg.org/multipage/">WHATWG HTML Living Standard (aka HTML5)</a>-compliant.</i>
-</p>
+<div align="center">
+<h1>parse5</h1>
+<i><b>HTML parser and serializer.</b></i>
+</div>
+<br>
 
-<p align="center">
-  <a href="https://travis-ci.org/inikulin/parse5"><img alt="Build Status" src="https://api.travis-ci.org/inikulin/parse5.svg"></a>
-  <a href="https://www.npmjs.com/package/parse5"><img alt="NPM Version" src="https://img.shields.io/npm/v/parse5.svg"></a>
-  <a href="https://npmjs.org/package/parse5"><img alt="Downloads" src="http://img.shields.io/npm/dm/parse5.svg"></a>
-  <a href="https://npmjs.org/package/parse5"><img alt="Downloads total" src="http://img.shields.io/npm/dt/parse5.svg"></a>
-</p>
+<div align="center">
+<code>npm install --save parse5</code>
+</div>
+<br>
 
 <p align="center">
-<b><i>parse5</i></b> provides nearly everything you may need when dealing with HTML. It's the fastest spec-compliant HTML parser
-for Node to date. It parses HTML the way the latest version of your browser does. It has proven itself reliable in such projects
-as <a href="https://github.com/tmpvar/jsdom">jsdom</a>, <a href="https://github.com/angular/angular">Angular2</a>, <a href="https://www.polymer-project.org">Polymer</a> and many more.
+  📖 <a href="https://github.com/inikulin/parse5/tree/master/packages/parse5/docs/index.md"><b>Documentation</b></a> 📖
 </p>
 
-----
+---
 
 <p align="center">
-  <a href="http://inikulin.github.io/parse5">Documentation</a>
+  <a href="https://github.com/inikulin/parse5/tree/master/docs/list-of-packages.md">List of parse5 toolset packages</a>
 </p>
 
 <p align="center">
-  <a href="http://inikulin.github.io/parse5#version-history">Version history</a>
+    <a href="https://github.com/inikulin/parse5">GitHub</a>
 </p>
 
 <p align="center">
@@ -36,5 +34,5 @@ as <a href="https://github.com/tmpvar/jsdom">jsdom</a>, <a href="https://github.
 </p>
 
 <p align="center">
-  <a href="https://github.com/inikulin/parse5/issues">Issue tracker</a>
+    <a href="https://github.com/inikulin/parse5/tree/master/docs/version-history.md">Version history</a>
 </p>

package/lib/common/doctype.js

@@ -1,156 +1,173 @@
 'use strict';
 
-var DOCUMENT_MODE = require('./html').DOCUMENT_MODE;
+const { DOCUMENT_MODE } = require('./html');
 
 //Const
-var VALID_DOCTYPE_NAME = 'html',
-    QUIRKS_MODE_SYSTEM_ID = 'http://www.ibm.com/data/dtd/v11/ibmxhtml1-transitional.dtd',
-    QUIRKS_MODE_PUBLIC_ID_PREFIXES = [
-        '+//silmaril//dtd html pro v0r11 19970101//en',
-        '-//advasoft ltd//dtd html 3.0 aswedit + extensions//en',
-        '-//as//dtd html 3.0 aswedit + extensions//en',
-        '-//ietf//dtd html 2.0 level 1//en',
-        '-//ietf//dtd html 2.0 level 2//en',
-        '-//ietf//dtd html 2.0 strict level 1//en',
-        '-//ietf//dtd html 2.0 strict level 2//en',
-        '-//ietf//dtd html 2.0 strict//en',
-        '-//ietf//dtd html 2.0//en',
-        '-//ietf//dtd html 2.1e//en',
-        '-//ietf//dtd html 3.0//en',
-        '-//ietf//dtd html 3.0//en//',
-        '-//ietf//dtd html 3.2 final//en',
-        '-//ietf//dtd html 3.2//en',
-        '-//ietf//dtd html 3//en',
-        '-//ietf//dtd html level 0//en',
-        '-//ietf//dtd html level 0//en//2.0',
-        '-//ietf//dtd html level 1//en',
-        '-//ietf//dtd html level 1//en//2.0',
-        '-//ietf//dtd html level 2//en',
-        '-//ietf//dtd html level 2//en//2.0',
-        '-//ietf//dtd html level 3//en',
-        '-//ietf//dtd html level 3//en//3.0',
-        '-//ietf//dtd html strict level 0//en',
-        '-//ietf//dtd html strict level 0//en//2.0',
-        '-//ietf//dtd html strict level 1//en',
-        '-//ietf//dtd html strict level 1//en//2.0',
-        '-//ietf//dtd html strict level 2//en',
-        '-//ietf//dtd html strict level 2//en//2.0',
-        '-//ietf//dtd html strict level 3//en',
-        '-//ietf//dtd html strict level 3//en//3.0',
-        '-//ietf//dtd html strict//en',
-        '-//ietf//dtd html strict//en//2.0',
-        '-//ietf//dtd html strict//en//3.0',
-        '-//ietf//dtd html//en',
-        '-//ietf//dtd html//en//2.0',
-        '-//ietf//dtd html//en//3.0',
-        '-//metrius//dtd metrius presentational//en',
-        '-//microsoft//dtd internet explorer 2.0 html strict//en',
-        '-//microsoft//dtd internet explorer 2.0 html//en',
-        '-//microsoft//dtd internet explorer 2.0 tables//en',
-        '-//microsoft//dtd internet explorer 3.0 html strict//en',
-        '-//microsoft//dtd internet explorer 3.0 html//en',
-        '-//microsoft//dtd internet explorer 3.0 tables//en',
-        '-//netscape comm. corp.//dtd html//en',
-        '-//netscape comm. corp.//dtd strict html//en',
-        '-//o\'reilly and associates//dtd html 2.0//en',
-        '-//o\'reilly and associates//dtd html extended 1.0//en',
-        '-//spyglass//dtd html 2.0 extended//en',
-        '-//sq//dtd html 2.0 hotmetal + extensions//en',
-        '-//sun microsystems corp.//dtd hotjava html//en',
-        '-//sun microsystems corp.//dtd hotjava strict html//en',
-        '-//w3c//dtd html 3 1995-03-24//en',
-        '-//w3c//dtd html 3.2 draft//en',
-        '-//w3c//dtd html 3.2 final//en',
-        '-//w3c//dtd html 3.2//en',
-        '-//w3c//dtd html 3.2s draft//en',
-        '-//w3c//dtd html 4.0 frameset//en',
-        '-//w3c//dtd html 4.0 transitional//en',
-        '-//w3c//dtd html experimental 19960712//en',
-        '-//w3c//dtd html experimental 970421//en',
-        '-//w3c//dtd w3 html//en',
-        '-//w3o//dtd w3 html 3.0//en',
-        '-//w3o//dtd w3 html 3.0//en//',
-        '-//webtechs//dtd mozilla html 2.0//en',
-        '-//webtechs//dtd mozilla html//en'
-    ],
-    QUIRKS_MODE_NO_SYSTEM_ID_PUBLIC_ID_PREFIXES = QUIRKS_MODE_PUBLIC_ID_PREFIXES.concat([
-        '-//w3c//dtd html 4.01 frameset//',
-        '-//w3c//dtd html 4.01 transitional//'
-    ]),
-    QUIRKS_MODE_PUBLIC_IDS = [
-        '-//w3o//dtd w3 html strict 3.0//en//',
-        '-/w3c/dtd html 4.0 transitional/en',
-        'html'
-    ],
-    LIMITED_QUIRKS_PUBLIC_ID_PREFIXES = [
-        '-//W3C//DTD XHTML 1.0 Frameset//',
-        '-//W3C//DTD XHTML 1.0 Transitional//'
-    ],
-    LIMITED_QUIRKS_WITH_SYSTEM_ID_PUBLIC_ID_PREFIXES = LIMITED_QUIRKS_PUBLIC_ID_PREFIXES.concat([
-        '-//W3C//DTD HTML 4.01 Frameset//',
-        '-//W3C//DTD HTML 4.01 Transitional//'
-    ]);
-
+const VALID_DOCTYPE_NAME = 'html';
+const VALID_SYSTEM_ID = 'about:legacy-compat';
+const QUIRKS_MODE_SYSTEM_ID = 'http://www.ibm.com/data/dtd/v11/ibmxhtml1-transitional.dtd';
+
+const QUIRKS_MODE_PUBLIC_ID_PREFIXES = [
+    '+//silmaril//dtd html pro v0r11 19970101//en',
+    '-//advasoft ltd//dtd html 3.0 aswedit + extensions//en',
+    '-//as//dtd html 3.0 aswedit + extensions//en',
+    '-//ietf//dtd html 2.0 level 1//en',
+    '-//ietf//dtd html 2.0 level 2//en',
+    '-//ietf//dtd html 2.0 strict level 1//en',
+    '-//ietf//dtd html 2.0 strict level 2//en',
+    '-//ietf//dtd html 2.0 strict//en',
+    '-//ietf//dtd html 2.0//en',
+    '-//ietf//dtd html 2.1e//en',
+    '-//ietf//dtd html 3.0//en',
+    '-//ietf//dtd html 3.0//en//',
+    '-//ietf//dtd html 3.2 final//en',
+    '-//ietf//dtd html 3.2//en',
+    '-//ietf//dtd html 3//en',
+    '-//ietf//dtd html level 0//en',
+    '-//ietf//dtd html level 0//en//2.0',
+    '-//ietf//dtd html level 1//en',
+    '-//ietf//dtd html level 1//en//2.0',
+    '-//ietf//dtd html level 2//en',
+    '-//ietf//dtd html level 2//en//2.0',
+    '-//ietf//dtd html level 3//en',
+    '-//ietf//dtd html level 3//en//3.0',
+    '-//ietf//dtd html strict level 0//en',
+    '-//ietf//dtd html strict level 0//en//2.0',
+    '-//ietf//dtd html strict level 1//en',
+    '-//ietf//dtd html strict level 1//en//2.0',
+    '-//ietf//dtd html strict level 2//en',
+    '-//ietf//dtd html strict level 2//en//2.0',
+    '-//ietf//dtd html strict level 3//en',
+    '-//ietf//dtd html strict level 3//en//3.0',
+    '-//ietf//dtd html strict//en',
+    '-//ietf//dtd html strict//en//2.0',
+    '-//ietf//dtd html strict//en//3.0',
+    '-//ietf//dtd html//en',
+    '-//ietf//dtd html//en//2.0',
+    '-//ietf//dtd html//en//3.0',
+    '-//metrius//dtd metrius presentational//en',
+    '-//microsoft//dtd internet explorer 2.0 html strict//en',
+    '-//microsoft//dtd internet explorer 2.0 html//en',
+    '-//microsoft//dtd internet explorer 2.0 tables//en',
+    '-//microsoft//dtd internet explorer 3.0 html strict//en',
+    '-//microsoft//dtd internet explorer 3.0 html//en',
+    '-//microsoft//dtd internet explorer 3.0 tables//en',
+    '-//netscape comm. corp.//dtd html//en',
+    '-//netscape comm. corp.//dtd strict html//en',
+    "-//o'reilly and associates//dtd html 2.0//en",
+    "-//o'reilly and associates//dtd html extended 1.0//en",
+    '-//spyglass//dtd html 2.0 extended//en',
+    '-//sq//dtd html 2.0 hotmetal + extensions//en',
+    '-//sun microsystems corp.//dtd hotjava html//en',
+    '-//sun microsystems corp.//dtd hotjava strict html//en',
+    '-//w3c//dtd html 3 1995-03-24//en',
+    '-//w3c//dtd html 3.2 draft//en',
+    '-//w3c//dtd html 3.2 final//en',
+    '-//w3c//dtd html 3.2//en',
+    '-//w3c//dtd html 3.2s draft//en',
+    '-//w3c//dtd html 4.0 frameset//en',
+    '-//w3c//dtd html 4.0 transitional//en',
+    '-//w3c//dtd html experimental 19960712//en',
+    '-//w3c//dtd html experimental 970421//en',
+    '-//w3c//dtd w3 html//en',
+    '-//w3o//dtd w3 html 3.0//en',
+    '-//w3o//dtd w3 html 3.0//en//',
+    '-//webtechs//dtd mozilla html 2.0//en',
+    '-//webtechs//dtd mozilla html//en'
+];
+
+const QUIRKS_MODE_NO_SYSTEM_ID_PUBLIC_ID_PREFIXES = QUIRKS_MODE_PUBLIC_ID_PREFIXES.concat([
+    '-//w3c//dtd html 4.01 frameset//',
+    '-//w3c//dtd html 4.01 transitional//'
+]);
+
+const QUIRKS_MODE_PUBLIC_IDS = ['-//w3o//dtd w3 html strict 3.0//en//', '-/w3c/dtd html 4.0 transitional/en', 'html'];
+const LIMITED_QUIRKS_PUBLIC_ID_PREFIXES = ['-//W3C//DTD XHTML 1.0 Frameset//', '-//W3C//DTD XHTML 1.0 Transitional//'];
+
+const LIMITED_QUIRKS_WITH_SYSTEM_ID_PUBLIC_ID_PREFIXES = LIMITED_QUIRKS_PUBLIC_ID_PREFIXES.concat([
+    '-//W3C//DTD HTML 4.01 Frameset//',
+    '-//W3C//DTD HTML 4.01 Transitional//'
+]);
 
 //Utils
 function enquoteDoctypeId(id) {
-    var quote = id.indexOf('"') !== -1 ? '\'' : '"';
+    const quote = id.indexOf('"') !== -1 ? "'" : '"';
 
     return quote + id + quote;
 }
 
 function hasPrefix(publicId, prefixes) {
-    for (var i = 0; i < prefixes.length; i++) {
-        if (publicId.indexOf(prefixes[i]) === 0)
+    for (let i = 0; i < prefixes.length; i++) {
+        if (publicId.indexOf(prefixes[i]) === 0) {
             return true;
+        }
     }
 
     return false;
 }
 
-
 //API
-exports.getDocumentMode = function (name, publicId, systemId) {
-    if (name !== VALID_DOCTYPE_NAME)
+exports.isConforming = function(token) {
+    return (
+        token.name === VALID_DOCTYPE_NAME &&
+        token.publicId === null &&
+        (token.systemId === null || token.systemId === VALID_SYSTEM_ID)
+    );
+};
+
+exports.getDocumentMode = function(token) {
+    if (token.name !== VALID_DOCTYPE_NAME) {
         return DOCUMENT_MODE.QUIRKS;
+    }
+
+    const systemId = token.systemId;
 
-    if (systemId && systemId.toLowerCase() === QUIRKS_MODE_SYSTEM_ID)
+    if (systemId && systemId.toLowerCase() === QUIRKS_MODE_SYSTEM_ID) {
         return DOCUMENT_MODE.QUIRKS;
+    }
+
+    let publicId = token.publicId;
 
     if (publicId !== null) {
         publicId = publicId.toLowerCase();
 
-        if (QUIRKS_MODE_PUBLIC_IDS.indexOf(publicId) > -1)
+        if (QUIRKS_MODE_PUBLIC_IDS.indexOf(publicId) > -1) {
             return DOCUMENT_MODE.QUIRKS;
+        }
 
-        var prefixes = systemId === null ? QUIRKS_MODE_NO_SYSTEM_ID_PUBLIC_ID_PREFIXES : QUIRKS_MODE_PUBLIC_ID_PREFIXES;
+        let prefixes = systemId === null ? QUIRKS_MODE_NO_SYSTEM_ID_PUBLIC_ID_PREFIXES : QUIRKS_MODE_PUBLIC_ID_PREFIXES;
 
-        if (hasPrefix(publicId, prefixes))
+        if (hasPrefix(publicId, prefixes)) {
             return DOCUMENT_MODE.QUIRKS;
+        }
 
-        prefixes = systemId === null ? LIMITED_QUIRKS_PUBLIC_ID_PREFIXES : LIMITED_QUIRKS_WITH_SYSTEM_ID_PUBLIC_ID_PREFIXES;
+        prefixes =
+            systemId === null ? LIMITED_QUIRKS_PUBLIC_ID_PREFIXES : LIMITED_QUIRKS_WITH_SYSTEM_ID_PUBLIC_ID_PREFIXES;
 
-        if (hasPrefix(publicId, prefixes))
+        if (hasPrefix(publicId, prefixes)) {
             return DOCUMENT_MODE.LIMITED_QUIRKS;
+        }
     }
 
     return DOCUMENT_MODE.NO_QUIRKS;
 };
 
-exports.serializeContent = function (name, publicId, systemId) {
-    var str = '!DOCTYPE ';
+exports.serializeContent = function(name, publicId, systemId) {
+    let str = '!DOCTYPE ';
 
-    if (name)
+    if (name) {
         str += name;
+    }
 
-    if (publicId !== null)
+    if (publicId) {
         str += ' PUBLIC ' + enquoteDoctypeId(publicId);
-
-    else if (systemId !== null)
+    } else if (systemId) {
         str += ' SYSTEM';
+    }
 
-    if (systemId !== null)
+    if (systemId !== null) {
         str += ' ' + enquoteDoctypeId(systemId);
+    }
 
     return str;
 };

package/lib/common/error-codes.js

@@ -0,0 +1,65 @@
+'use strict';
+
+module.exports = {
+    controlCharacterInInputStream: 'control-character-in-input-stream',
+    noncharacterInInputStream: 'noncharacter-in-input-stream',
+    surrogateInInputStream: 'surrogate-in-input-stream',
+    nonVoidHtmlElementStartTagWithTrailingSolidus: 'non-void-html-element-start-tag-with-trailing-solidus',
+    endTagWithAttributes: 'end-tag-with-attributes',
+    endTagWithTrailingSolidus: 'end-tag-with-trailing-solidus',
+    unexpectedSolidusInTag: 'unexpected-solidus-in-tag',
+    unexpectedNullCharacter: 'unexpected-null-character',
+    unexpectedQuestionMarkInsteadOfTagName: 'unexpected-question-mark-instead-of-tag-name',
+    invalidFirstCharacterOfTagName: 'invalid-first-character-of-tag-name',
+    unexpectedEqualsSignBeforeAttributeName: 'unexpected-equals-sign-before-attribute-name',
+    missingEndTagName: 'missing-end-tag-name',
+    unexpectedCharacterInAttributeName: 'unexpected-character-in-attribute-name',
+    unknownNamedCharacterReference: 'unknown-named-character-reference',
+    missingSemicolonAfterCharacterReference: 'missing-semicolon-after-character-reference',
+    unexpectedCharacterAfterDoctypeSystemIdentifier: 'unexpected-character-after-doctype-system-identifier',
+    unexpectedCharacterInUnquotedAttributeValue: 'unexpected-character-in-unquoted-attribute-value',
+    eofBeforeTagName: 'eof-before-tag-name',
+    eofInTag: 'eof-in-tag',
+    missingAttributeValue: 'missing-attribute-value',
+    missingWhitespaceBetweenAttributes: 'missing-whitespace-between-attributes',
+    missingWhitespaceAfterDoctypePublicKeyword: 'missing-whitespace-after-doctype-public-keyword',
+    missingWhitespaceBetweenDoctypePublicAndSystemIdentifiers:
+        'missing-whitespace-between-doctype-public-and-system-identifiers',
+    missingWhitespaceAfterDoctypeSystemKeyword: 'missing-whitespace-after-doctype-system-keyword',
+    missingQuoteBeforeDoctypePublicIdentifier: 'missing-quote-before-doctype-public-identifier',
+    missingQuoteBeforeDoctypeSystemIdentifier: 'missing-quote-before-doctype-system-identifier',
+    missingDoctypePublicIdentifier: 'missing-doctype-public-identifier',
+    missingDoctypeSystemIdentifier: 'missing-doctype-system-identifier',
+    abruptDoctypePublicIdentifier: 'abrupt-doctype-public-identifier',
+    abruptDoctypeSystemIdentifier: 'abrupt-doctype-system-identifier',
+    cdataInHtmlContent: 'cdata-in-html-content',
+    incorrectlyOpenedComment: 'incorrectly-opened-comment',
+    eofInScriptHtmlCommentLikeText: 'eof-in-script-html-comment-like-text',
+    eofInDoctype: 'eof-in-doctype',
+    nestedComment: 'nested-comment',
+    abruptClosingOfEmptyComment: 'abrupt-closing-of-empty-comment',
+    eofInComment: 'eof-in-comment',
+    incorrectlyClosedComment: 'incorrectly-closed-comment',
+    eofInCdata: 'eof-in-cdata',
+    absenceOfDigitsInNumericCharacterReference: 'absence-of-digits-in-numeric-character-reference',
+    nullCharacterReference: 'null-character-reference',
+    surrogateCharacterReference: 'surrogate-character-reference',
+    characterReferenceOutsideUnicodeRange: 'character-reference-outside-unicode-range',
+    controlCharacterReference: 'control-character-reference',
+    noncharacterCharacterReference: 'noncharacter-character-reference',
+    missingWhitespaceBeforeDoctypeName: 'missing-whitespace-before-doctype-name',
+    missingDoctypeName: 'missing-doctype-name',
+    invalidCharacterSequenceAfterDoctypeName: 'invalid-character-sequence-after-doctype-name',
+    duplicateAttribute: 'duplicate-attribute',
+    nonConformingDoctype: 'non-conforming-doctype',
+    missingDoctype: 'missing-doctype',
+    misplacedDoctype: 'misplaced-doctype',
+    endTagWithoutMatchingOpenElement: 'end-tag-without-matching-open-element',
+    closingOfElementWithOpenChildElements: 'closing-of-element-with-open-child-elements',
+    disallowedContentInNoscriptInHead: 'disallowed-content-in-noscript-in-head',
+    openElementsLeftAfterEof: 'open-elements-left-after-eof',
+    abandonedHeadElementChild: 'abandoned-head-element-child',
+    misplacedStartTagForHeadElement: 'misplaced-start-tag-for-head-element',
+    nestedNoscriptInHead: 'nested-noscript-in-head',
+    eofInElementThatCanContainOnlyText: 'eof-in-element-that-can-contain-only-text'
+};