Skip to main content

LensStudio:TypeScript

Module

Module exposing the editor TypeScript compilation API for triggering and inspecting project compilations.

Example

const FileSystem = await import('LensStudio:FileSystem');
const { ITypeScriptCompilationApi } = await import('LensStudio:TypeScript');

const compiler = this.pluginSystem.findInterface(ITypeScriptCompilationApi) as ITypeScriptCompilationApi;
if (Editor.isNull(compiler)) {
console.log('TypeScript compilation API unavailable');
return;
}

const tmp = FileSystem.TempDir.create();
const src = tmp.path.appended(new Editor.Path('Src'));
FileSystem.createDir(src, { recursive: true });
FileSystem.writeFile(
src.appended(new Editor.Path('snippet.ts')),
'export const greeting: string = "hello";\n',
);
FileSystem.writeFile(
src.appended(new Editor.Path('tsconfig.json')),
JSON.stringify({
compilerOptions: { module: 'esnext', target: 'es2021', isolatedModules: true, outDir: '../Out' },
include: ['snippet.ts'],
}),
);

const result = await compiler.runIsolatedCompilation(
src.appended(new Editor.Path('tsconfig.json')).toString(),
);
console.log(`Compile succeeded: ${result.succeeded}, errors: ${result.errors.length}`);

Classes

ClassDescription
ITypeScriptCompilationApiPlugin component interface for invoking TypeScript compilation on the current project or an isolated tsconfig.
TypeScriptCompilationResultResult of a TypeScript compilation run, containing success status and any reported errors.