Skip to content

[HTML] Support the tsserver resolving files relative to the html file #121517

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[HTML] Support the tsserver resolving files relative to the html file #121517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
989d156
Adds the ability to resolve @types and JSDoc imports in inline <scripts>
orta Apr 16, 2021
9b71947
Improve tests
orta Apr 16, 2021
12389b3
Support windows filepaths
orta Apr 17, 2021
c2f8374
Use mtime to figure out what the version of a TypeScript import file is
orta Apr 24, 2021
a9b02de
html-lang: Prefer full urls in JS auto-complete in script tags
orta Apr 24, 2021
a787a13
Only use the sync TSServer when on a file:// workspace
orta Nov 22, 2021
e4d3ca9
Get tests green
orta Dec 7, 2021
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
158 changes: 117 additions & 41 deletions extensions/html-language-features/server/src/modes/javascriptMode.ts
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions extensions/html-language-features/server/src/modes/languageModes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ export function getLanguageModes(supportedLanguages: { [languageId: string]: boo
modes['css'] = getCSSMode(cssLanguageService, documentRegions, workspace);
}
if (supportedLanguages['javascript']) {
modes['javascript'] = getJavaScriptMode(documentRegions, 'javascript', workspace);
modes['typescript'] = getJavaScriptMode(documentRegions, 'typescript', workspace);
modes['javascript'] = getJavaScriptMode(documentRegions, 'javascript', workspace, requestService);
modes['typescript'] = getJavaScriptMode(documentRegions, 'typescript', workspace, requestService);
}
return {
async updateDataProviders(dataProviders: IHTMLDataProvider[]): Promise<void> {
Expand Down
56 changes: 38 additions & 18 deletions extensions/html-language-features/server/src/node/nodeFs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,41 @@ import { URI as Uri } from 'vscode-uri';

import * as fs from 'fs';
import { FileType } from 'vscode-css-languageservice';
import { FileStat } from 'vscode-html-languageservice';

export function getNodeFileFS(): FileSystemProvider {
/**
* This extension is for the TSServer in the JavaScript mode which
* require sync access to stat's mtime due to TSServer API limitations
*/
export interface NodeRequestService extends FileSystemProvider {
statSync(location: string): FileStat
}

export function getNodeFileFS(): NodeRequestService {
function ensureFileUri(location: string) {
if (getScheme(location) !== 'file') {
throw new Error('fileSystemProvider can only handle file URLs');
if (getScheme(location) !== 'file' && getScheme(location) !== '') {
throw new Error(`fileSystemProvider can only handle file URLs, got ${getScheme(location)}`);
}
}

const fsStatToFileStat = (stats: fs.Stats) => {
let type = FileType.Unknown;
if (stats.isFile()) {
type = FileType.File;
} else if (stats.isDirectory()) {
type = FileType.Directory;
} else if (stats.isSymbolicLink()) {
type = FileType.SymbolicLink;
}

return {
type,
ctime: stats.ctime.getTime(),
mtime: stats.mtime.getTime(),
size: stats.size
};
};

return {
stat(location: string) {
ensureFileUri(location);
Expand All @@ -29,24 +57,16 @@ export function getNodeFileFS(): FileSystemProvider {
}
}

let type = FileType.Unknown;
if (stats.isFile()) {
type = FileType.File;
} else if (stats.isDirectory()) {
type = FileType.Directory;
} else if (stats.isSymbolicLink()) {
type = FileType.SymbolicLink;
}

c({
type,
ctime: stats.ctime.getTime(),
mtime: stats.mtime.getTime(),
size: stats.size
});
c(fsStatToFileStat(stats));
});
});
},
statSync(location: string) {
ensureFileUri(location);
const uri = Uri.parse(location);
const stats = fs.statSync(uri.fsPath);
return fsStatToFileStat(stats);
},
readDirectory(location: string) {
ensureFileUri(location);
return new Promise((c, e) => {
Expand Down
22 changes: 22 additions & 0 deletions extensions/html-language-features/server/src/test/completions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,28 @@ suite('HTML Completion', () => {
});
});

suite('Live TSServer inside the HTML script tags', () => {
const fixtureRoot = path.resolve(__dirname, '../../src/test/jsdocImportFixtures');
const fixtureWorkspace = { name: 'fixture', uri: URI.file(fixtureRoot).toString() };
const indexHtmlUri = URI.file(path.resolve(fixtureRoot, 'index.html')).toString();

test('Imports across files when using fixtured data from the file system', async () => {
await testCompletionFor('<html><script>/** @type {import("./jsDocTypes").SomeType } */\nconst a = {}; \n a.| \n</script><html>', {
items: [
{ label: 'other' },
{ label: 'property' },
]
}, indexHtmlUri, [fixtureWorkspace]);
});

test('Does not run the extended tsserver when _not_ using the local file system', async () => {
await testCompletionFor('<html><script>/** @type {import("./jsDocTypes").SomeType } */\nconst a {};\n a.|</script></html>', {
// As it's an 'any' then it has no completions
items: []
}, 'vfs://index.html', [{ name: 'vfs', uri: 'vfs://' }]);
});
});

suite('HTML Path Completion', () => {
const triggerSuggestCommand = {
title: 'Suggest',
Expand Down
1 change: 1 addition & 0 deletions extensions/html-language-features/server/src/test/jsdocImportFixtures/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

4 changes: 4 additions & 0 deletions extensions/html-language-features/server/src/test/jsdocImportFixtures/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
9 changes: 9 additions & 0 deletions extensions/html-language-features/server/src/test/jsdocImportFixtures/jsDocTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

export type SomeType = {
property: string
other: number
};