HTML completion tests

This commit is contained in:
Martin Aeschlimann 2016-08-29 10:36:23 +02:00
parent be56473907
commit 606bfe603d
5 changed files with 502 additions and 24 deletions

View file

@ -4,6 +4,9 @@
*--------------------------------------------------------------------------------------------*/
'use strict';
import * as nls from 'vscode-nls';
let localize = nls.loadMessageBundle();
export enum TokenType {
StartCommentTag,
Comment,
@ -184,6 +187,7 @@ export enum ScannerState {
AfterOpeningEndTag,
WithinDoctype,
WithinTag,
WithinEndTag,
WithinComment,
WithinScriptContent,
WithinStyleContent,
@ -198,6 +202,7 @@ export interface Scanner {
getTokenLength(): number;
getTokenEnd(): number;
getTokenText(): string;
getTokenError(): string;
getScannerState(): ScannerState;
}
@ -207,6 +212,7 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
let state = initialState;
let tokenOffset: number = 0;
let tokenType: number = void 0;
let tokenError: string;
let hasSpaceAfterTag: boolean;
let lastTag: string;
@ -219,9 +225,10 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
return stream.advanceIfRegExp(/^[^\s"'>/=\x00-\x0F\x7F\x80-\x9F]*/).toLowerCase();
}
function finishToken(offset: number, type: TokenType): TokenType {
function finishToken(offset: number, type: TokenType, errorMessage?: string): TokenType {
tokenType = type;
tokenOffset = offset;
tokenError = errorMessage;
return type;
}
@ -230,6 +237,7 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
if (stream.eos()) {
return finishToken(offset, TokenType.EOS);
}
let errorMessage;
switch (state) {
case ScannerState.WithinComment:
@ -270,13 +278,24 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
case ScannerState.AfterOpeningEndTag:
let tagName = nextElementName();
if (tagName.length > 0) {
state = ScannerState.WithinEndTag;
return finishToken(offset, TokenType.EndTag);
} else if (stream.advanceIfChar(_RAN)) { // >
}
if (stream.skipWhitespace()) { // white space is not valid here
return finishToken(offset, TokenType.Whitespace, localize('error.unexpectedWhitespace', 'Tag name must directly follow the open bracket.'));
}
stream.advanceUntilChar(_RAN);
return finishToken(offset, TokenType.Unknown, localize('error.endTagNameExpected', 'End tag name expected.'));
case ScannerState.WithinEndTag:
if (stream.skipWhitespace()) { // white space is valid here
return finishToken(offset, TokenType.Whitespace);
}
if (stream.advanceIfChar(_RAN)) { // >
state = ScannerState.WithinContent;
return finishToken(offset, TokenType.EndTagClose);
}
stream.advanceUntilChar(_RAN);
return finishToken(offset, TokenType.Whitespace);
errorMessage = localize('error.tagNameExpected', 'Closing bracket expected.');
break;
case ScannerState.AfterOpeningStartTag:
lastTag = nextElementName();
if (lastTag.length > 0) {
@ -284,7 +303,11 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
state = ScannerState.WithinTag;
return finishToken(offset, TokenType.StartTag);
}
break;
if (stream.skipWhitespace()) { // white space is not valid here
return finishToken(offset, TokenType.Whitespace, localize('error.unexpectedWhitespace', 'Tag name must directly follow the open bracket.'));
}
stream.advanceUntilChar(_RAN);
return finishToken(offset, TokenType.Unknown, localize('error.startTagNameExpected', 'Start tag name expected.'));
case ScannerState.WithinTag:
if (stream.skipWhitespace()) {
hasSpaceAfterTag = true; // remember that we have seen a whitespace
@ -313,7 +336,7 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
return finishToken(offset, TokenType.StartTagClose);
}
stream.advance(1);
return finishToken(offset, TokenType.Unknown);
return finishToken(offset, TokenType.Unknown, localize('error.unexpectedCharacterInTag', 'Unexpected character in tag.'));
case ScannerState.AfterAttributeName:
if (stream.skipWhitespace()) {
hasSpaceAfterTag = true;
@ -392,7 +415,7 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
stream.advance(1);
state = ScannerState.WithinContent;
return finishToken(offset, TokenType.Unknown);
return finishToken(offset, TokenType.Unknown, errorMessage);
}
return {
scan,
@ -401,6 +424,7 @@ export function createScanner(input: string, initialOffset = 0, initialState: Sc
getTokenLength: () => stream.pos() - tokenOffset,
getTokenEnd: () => stream.pos(),
getTokenText: () => stream.getSource().substring(tokenOffset, stream.pos()),
getScannerState: () => state
getScannerState: () => state,
getTokenError: () => tokenError
};
}

View file

@ -10,7 +10,7 @@ import { TokenType, createScanner, ScannerState } from '../parser/htmlScanner';
import { IHTMLTagProvider, getHTML5TagProvider, getAngularTagProvider, getIonicTagProvider } from '../parser/htmlTags';
import { startsWith } from '../utils/strings';
let tagProviders: IHTMLTagProvider[];
let tagProviders: IHTMLTagProvider[] = [];
tagProviders.push(getHTML5TagProvider());
tagProviders.push(getAngularTagProvider());
tagProviders.push(getIonicTagProvider());
@ -48,10 +48,24 @@ export function doComplete(document: TextDocument, position: Position, doc: HTML
return result;
}
function collectCloseTagSuggestions(afterOpenBracket: number) : CompletionList {
function collectCloseTagSuggestions(afterOpenBracket: number, matchingOnly: boolean) : CompletionList {
let range : Range = { start: document.positionAt(afterOpenBracket), end: document.positionAt(offset)};
let contentAfter = document.getText().substr(offset);
let closeTag = isWhiteSpace(contentAfter) || startsWith(contentAfter, '<') ? '>' : '';
if (node.parent && node.parent.tag) {
let tag = node.parent.tag;
result.items.push({
label: '/' + tag,
kind: CompletionItemKind.Property,
filterText: '/' + tag + closeTag,
textEdit: { newText: '/' + tag + closeTag, range: range }
});
return;
}
if (matchingOnly) {
return;
}
tagProviders.forEach((provider) => {
provider.collectTags((tag, label) => {
result.items.push({
@ -68,7 +82,7 @@ export function doComplete(document: TextDocument, position: Position, doc: HTML
function collectTagSuggestions(tagStart: number) : CompletionList {
collectOpenTagSuggestions(tagStart);
collectCloseTagSuggestions(tagStart);
collectCloseTagSuggestions(tagStart, true);
return result;
}
@ -134,31 +148,33 @@ export function doComplete(document: TextDocument, position: Position, doc: HTML
break;
case TokenType.AttributeValue:
if (scanner.getTokenOffset() <= offset && offset <= scanner.getTokenEnd()) {
return collectAttributeValueSuggestions(scanner.getTokenEnd());
return collectAttributeValueSuggestions(scanner.getTokenOffset());
}
break;
case TokenType.Whitespace:
case TokenType.StartTagClose:
case TokenType.StartTagSelfClose:
if (offset <= scanner.getTokenOffset()) {
case TokenType.Unknown:
if (offset <= scanner.getTokenEnd()) {
switch (scanner.getScannerState()) {
case ScannerState.AfterOpeningStartTag:
return collectTagSuggestions(scanner.getTokenOffset());
case ScannerState.WithinTag:
case ScannerState.AfterAttributeName:
return collectAttributeNameSuggestions(scanner.getTokenOffset());
return collectAttributeNameSuggestions(scanner.getTokenEnd());
case ScannerState.BeforeAttributeValue:
return collectAttributeValueSuggestions(scanner.getTokenOffset());
return collectAttributeValueSuggestions(scanner.getTokenEnd());
}
}
break;
case TokenType.EndTagOpen:
if (offset <= scanner.getTokenEnd()) {
return collectCloseTagSuggestions(scanner.getTokenOffset() + 1);
return collectCloseTagSuggestions(scanner.getTokenOffset() + 1, false);
}
break;
}
token = scanner.scan();
}
return null;
return result;
}
function isWhiteSpace(s:string) : boolean {

View file

@ -0,0 +1,414 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
'use strict';
import * as assert from 'assert';
import * as htmlLanguageService from '../htmlLanguageService';
import {CompletionList, TextDocument, TextEdit, Position, CompletionItemKind} from 'vscode-languageserver-types';
import {applyEdits} from './textEditSupport';
export interface ItemDescription {
label: string;
documentation?: string;
kind?: CompletionItemKind;
insertText?: string;
overwriteBefore?: number;
resultText?: string;
}
function asPromise<T>(result: T): Promise<T> {
return Promise.resolve(result);
}
export let assertCompletion = function (completions: CompletionList, expected: ItemDescription, document: TextDocument, offset: number) {
let matches = completions.items.filter(completion => {
return completion.label === expected.label;
});
assert.equal(matches.length, 1, expected.label + " should only existing once: Actual: " + completions.items.map(c => c.label).join(', '));
if (expected.documentation) {
assert.equal(matches[0].documentation, expected.documentation);
}
if (expected.kind) {
assert.equal(matches[0].kind, expected.kind);
}
if (expected.insertText) {
assert.equal(matches[0].insertText || matches[0].textEdit.newText, expected.insertText);
}
if (expected.resultText) {
assert.equal(applyEdits(document, [matches[0].textEdit]), expected.resultText);
}
if (expected.insertText && typeof expected.overwriteBefore === 'number' && matches[0].textEdit) {
let text = document.getText();
let expectedText = text.substr(0, offset - expected.overwriteBefore) + expected.insertText + text.substr(offset);
assert.equal(applyEdits(document, [matches[0].textEdit]), expectedText);
}
};
let testCompletionFor = function (value: string, expected: { count?: number, items?: ItemDescription[] }): Thenable<void> {
let offset = value.indexOf('|');
value = value.substr(0, offset) + value.substr(offset + 1);
let ls = htmlLanguageService.getLanguageService();
let document = TextDocument.create('test://test/test.html', 'html', 0, value);
let position = Position.create(0, offset);
let jsonDoc = ls.parseHTMLDocument(document);
return asPromise(ls.doComplete(document, position, jsonDoc)).then(list => {
try {
if (expected.count) {
assert.equal(list.items, expected.count);
}
if (expected.items) {
for (let item of expected.items) {
assertCompletion(list, item, document, offset);
}
}
} catch (e) {
return Promise.reject(e);
}
});
};
function run(tests: Thenable<void>[], testDone) {
Promise.all(tests).then(() => {
testDone();
}, (error) => {
testDone(error);
});
}
suite('HTML Completion', () => {
test('Intellisense', function (testDone): any {
run([
testCompletionFor('<|', {
items: [
{ label: 'iframe', resultText: '<iframe' },
{ label: 'h1', resultText: '<h1' },
{ label: 'div', resultText: '<div' },
]
}),
testCompletionFor('< |', {
items: [
{ label: 'iframe', resultText: '<iframe' },
{ label: 'h1', resultText: '<h1' },
{ label: 'div', resultText: '<div' },
]
}),
testCompletionFor('<h|', {
items: [
{ label: 'html', resultText: '<html' },
{ label: 'h1', resultText: '<h1' },
{ label: 'header', resultText: '<header' },
]
}),
testCompletionFor('<input|', {
items: [
{ label: 'input', resultText: '<input' },
]
}),
testCompletionFor('<input |', {
items: [
{ label: 'type', resultText: '<input type="{{}}"' },
{ label: 'style', resultText: '<input style="{{}}"' },
{ label: 'onmousemove', resultText: '<input onmousemove="{{}}"' },
]
}),
testCompletionFor('<input t|', {
items: [
{ label: 'type', resultText: '<input type="{{}}"' },
{ label: 'tabindex', resultText: '<input tabindex="{{}}"' },
]
}),
testCompletionFor('<input type="text" |', {
items: [
{ label: 'style', resultText: '<input type="text" style="{{}}"' },
{ label: 'type', resultText: '<input type="text" type="{{}}"' },
{ label: 'size', resultText: '<input type="text" size="{{}}"' },
]
}),
testCompletionFor('<input type="text" s|', {
items: [
{ label: 'style', resultText: '<input type="text" style="{{}}"' },
{ label: 'src', resultText: '<input type="text" src="{{}}"' },
{ label: 'size', resultText: '<input type="text" size="{{}}"' },
]
}),
testCompletionFor('<input di| type="text"', {
items: [
{ label: 'disabled', resultText: '<input disabled type="text"' },
{ label: 'dir', resultText: '<input dir="{{}}" type="text"' },
]
}),
testCompletionFor('<input disabled | type="text"', {
items: [
{ label: 'dir', resultText: '<input disabled dir="{{}}" type="text"' },
{ label: 'style', resultText: '<input disabled style="{{}}" type="text"' },
]
}),
// testCompletionFor('<input type=|', {
// items: [
// { label: 'text', resultText: 'text' },
// { label: 'checkbox', resultText: 'checkbox' },
// ]
// }),
// testCompletionFor('<input type="c|', {
// items: [
// { label: 'color', resultText: 'color' },
// { label: 'checkbox', resultText: 'checkbox' },
// ]
// }),
// testCompletionFor('<input type= |', {
// items: [
// { label: 'color', resultText: 'color' },
// { label: 'checkbox', resultText: 'checkbox' },
// ]
// }),
// testCompletionFor('<input src="c" type="color|" ', {
// items: [
// { label: 'color', resultText: 'color' },
// ]
// }),
// testCompletionFor('<input src="c" type=color| ', {
// items: [
// { label: 'color', resultText: 'color' },
// ]
// }),
// testCompletionFor('<div dir=|></div>', {
// items: [
// { label: 'ltr', resultText: 'ltr' },
// { label: 'rtl', resultText: 'rtl' },
// ]
// }),
// testCompletionFor('<ul><|>', {
// items: [
// { label: '/ul', resultText: '/ul' },
// { label: 'li', resultText: 'li' },
// ]
// }),
// testCompletionFor('<ul><li><|', {
// items: [
// { label: '/li', resultText: '/li' },
// { label: 'a', resultText: 'a' },
// ]
// }),
// testCompletionFor('<table></|>', {
// items: [
// { label: '/table', resultText: '/table' },
// ]
// }),
// testCompletionFor('<foo></f|', {
// items: [
// { label: '/foo', resultText: '/foo' },
// ]
// }),
// testCompletionFor('<ul></ |>', {
// items: [
// { label: '/ul', resultText: '/ul' },
// ]
// }),
// testCompletionFor('<span></ |', {
// items: [
// { label: '/span', resultText: '/span' },
// ]
// }),
// testCompletionFor('<li><br></ |>', {
// items: [
// { label: '/li', resultText: '/li' },
// ]
// }),
// testCompletionFor('<li><br/></ |>', {
// items: [
// { label: '/li', resultText: '/li' },
// ]
// }),
// testCompletionFor('<li><div/></|', {
// items: [
// { label: '/li', resultText: '/li' },
// ]
// }),
// testCompletionFor('<li><br/|>', { count: 0 }),
// testCompletionFor('<li><br>a/|', { count: 0 }),
// testCompletionFor('<a><div></div></| ', {
// items: [
// { label: '/a', resultText: '/a' },
// ]
// }),
// testCompletionFor('<body><div><div></div></div></| >', {
// items: [
// { label: '/body', resultText: '/body' },
// ]
// }),
// testCompletionFor(['<body>', ' <div>', ' </|'].join('\n'), {
!/usr/bin/env [
// { label: '/div', resultText: '/div' },
// ]
// })
], testDone);
});
// test('Intellisense aria', function (testDone): any {
// let expectedAriaAttributes = [
// { label: 'aria-activedescendant' },
// { label: 'aria-atomic' },
// { label: 'aria-autocomplete' },
// { label: 'aria-busy' },
// { label: 'aria-checked' },
// { label: 'aria-colcount' },
// { label: 'aria-colindex' },
// { label: 'aria-colspan' },
// { label: 'aria-controls' },
// { label: 'aria-current' },
// { label: 'aria-describedat' },
// { label: 'aria-describedby' },
// { label: 'aria-disabled' },
// { label: 'aria-dropeffect' },
// { label: 'aria-errormessage' },
// { label: 'aria-expanded' },
// { label: 'aria-flowto' },
// { label: 'aria-grabbed' },
// { label: 'aria-haspopup' },
// { label: 'aria-hidden' },
// { label: 'aria-invalid' },
// { label: 'aria-kbdshortcuts' },
// { label: 'aria-label' },
// { label: 'aria-labelledby' },
// { label: 'aria-level' },
// { label: 'aria-live' },
// { label: 'aria-modal' },
// { label: 'aria-multiline' },
// { label: 'aria-multiselectable' },
// { label: 'aria-orientation' },
// { label: 'aria-owns' },
// { label: 'aria-placeholder' },
// { label: 'aria-posinset' },
// { label: 'aria-pressed' },
// { label: 'aria-readonly' },
// { label: 'aria-relevant' },
// { label: 'aria-required' },
// { label: 'aria-roledescription' },
// { label: 'aria-rowcount' },
// { label: 'aria-rowindex' },
// { label: 'aria-rowspan' },
// { label: 'aria-selected' },
// { label: 'aria-setsize' },
// { label: 'aria-sort' },
// { label: 'aria-valuemax' },
// { label: 'aria-valuemin' },
// { label: 'aria-valuenow' },
// { label: 'aria-valuetext' }
// ];
// run([
// testCompletionFor('<div |> </div >', { items: expectedAriaAttributes }),
// testCompletionFor('<span |> </span >', { items: expectedAriaAttributes }),
// testCompletionFor('<input |> </input >', { items: expectedAriaAttributes })
// ], testDone);
// });
// test('Intellisense Angular', function (testDone): any {
// run([
// testCompletionFor('<body |> </body >', {
// items: [
// { label: 'ng-controller', resultText: 'ng-controller' },
// { label: 'data-ng-controller', resultText: 'data-ng-controller' },
// ]
// }),
// testCompletionFor('<li |> </li >', {
// items: [
// { label: 'ng-repeat', resultText: 'ng-repeat' },
// { label: 'data-ng-repeat', resultText: 'data-ng-repeat' },
// ]
// }),
// testCompletionFor('<input |> </input >', {
// items: [
// { label: 'ng-model', resultText: 'ng-model' },
// { label: 'data-ng-model', resultText: 'data-ng-model' },
// ]
// })
// ], testDone);
// });
// test('Intellisense Ionic', function (testDone): any {
// run([
// // Try some Ionic tags
// testCompletionFor('<|', {
// items: [
// { label: 'ion-checkbox', resultText: 'ion-checkbox' },
// { label: 'ion-content', resultText: 'ion-content' },
// { label: 'ion-nav-title', resultText: 'ion-nav-title' },
// ]
// }),
// testCompletionFor('<ion-re|', {
// items: [
// { label: 'ion-refresher', resultText: 'ion-refresher' },
// { label: 'ion-reorder-button', resultText: 'ion-reorder-button' },
// ]
// }),
// // Try some global attributes (1 with value suggestions, 1 without value suggestions, 1 void)
// testCompletionFor('<ion-checkbox |', {
// items: [
// { label: 'force-refresh-images', resultText: 'force-refresh-images' },
// { label: 'collection-repeat', resultText: 'collection-repeat' },
// { label: 'menu-close', resultText: 'menu-close' },
// ]
// }),
// // Try some tag-specific attributes (1 with value suggestions, 1 void)
// testCompletionFor('<ion-footer-bar |', {
// items: [
// { label: 'align-title', resultText: 'align-title' },
// { label: 'keyboard-attach', resultText: 'keyboard-attach' },
// ]
// }),
// // Try the extended attributes of an existing HTML 5 tag
// testCompletionFor('<a |', {
// items: [
// { label: 'nav-direction', resultText: 'nav-direction' },
// { label: 'nav-transition', resultText: 'nav-transition' },
// { label: 'href', resultText: 'href' },
// { label: 'hreflang', resultText: 'hreflang' },
// ]
// }),
// // Try value suggestion for a tag-specific attribute
// testCompletionFor('<ion-side-menu side="|', {
// items: [
// { label: 'left', resultText: 'left' },
// { label: 'primary', resultText: 'primary' },
// { label: 'right', resultText: 'right' },
// { label: 'secondary', resultText: 'secondary' },
// ]
// }),
// // Try a value suggestion for a global attribute
// testCompletionFor('<img force-refresh-images="|', {
// items: [
// { label: 'false', resultText: 'false' },
// { label: 'true', resultText: 'true' },
// ]
// }),
// // Try a value suggestion for an extended attribute of an existing HTML 5 tag
// testCompletionFor('<a nav-transition="|', {
// items: [
// { label: 'android', resultText: 'android' },
// { label: 'ios', resultText: 'ios' },
// { label: 'none', resultText: 'none' },
// ]
// })
// ], testDone);
// });
})

View file

@ -60,8 +60,8 @@ suite('HTML Scanner', () => {
input: '< abc',
tokens: [
{ offset:0, type: TokenType.StartTagOpen },
{ offset:1, type: TokenType.Unknown },
{ offset:2, type: TokenType.Content }
{ offset:1, type: TokenType.Whitespace },
{ offset:2, type: TokenType.StartTag, content: 'abc' }
]}
]);
});
@ -71,8 +71,9 @@ suite('HTML Scanner', () => {
input: '< abc>',
tokens: [
{ offset:0, type: TokenType.StartTagOpen },
{ offset:1, type: TokenType.Unknown },
{ offset:2, type: TokenType.Content }
{ offset:1, type: TokenType.Whitespace },
{ offset:2, type: TokenType.StartTag, content: 'abc' },
{ offset:5, type: TokenType.StartTagClose },
]}
]);
});

View file

@ -0,0 +1,23 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
'use strict';
import {TextDocument, TextEdit} from 'vscode-languageserver-types';
import * as assert from 'assert';
export function applyEdits(document: TextDocument, edits: TextEdit[]): string {
let text = document.getText();
let sortedEdits = edits.sort((a, b) => document.offsetAt(b.range.start) - document.offsetAt(a.range.start));
let lastOffset = text.length;
sortedEdits.forEach(e => {
let startOffset = document.offsetAt(e.range.start);
let endOffset = document.offsetAt(e.range.end);
assert.ok(startOffset <= endOffset);
assert.ok(endOffset <= lastOffset);
text = text.substring(0, startOffset) + e.newText + text.substring(endOffset, text.length);
lastOffset = startOffset;
});
return text;
}