Skip to content
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

feat(typescript): re-support extra virtual scripts for LSP and Kit #132

Merged
merged 1 commit into from
Feb 4, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 25 additions & 5 deletions packages/language-core/lib/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,37 @@ export interface CodeInformation {
format: boolean;
}

export interface ServiceScript {
code: VirtualCode;
extension: '.ts' | '.js' | '.mts' | '.mjs' | '.cjs' | '.cts' | '.d.ts' | string;
scriptKind: ts.ScriptKind;
}

export interface ExtraServiceScript extends ServiceScript {
fileName: string;
}

export interface LanguagePlugin<T extends VirtualCode = VirtualCode> {
createVirtualCode(fileId: string, languageId: string, snapshot: ts.IScriptSnapshot, files?: FileRegistry): T | undefined;
updateVirtualCode(fileId: string, virtualCode: T, newSnapshot: ts.IScriptSnapshot, files?: FileRegistry): T;
disposeVirtualCode?(fileId: string, virtualCode: T, files?: FileRegistry): void;
typescript?: {
/**
* LSP + TS Plugin
*/
extraFileExtensions: ts.FileExtensionInfo[];
/**
* LSP + TS Plugin
*/
getScript(rootVirtualCode: T): ServiceScript | undefined;
/**
* LSP only
*/
getExtraScripts?(fileName: string, rootVirtualCode: T): ExtraServiceScript[];
/**
* LSP only
*/
resolveLanguageServiceHost?(host: ts.LanguageServiceHost): ts.LanguageServiceHost;
getScript(rootVirtualCode: T): {
code: VirtualCode;
extension: '.ts' | '.js' | '.mts' | '.mjs' | '.cjs' | '.cts' | '.d.ts' | string;
scriptKind: ts.ScriptKind;
} | undefined;
};
}

Expand All @@ -75,6 +94,7 @@ export interface LanguageContext {
sys: ts.System & { sync?(): Promise<number>; };
projectHost: TypeScriptProjectHost;
languageServiceHost: ts.LanguageServiceHost;
getExtraScript(fileName: string): ExtraServiceScript | undefined;
};
}

