import * as html from '../src/ast' import { HtmlParser, TreeError } from '../src/html_parser' import { TokenType } from '../src/lexer' import { ParseError } from '../src/parse_util' import { humanizeDom, humanizeDomSourceSpans, humanizeLineColumn } from '../src/ast_spec_utils' // AST output is humanized to an array // [type, tagName | attrName | text, index, implicitNs] // for mor informations look in ast_spec_util.ts { describe('HtmlParser', () => { let parser: HtmlParser beforeEach(() => { parser = new HtmlParser() }) describe('parse', () => { describe('HTML5 doctype', () => { it('should parse doctype', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Doctype, 'doctype html', 0] ]) }) }) describe('vue', () => { it('should support colon and @ prefixed attributes', () => { expect( humanizeDom(parser.parse('
', 'TestComp')) ).toEqual([ [html.Element, 'div', 0], [html.Attribute, ':md-date.sync', ''], [html.Attribute, '@md-closed', 'toggleDialog'] ]) }) }) describe('interpolation', () => { it('should parse as text', () => { expect(humanizeDom(parser.parse('{{ foo }}', 'TestComp'))).toEqual([[html.Text, '{{ foo }}', 0]]) }) }) describe('LF no skip', () => { it('should not ignore LF immediately after textarea, pre and listing', () => { parser = new HtmlParser({ ignoreFirstLf: false }) expect( humanizeDom( parser.parse( '

\n

\n\n
\n\n', 'TestComp' ) ) ).toEqual([ [html.Element, 'p', 0], [html.Text, '\n', 1], [html.Element, 'textarea', 0], [html.Text, '\n', 1], [html.Element, 'pre', 0], [html.Text, '\n\n', 1], [html.Element, 'listing', 0], [html.Text, '\n\n', 1] ]) }) }) describe('Case sensitivity', () => { it('should parse attributes case sensitive', () => { parser = new HtmlParser({ ignoreFirstLf: false }) expect( humanizeDom( parser.parse( '', 'TestComp' ) ) ).toEqual([ [html.Element, 'SCRIPT', 0], [html.Attribute, 'src', 'https://www.google-analytics.com/analytics.js'], [html.Attribute, 'ASYNC', ''], [html.Attribute, 'DEFER', ''] ]) }) it('should parse tag case sensitive', () => { parser = new HtmlParser({ ignoreFirstLf: false }) expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'SCRIPT', 0] ]) }) it('should parse void elements case sensitive', () => { parser = new HtmlParser({ ignoreFirstLf: false, selfClosingElements: true }) expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([[html.Element, 'Input', 0]]) }) }) describe('Custom self-closing elements', () => { it('should be able to parse any custom element as self-closing tag', () => { const parser = new HtmlParser({ selfClosingCustomElements: true }) expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([[html.Element, 'custom', 0]]) }) }) describe('text nodes', () => { it('should parse root level text nodes', () => { expect(humanizeDom(parser.parse('a', 'TestComp'))).toEqual([[html.Text, 'a', 0]]) }) it('should parse text nodes inside regular elements', () => { expect(humanizeDom(parser.parse('
a
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Text, 'a', 1] ]) }) it('should parse text nodes inside elements', () => { expect(humanizeDom(parser.parse('a', 'TestComp'))).toEqual([ [html.Element, 'ng-template', 0], [html.Text, 'a', 1] ]) }) it('should parse CDATA', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([[html.Text, 'text', 0]]) }) }) describe('elements', () => { it('should parse root level elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([[html.Element, 'div', 0]]) }) it('should parse elements inside of regular elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Element, 'span', 1] ]) }) it('should parse elements inside elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'ng-template', 0], [html.Element, 'span', 1] ]) }) it('should support void elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'link', 0], [html.Attribute, 'rel', 'author license'], [html.Attribute, 'href', '/about'] ]) }) it('should parse image with closed tag in svg space', () => { expect( humanizeDom(parser.parse('', 'TestComp')) ).toEqual([ [html.Element, ':svg:svg', 0, true], [html.Element, ':svg:image', 1, true], [html.Attribute, 'src', 'http://image.de'] ]) }) it('should parse image as void element in html space', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'image', 0], [html.Attribute, 'src', 'http://image.de'] ]) }) it('should error when image is used with closed tag in html space', () => { const errors = parser.parse('', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ ['image', 'Void elements do not have end tags "image"', '0:29'] ]) }) it('should not error on void elements from HTML5 spec', () => { // http://www.w3.org/TR/html-markup/syntax.html#syntax-elements without: // - it can be present in head only // - it can be present in head only // - obsolete // - obsolete ;[ '', '

', '', '
', '

', '
', '
', '
', '/', '', '', '

' ].forEach(html => { expect(parser.parse(html, 'TestComp').errors).toEqual([]) }) }) it('should close void elements on text nodes', () => { expect(humanizeDom(parser.parse('

before
after

', 'TestComp'))).toEqual([ [html.Element, 'p', 0], [html.Text, 'before', 1], [html.Element, 'br', 1], [html.Text, 'after', 1] ]) }) it('should support optional end tags', () => { expect(humanizeDom(parser.parse('

1

2

', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Element, 'p', 1], [html.Text, '1', 2], [html.Element, 'p', 1], [html.Text, '2', 2] ]) }) it('should support nested elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'ul', 0], [html.Element, 'li', 1], [html.Element, 'ul', 2], [html.Element, 'li', 3] ]) }) // https://github.com/Prettyhtml/prettyhtml/issues/46 it('should not add the requiredParent by default', () => { parser = new HtmlParser() expect(humanizeDom(parser.parse(``, 'TestComp'))).toEqual([ [html.Element, 'draggable', 0], [html.Element, 'tr', 1], [html.Element, 'td', 2] ]) }) it('should add the requiredParent', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect( humanizeDom( parser.parse( '
', 'TestComp' ) ) ).toEqual([ [html.Element, 'table', 0], [html.Element, 'thead', 1], [html.Element, 'tr', 2], [html.Attribute, 'head', ''], [html.Element, 'tbody', 1], [html.Element, 'tr', 2], [html.Attribute, 'noparent', ''], [html.Element, 'tbody', 1], [html.Element, 'tr', 2], [html.Attribute, 'body', ''], [html.Element, 'tfoot', 1], [html.Element, 'tr', 2], [html.Attribute, 'foot', ''] ]) }) it('should append the required parent considering ng-container', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect( humanizeDom(parser.parse('
', 'TestComp')) ).toEqual([ [html.Element, 'table', 0], [html.Element, 'tbody', 1], [html.Element, 'ng-container', 2], [html.Element, 'tr', 3] ]) }) it('should append the required parent considering top level ng-container', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect( humanizeDom(parser.parse('

