Skip to content

Remove deprecated code and incremental text document #2366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- 🙌 Fix v-bind modifiers causing TypeScript to not find type-checked template props correctly. Thanks to contribution from [@andrewisaburden](https://github.com/andrewisaburden). #2430.
- 🙌 Fix "File name X differs from already included file name Y only in casing" on Windows. Thanks to contribution from [@rchl](https://github.com/rchl). #2433 and #2444.
- 🙌 Remove deprecated code and incremental text document. Thanks to contribution from [@yoyo930021](https://github.com/yoyo930021). #2366.

### 0.29.1 | 2020-11-08 | [VSIX](https://marketplace.visualstudio.com/_apis/public/gallery/publishers/octref/vsextensions/vetur/0.29.1/vspackage)

Expand Down
3 changes: 2 additions & 1 deletion server/src/embeddedSupport/embeddedSupport.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, Position, Range } from 'vscode-languageserver-types';
import { Position, Range } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';
import { parseVueDocumentRegions, EmbeddedRegion } from './vueDocumentRegionParser';

export type LanguageId =
Expand Down
2 changes: 1 addition & 1 deletion server/src/embeddedSupport/languageModelCache.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { TextDocument } from 'vscode-languageserver';
import { TextDocument } from 'vscode-languageserver-textdocument';

export interface LanguageModelCache<T> {
/**
Expand Down
2 changes: 1 addition & 1 deletion server/src/embeddedSupport/languageModes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import {
SignatureHelp,
Definition,
TextEdit,
TextDocument,
Diagnostic,
DocumentLink,
Range,
Expand All @@ -22,6 +21,7 @@ import {
WorkspaceEdit,
FoldingRange
} from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

import { getLanguageModelCache, LanguageModelCache } from './languageModelCache';
import { getVueDocumentRegions, VueDocumentRegions, LanguageId, LanguageRange } from './embeddedSupport';
Expand Down
2 changes: 1 addition & 1 deletion server/src/embeddedSupport/test/embeddedSupport.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { TextDocument } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';
import * as assert from 'assert';
import { parseVueDocumentRegions } from '../vueDocumentRegionParser';
import { getSingleLanguageDocument, getSingleTypeDocument, getLanguageRangesOfType } from '../embeddedSupport';
Expand Down
2 changes: 1 addition & 1 deletion server/src/embeddedSupport/vueDocumentRegionParser.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { TextDocument } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { createScanner, TokenType, Scanner } from '../modes/template/parser/htmlScanner';
import { removeQuotes } from '../utils/strings';
import { LanguageId } from './embeddedSupport';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/pug/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, Position, Range } from 'vscode-languageserver-types';
import { Position, Range } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { LanguageMode } from '../../embeddedSupport/languageModes';
import { prettierify } from '../../utils/prettier';
import { VLSFormatConfig } from '../../config';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/style/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, Position, Range } from 'vscode-languageserver-types';
import { Position, Range } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import {
getCSSLanguageService,
getSCSSLanguageService,
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/style/sass/sassLanguageMode.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { LanguageMode } from '../../../embeddedSupport/languageModes';

import { TextDocument, Range, FormattingOptions, CompletionList } from 'vscode-languageserver-types/lib/umd/main';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { Range, FormattingOptions, CompletionList } from 'vscode-languageserver-types';

import { TextEdit, Position } from 'vscode-css-languageservice';

Expand Down
9 changes: 2 additions & 7 deletions server/src/modes/style/stylus/completion-item.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
import {
CompletionItem,
CompletionItemKind,
TextDocument,
Position,
CompletionList
} from 'vscode-languageserver-types';
import { CompletionItem, CompletionItemKind, Position, CompletionList } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

import {
StylusNode,
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/style/stylus/stylus-hover.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, Position, Hover, Range } from 'vscode-languageserver-types';
import { Position, Hover, Range } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

import { buildAst, findNodeAtPosition } from './parser';

Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/style/stylus/symbols-finder.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, SymbolInformation, SymbolKind, Range, Position } from 'vscode-languageserver-types';
import { SymbolInformation, SymbolKind, Range, Position } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

import {
StylusNode,
Expand Down
5 changes: 3 additions & 2 deletions server/src/modes/template/htmlMode.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import * as _ from 'lodash';

import { LanguageModelCache, getLanguageModelCache } from '../../embeddedSupport/languageModelCache';
import { TextDocument, Position, Range, FormattingOptions } from 'vscode-languageserver-types';
import { Position, Range, FormattingOptions } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { LanguageMode } from '../../embeddedSupport/languageModes';
import { VueDocumentRegions } from '../../embeddedSupport/embeddedSupport';
import { HTMLDocument } from './parser/htmlParser';
Expand Down Expand Up @@ -79,7 +80,7 @@ export class HTMLMode implements LanguageMode {
}
if (this.config.vetur.validation.template) {
const embedded = this.embeddedDocuments.refreshAndGet(document);
diagnostics.push(...doESLintValidation(embedded, this.lintEngine));
diagnostics.push(...(await doESLintValidation(embedded, this.lintEngine)));
}

return diagnostics;
Expand Down
11 changes: 2 additions & 9 deletions server/src/modes/template/index.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import {
FormattingOptions,
Position,
Range,
TextDocument,
Hover,
Location,
CompletionItem
} from 'vscode-languageserver-types';
import { FormattingOptions, Position, Range, Hover, Location, CompletionItem } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { VueDocumentRegions } from '../../embeddedSupport/embeddedSupport';
import { LanguageModelCache, getLanguageModelCache } from '../../embeddedSupport/languageModelCache';
import { LanguageMode } from '../../embeddedSupport/languageModes';
Expand Down
2 changes: 1 addition & 1 deletion server/src/modes/template/interpolationMode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ import {
MarkupContent,
Position,
Range,
TextDocument,
TextEdit
} from 'vscode-languageserver-types';
import { URI } from 'vscode-uri';
import { TextDocument } from 'vscode-languageserver-textdocument';
import { VLSFullConfig } from '../../config';
import { LanguageModelCache } from '../../embeddedSupport/languageModelCache';
import { LanguageMode } from '../../embeddedSupport/languageModes';
Expand Down
2 changes: 1 addition & 1 deletion server/src/modes/template/parser/htmlParser.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { TokenType, createScanner } from './htmlScanner';
import { isVoidElement } from '../tagProviders/htmlTags';
import { TextDocument } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

export class Node {
public tag?: string;
Expand Down
2 changes: 1 addition & 1 deletion server/src/modes/template/services/htmlCompletion.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {
TextDocument,
Position,
CompletionList,
CompletionItemKind,
Expand All @@ -8,6 +7,7 @@ import {
InsertTextFormat,
CompletionItem
} from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { HTMLDocument } from '../parser/htmlParser';
import { TokenType, createScanner, ScannerState } from '../parser/htmlScanner';
import { IHTMLTagProvider } from '../tagProviders';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlDefinition.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { HTMLDocument } from '../parser/htmlParser';
import { TokenType, createScanner } from '../parser/htmlScanner';
import { TextDocument, Range, Position, Location } from 'vscode-languageserver-types';
import { Range, Position, Location } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { VueFileInfo } from '../../../services/vueInfoService';
import { URI } from 'vscode-uri';
import { kebabCase } from 'lodash';
Expand Down
26 changes: 11 additions & 15 deletions server/src/modes/template/services/htmlEslintValidation.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { CLIEngine, Linter } from 'eslint';
import { ESLint, Linter } from 'eslint';
import { configs } from 'eslint-plugin-vue';
import { TextDocument, Diagnostic, Range, DiagnosticSeverity } from 'vscode-languageserver-types';
import { Diagnostic, Range, DiagnosticSeverity } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { resolve } from 'path';
import { VueVersion } from '../../../services/typescriptService/vueVersion';

Expand All @@ -17,32 +18,27 @@ function toDiagnostic(error: Linter.LintMessage): Diagnostic {
};
}

export function doESLintValidation(document: TextDocument, engine: CLIEngine): Diagnostic[] {
export async function doESLintValidation(document: TextDocument, engine: ESLint): Promise<Diagnostic[]> {
const rawText = document.getText();
// skip checking on empty template
if (rawText.replace(/\s/g, '') === '') {
return [];
}
const text = rawText.replace(/ {10}/, '<template>') + '</template>';
const report = engine.executeOnText(text, document.uri);
const report = await engine.lintText(text, { filePath: document.uri });

return report.results[0] ? report.results[0].messages.map(toDiagnostic) : [];
return report?.[0].messages.map(toDiagnostic) ?? [];
}

export function createLintEngine(vueVersion: VueVersion) {
const SERVER_ROOT = resolve(__dirname, '../../../../');

const basicConfig = {
useEslintrc: false,
// So ESLint can find the bundled eslint-plugin-vue
cwd: SERVER_ROOT,
...configs.base
};

const versionSpecificConfig = vueVersion === VueVersion.V30 ? configs['vue3-essential'] : configs.essential;

return new CLIEngine({
...basicConfig,
...versionSpecificConfig
return new ESLint({
useEslintrc: false,
cwd: SERVER_ROOT,
baseConfig: configs.base,
overrideConfig: versionSpecificConfig
});
}
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlFolding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import { TextDocument, FoldingRange, FoldingRangeKind } from 'vscode-languageserver-types';
import { FoldingRange, FoldingRangeKind } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

import { TokenType, createScanner } from '../parser/htmlScanner';
import { isVoidElement } from '../tagProviders/htmlTags';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlFormat.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as _ from 'lodash';
import { TextDocument, Range, TextEdit, Position } from 'vscode-languageserver-types';
import { Range, TextEdit, Position } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { html as htmlBeautify } from 'js-beautify';
import { IPrettyHtml } from './prettyhtml';
import { requireLocalPkg } from '../../../utils/prettier/requirePkg';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlHighlighting.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { HTMLDocument } from '../parser/htmlParser';
import { TokenType, createScanner } from '../parser/htmlScanner';
import { TextDocument, Range, Position, DocumentHighlightKind, DocumentHighlight } from 'vscode-languageserver-types';
import { Range, Position, DocumentHighlightKind, DocumentHighlight } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';

export function findDocumentHighlights(
document: TextDocument,
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlHover.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { HTMLDocument } from '../parser/htmlParser';
import { TokenType, createScanner } from '../parser/htmlScanner';
import { TextDocument, Range, Position, Hover } from 'vscode-languageserver-types';
import { Range, Position, Hover } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { IHTMLTagProvider } from '../tagProviders';
import { NULL_HOVER } from '../../nullMode';
import { toMarkupContent } from '../../../utils/strings';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlLinks.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { TokenType, createScanner } from '../parser/htmlScanner';
import { TextDocument, Range, DocumentLink } from 'vscode-languageserver-types';
import { Range, DocumentLink } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { URI } from 'vscode-uri';
import { DocumentContext } from '../../../types';

Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/htmlSymbolsProvider.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TextDocument, Location, Range, SymbolInformation, SymbolKind } from 'vscode-languageserver-types';
import { Location, Range, SymbolInformation, SymbolKind } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { HTMLDocument, Node } from '../parser/htmlParser';

export function findDocumentSymbols(document: TextDocument, htmlDocument: HTMLDocument): SymbolInformation[] {
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/services/vuePropValidation.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { VueFileInfo, PropInfo } from '../../../services/vueInfoService';
import { TextDocument, Diagnostic, DiagnosticSeverity } from 'vscode-languageserver-types';
import { Diagnostic, DiagnosticSeverity } from 'vscode-languageserver-types';
import type { TextDocument } from 'vscode-languageserver-textdocument';
import { HTMLDocument, Node } from '../parser/htmlParser';
import { kebabCase } from 'lodash';
import { getSameTagInSet } from '../tagProviders/common';
Expand Down
10 changes: 2 additions & 8 deletions server/src/modes/template/test/highlighting.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
'use strict';

import * as assert from 'assert';
import { TextDocument } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';
import { parseHTMLDocument } from '../parser/htmlParser';
import { findDocumentHighlights } from '../services/htmlHighlighting';

Expand All @@ -27,13 +27,7 @@ suite('HTML Highlighting', () => {
const actualEndOffset = document.offsetAt(highlights[i].range.end);
assert.equal(actualEndOffset, expectedMatches[i] + elementName!.length);

assert.equal(
document
.getText()
.substring(actualStartOffset, actualEndOffset)
.toLowerCase(),
elementName
);
assert.equal(document.getText().substring(actualStartOffset, actualEndOffset).toLowerCase(), elementName);
}
}

Expand Down
2 changes: 1 addition & 1 deletion server/src/modes/template/test/links.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
'use strict';

import * as assert from 'assert';
import { TextDocument } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';
import * as url from 'url';

import { findDocumentLinks } from '../services/htmlLinks';
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/template/test/symbols.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

import * as assert from 'assert';

import { TextDocument, SymbolInformation, SymbolKind, Location, Range } from 'vscode-languageserver-types';
import { SymbolInformation, SymbolKind, Location, Range } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';
import { parseHTMLDocument } from '../parser/htmlParser';
import { findDocumentSymbols } from '../services/htmlSymbolsProvider';

Expand Down
2 changes: 1 addition & 1 deletion server/src/modes/test-util/completion-test-util.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import * as assert from 'assert';
import {
CompletionList,
TextDocument,
CompletionItemKind,
Position,
CompletionItem,
TextEdit,
InsertReplaceEdit
} from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';

export interface CompletionTestSetup {
doComplete(doc: TextDocument, pos: Position): CompletionList;
Expand Down
3 changes: 2 additions & 1 deletion server/src/modes/test-util/hover-test-util.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as assert from 'assert';
import { TextDocument, Position, Hover } from 'vscode-languageserver-types';
import { Position, Hover } from 'vscode-languageserver-types';
import { TextDocument } from 'vscode-languageserver-textdocument';

export interface HoverTestSetup {
docUri: string;
Expand Down
Loading