Expand Down
14 changes: 10 additions & 4 deletions packages/language-server/lib/register/registerEditorFeatures.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,16 @@ export function registerEditorFeatures(
if (uri.startsWith(rootUri)) {
const sourceFile = languageService.context.language.files.get(uri);
if (sourceFile?.generated) {
const virtualFile = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
if (virtualFile) {
const { snapshot } = virtualFile.code;
fs.writeFile(uri + virtualFile.extension, snapshot.getText(0, snapshot.getLength()), () => { });
const mainScript = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
if (mainScript) {
const { snapshot } = mainScript.code;
fs.writeFile(fileName + mainScript.extension, snapshot.getText(0, snapshot.getLength()), () => { });
}
if (sourceFile.generated.languagePlugin.typescript?.getExtraScripts) {
for (const extraScript of sourceFile.generated.languagePlugin.typescript.getExtraScripts(uri, sourceFile.generated.code)) {
const { snapshot } = extraScript.code;
fs.writeFile(fileName, snapshot.getText(0, snapshot.getLength()), () => { });
}
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions packages/typescript/lib/node/decorateLanguageServiceHost.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,9 @@ export function decorateLanguageServiceHost(
patchedText += script.code.snapshot.getText(0, script.code.snapshot.getLength());
}
snapshotSnapshot = ts.ScriptSnapshot.fromString(patchedText);
if (sourceFile.generated.languagePlugin.typescript?.getExtraScripts) {
console.warn('getExtraScripts() is not available in this use case.');
}
}
}
else if (virtualFiles.get(fileName)) {
Expand Down
8 changes: 6 additions & 2 deletions packages/typescript/lib/node/proxyCreateProgram.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,16 @@ export function proxyCreateProgram(
assert(!!sourceFile, '!!sourceFile');
let patchedText = originalSourceFile.text.split('\n').map(line => ' '.repeat(line.length)).join('\n');
let scriptKind = ts.ScriptKind.TS;
if (sourceFile.generated) {
const script = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
if (sourceFile.generated?.languagePlugin.typescript) {
const { getScript, getExtraScripts } = sourceFile.generated.languagePlugin.typescript;
const script = getScript(sourceFile.generated.code);
if (script) {
scriptKind = script.scriptKind;
patchedText += script.code.snapshot.getText(0, script.code.snapshot.getLength());
}
if (getExtraScripts) {
console.warn('getExtraScripts() is not available in this use case.');
}
}
sourceFile2 = ts.createSourceFile(
fileName,
Expand Down
60 changes: 51 additions & 9 deletions packages/typescript/lib/protocol/createProject.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { createFileRegistry, FileMap, LanguagePlugin, LanguageContext, TypeScriptProjectHost } from '@volar/language-core';
import { createFileRegistry, FileMap, LanguagePlugin, LanguageContext, TypeScriptProjectHost, ExtraServiceScript } from '@volar/language-core';
import type * as ts from 'typescript';
import { forEachEmbeddedCode } from '@volar/language-core';
import * as path from 'path-browserify';
Expand Down Expand Up @@ -51,7 +51,7 @@ export function createLanguage(
}
});

let languageServiceHost = createLanguageServiceHost();
let { languageServiceHost, getExtraScript } = createLanguageServiceHost();

for (const language of languagePlugins) {
if (language.typescript?.resolveLanguageServiceHost) {
Expand Down Expand Up @@ -134,6 +134,7 @@ export function createLanguage(
sys,
projectHost,
languageServiceHost,
getExtraScript,
},
};

Expand All @@ -142,6 +143,7 @@ export function createLanguage(
let lastProjectVersion: number | string | undefined;
let tsProjectVersion = 0;
let tsFileRegistry = new FileMap<boolean>(sys.useCaseSensitiveFileNames);
let extraScriptRegistry = new FileMap<ExtraServiceScript>(sys.useCaseSensitiveFileNames);
let lastTsVirtualFileSnapshots = new Set<ts.IScriptSnapshot>();
let lastOtherVirtualFileSnapshots = new Set<ts.IScriptSnapshot>();

Expand Down Expand Up @@ -201,14 +203,21 @@ export function createLanguage(
return getScriptVersion(fileName) !== '';
},
getProjectVersion() {
syncProject();
sync();
return tsProjectVersion + ('version' in sys ? `:${sys.version}` : '');
},
getScriptFileNames() {
syncProject();
sync();
return [...tsFileRegistry.keys()];
},
getScriptKind(fileName) {

sync();

if (extraScriptRegistry.has(fileName)) {
return extraScriptRegistry.get(fileName)!.scriptKind;
}

const sourceFile = files.get(fileNameToFileId(fileName));
if (sourceFile?.generated) {
const tsCode = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
Expand Down Expand Up @@ -239,9 +248,17 @@ export function createLanguage(
getScriptSnapshot,
};

return languageServiceHost;
return {
languageServiceHost,
getExtraScript,
};

function getExtraScript(fileName: string) {
sync();
return extraScriptRegistry.get(fileName);
}

function syncProject() {
function sync() {

const newProjectVersion = projectHost.getProjectVersion?.();
const shouldUpdate = newProjectVersion === undefined || newProjectVersion !== lastProjectVersion;
Expand All @@ -250,6 +267,7 @@ export function createLanguage(
}

lastProjectVersion = newProjectVersion;
extraScriptRegistry.clear();

const newTsVirtualFileSnapshots = new Set<ts.IScriptSnapshot>();
const newOtherVirtualFileSnapshots = new Set<ts.IScriptSnapshot>();
Expand All @@ -261,10 +279,15 @@ export function createLanguage(
const script = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
if (script) {
newTsVirtualFileSnapshots.add(script.code.snapshot);
tsFileNamesSet.add(fileName); // virtual .ts
tsFileNamesSet.add(fileName);
}
for (const file of forEachEmbeddedCode(sourceFile.generated.code)) {
newOtherVirtualFileSnapshots.add(file.snapshot);
for (const extraScript of sourceFile.generated.languagePlugin.typescript?.getExtraScripts?.(fileName, sourceFile.generated.code) ?? []) {
newTsVirtualFileSnapshots.add(extraScript.code.snapshot);
tsFileNamesSet.add(extraScript.fileName);
extraScriptRegistry.set(extraScript.fileName, extraScript);
}
for (const code of forEachEmbeddedCode(sourceFile.generated.code)) {
newOtherVirtualFileSnapshots.add(code.snapshot);
}
}
else {
Expand All @@ -291,6 +314,12 @@ export function createLanguage(

function getScriptSnapshot(fileName: string) {

sync();

if (extraScriptRegistry.has(fileName)) {
return extraScriptRegistry.get(fileName)!.code.snapshot;
}

const sourceFile = files.get(fileNameToFileId(fileName));

if (sourceFile?.generated) {
Expand All @@ -306,12 +335,24 @@ export function createLanguage(

function getScriptVersion(fileName: string): string {

sync();

if (!scriptVersions.has(fileName)) {
scriptVersions.set(fileName, { lastVersion: 0, map: new WeakMap() });
}

const version = scriptVersions.get(fileName)!;

if (extraScriptRegistry.has(fileName)) {
const snapshot = extraScriptRegistry.get(fileName)!.code.snapshot;
if (!version.map.has(snapshot)) {
version.map.set(snapshot, version.lastVersion++);
}
return version.map.get(snapshot)!.toString();
}

const sourceFile = files.get(fileNameToFileId(fileName));

if (sourceFile?.generated) {
const script = sourceFile.generated.languagePlugin.typescript?.getScript(sourceFile.generated.code);
if (script) {
Expand All @@ -323,6 +364,7 @@ export function createLanguage(
}

const isOpenedFile = !!projectHost.getScriptSnapshot(fileName);

if (isOpenedFile) {
const sourceFile = files.get(fileNameToFileId(fileName));
if (sourceFile && !sourceFile.generated) {
Expand Down