', 'TestComp')) ).toEqual([[html.Element, 'ng-container', 0], [html.Element, 'tr', 1], [html.Element, 'p', 0]]) }) it('should special case ng-container when adding a required parent', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect( humanizeDom( parser.parse('
', 'TestComp') ) ).toEqual([ [html.Element, 'table', 0], [html.Element, 'thead', 1], [html.Element, 'ng-container', 2], [html.Element, 'tr', 3] ]) }) it('should not add the requiredParent when the parent is a ', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'ng-template', 0], [html.Element, 'tr', 1] ]) }) // https://github.com/angular/angular/issues/5967 it('should not add the requiredParent to a template root element', () => { parser = new HtmlParser({ insertRequiredParents: true }) expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([[html.Element, 'tr', 0]]) }) it('should support explicit namespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':myns:div', 0] ]) }) it('should support implicit namespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':svg:svg', 0, true] ]) }) it('should support implicit namespace on nested elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':svg:svg', 0, true], [html.Element, ':svg:g', 1, true] ]) }) it('should set flag that namespace was set implicitly', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':svg:svg', 0, true], [html.Element, ':svg:g', 1, true] ]) }) it('should propagate the namespace', () => { expect(humanizeDom(parser.parse('

', 'TestComp'))).toEqual([ [html.Element, ':myns:div', 0], [html.Element, ':myns:p', 1, true] ]) }) it('should match closing tags case sensitive', () => { const errors = parser.parse('

', 'TestComp').errors expect(errors.length).toEqual(2) expect(humanizeErrors(errors)).toEqual([ [ 'p', 'Unexpected closing tag "p". It may happen when the tag has already been closed by another tag. For more info see https://www.w3.org/TR/html5/syntax.html#closing-elements-that-have-implied-end-tags', '0:8' ], [ 'dIv', 'Unexpected closing tag "dIv". It may happen when the tag has already been closed by another tag. For more info see https://www.w3.org/TR/html5/syntax.html#closing-elements-that-have-implied-end-tags', '0:12' ] ]) }) it('should support self closing void elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([[html.Element, 'input', 0]]) }) it('should support self closing foreign elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':math:math', 0, true] ]) }) it('should ignore LF immediately after textarea, pre and listing', () => { expect( humanizeDom( parser.parse( '

\n

\n\n
\n\n', 'TestComp' ) ) ).toEqual([ [html.Element, 'p', 0], [html.Text, '\n', 1], [html.Element, 'textarea', 0], [html.Element, 'pre', 0], [html.Text, '\n', 1], [html.Element, 'listing', 0], [html.Text, '\n', 1] ]) }) }) describe('attributes', () => { it('should parse attributes on regular elements case sensitive', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Attribute, 'kEy', 'v'], [html.Attribute, 'key2', 'v2'] ]) }) it('should parse attributes without values', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Attribute, 'k', ''] ]) }) it('should parse attributes on svg elements case sensitive', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':svg:svg', 0, true], [html.Attribute, 'viewBox', '0'] ]) }) it('should parse attributes on elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, 'ng-template', 0], [html.Attribute, 'k', 'v'] ]) }) it('should support namespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [html.Element, ':svg:use', 0], [html.Attribute, ':xlink:href', 'Port'] ]) }) }) describe('entities', () => { it('should not decode entities with only ampersand and #', () => { parser = new HtmlParser({ decodeEntities: false }) expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Attribute, '[icon]', '&#'] ]) }) it('should not decode entities', () => { parser = new HtmlParser({ decodeEntities: false }) expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Element, 'div', 0], [html.Attribute, '[icon]', 'ō'] ]) }) }) describe('comments', () => { it('should preserve comments', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Comment, ' comment ', 0], [html.Element, 'div', 0] ]) }) it('should preserve whitespaces and newlines in comments', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [html.Comment, ' \ncomment\n ', 0], [html.Element, 'div', 0] ]) }) }) describe('source spans', () => { it('should store the location', () => { expect( humanizeDomSourceSpans( parser.parse('
\na\n
', 'TestComp') ) ).toEqual([ [html.Element, 'div', 0, '
'], [html.Attribute, '[prop]', 'v1', '[prop]="v1"'], [html.Attribute, '(e)', 'do()', '(e)="do()"'], [html.Attribute, 'attr', 'v2', 'attr="v2"'], [html.Attribute, 'noValue', '', 'noValue'], [html.Text, '\na\n', 1, '\na\n'] ]) }) it('should set the start and end source spans', () => { const node = parser.parse('
a
', 'TestComp').rootNodes[0] expect(node.startSourceSpan!.start.offset).toEqual(0) expect(node.startSourceSpan!.end.offset).toEqual(5) expect(node.endSourceSpan!.start.offset).toEqual(6) expect(node.endSourceSpan!.end.offset).toEqual(12) }) it('should not report a value span for an attribute without a value', () => { const ast = parser.parse('
', 'TestComp') expect((ast.rootNodes[0] as html.Element).attrs[0].valueSpan).toBeUndefined() }) it('should report a value span for an attribute with a value', () => { const ast = parser.parse('
', 'TestComp') const attr = (ast.rootNodes[0] as html.Element).attrs[0] expect(attr.valueSpan!.start.offset).toEqual(9) expect(attr.valueSpan!.end.offset).toEqual(13) }) }) describe('self close mode', () => { it('should allow self closing html element', () => { parser = new HtmlParser({ selfClosingElements: true }) const errors = parser.parse('

', 'TestComp').errors expect(errors.length).toEqual(0) }) it('should allow self closing custom element', () => { parser = new HtmlParser({ selfClosingElements: true }) const errors = parser.parse('', 'TestComp').errors expect(errors.length).toEqual(0) }) }) describe('visitor', () => { it('should visit text nodes', () => { const result = humanizeDom(parser.parse('text', 'TestComp')) expect(result).toEqual([[html.Text, 'text', 0]]) }) it('should visit element nodes', () => { const result = humanizeDom(parser.parse('

', 'TestComp')) expect(result).toEqual([[html.Element, 'div', 0]]) }) it('should visit attribute nodes', () => { const result = humanizeDom(parser.parse('
', 'TestComp')) expect(result).toContainEqual([html.Attribute, 'id', 'foo']) }) it('should visit all nodes', () => { const result = parser.parse('
ab
', 'TestComp') const accumulator: html.Node[] = [] const visitor = new class { visit(node: html.Node, context: any) { accumulator.push(node) } visitElement(element: html.Element, context: any): any { html.visitAll(this, element.attrs) html.visitAll(this, element.children) } visitAttribute(attribute: html.Attribute, context: any): any {} visitText(text: html.Text, context: any): any {} visitDoctype(doctype: html.Doctype, context: any): any {} visitComment(comment: html.Comment, context: any): any {} }() html.visitAll(visitor, result.rootNodes) expect(accumulator.map(n => n.constructor)).toEqual([ html.Element, html.Attribute, html.Element, html.Attribute, html.Text, html.Element, html.Text ]) }) it('should skip typed visit if visit() returns a truthy value', () => { const visitor = new class { visit(node: html.Node, context: any) { return true } visitElement(element: html.Element, context: any): any { throw Error('Unexpected') } visitAttribute(attribute: html.Attribute, context: any): any { throw Error('Unexpected') } visitText(text: html.Text, context: any): any { throw Error('Unexpected') } visitComment(comment: html.Comment, context: any): any { throw Error('Unexpected') } visitDoctype(doctype: html.Doctype, context: any): any { throw Error('Unexpected') } }() const result = parser.parse('
', 'TestComp') const traversal = html.visitAll(visitor, result.rootNodes) expect(traversal).toEqual([true, true]) }) }) describe('errors', () => { it('should report unexpected closing tags', () => { const errors = parser.parse('

', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ [ 'p', 'Unexpected closing tag "p". It may happen when the tag has already been closed by another tag. For more info see https://www.w3.org/TR/html5/syntax.html#closing-elements-that-have-implied-end-tags', '0:5' ] ]) }) it('should report subsequent open tags without proper close tag', () => { const errors = parser.parse('', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ [ 'div', 'Unexpected closing tag "div". It may happen when the tag has already been closed by another tag. For more info see https://www.w3.org/TR/html5/syntax.html#closing-elements-that-have-implied-end-tags', '0:4' ] ]) }) it('should report closing tag for void elements', () => { const errors = parser.parse('', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ ['input', 'Void elements do not have end tags "input"', '0:7'] ]) }) it('should report self closing html element', () => { const errors = parser.parse('

', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ ['p', 'Only void, foreign or custom elements can be self closed "p"', '0:0'] ]) }) it('should report self closing custom element', () => { const errors = parser.parse('', 'TestComp').errors expect(errors.length).toEqual(1) expect(humanizeErrors(errors)).toEqual([ ['my-cmp', 'Only void, foreign or custom elements can be self closed "my-cmp"', '0:0'] ]) }) it('should also report lexer errors', () => { const errors = parser.parse('

', 'TestComp').errors expect(errors.length).toEqual(2) expect(humanizeErrors(errors)).toEqual([ [TokenType.COMMENT_START, 'Unexpected character "e"', '0:3'], [ 'p', 'Unexpected closing tag "p". It may happen when the tag has already been closed by another tag. For more info see https://www.w3.org/TR/html5/syntax.html#closing-elements-that-have-implied-end-tags', '0:14' ] ]) }) }) }) }) } export function humanizeErrors(errors: ParseError[]): any[] { return errors.map(e => { if (e instanceof TreeError) { // Parser errors return [e.elementName, e.msg, humanizeLineColumn(e.span.start)] } // Tokenizer errors return [(e).tokenType, e.msg, humanizeLineColumn(e.span.start)] }) }