Skip to content

Get preEmit diagnostics from TypeScript before transforming #1301

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

Merged
Perryvw merged 1 commit into from
Jul 8, 2022
Merged

Get preEmit diagnostics from TypeScript before transforming #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 4 additions & 8 deletions src/transpilation/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ export function transpileFiles(
writeFile?: ts.WriteFileCallback
): EmitResult {
const program = ts.createProgram(rootNames, options);
const preEmitDiagnostics = ts.getPreEmitDiagnostics(program);
const { diagnostics: transpileDiagnostics, emitSkipped } = new Transpiler().emit({ program, writeFile });
const diagnostics = ts.sortAndDeduplicateDiagnostics([
...ts.getPreEmitDiagnostics(program),
...transpileDiagnostics,
]);
const diagnostics = ts.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics]);

return { diagnostics: [...diagnostics], emitSkipped };
}
Expand Down Expand Up @@ -98,12 +96,10 @@ export function transpileVirtualProject(
options: CompilerOptions = {}
): TranspileVirtualProjectResult {
const program = createVirtualProgram(files, options);
const preEmitDiagnostics = ts.getPreEmitDiagnostics(program);
const collector = createEmitOutputCollector();
const { diagnostics: transpileDiagnostics } = new Transpiler().emit({ program, writeFile: collector.writeFile });
const diagnostics = ts.sortAndDeduplicateDiagnostics([
...ts.getPreEmitDiagnostics(program),
...transpileDiagnostics,
]);
const diagnostics = ts.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics]);

return { diagnostics: [...diagnostics], transpiledFiles: collector.files };
}
Expand Down
7 changes: 3 additions & 4 deletions src/tstl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,11 @@ function performCompilation(
configFileParsingDiagnostics,
});

const preEmitDiagnostics = ts.getPreEmitDiagnostics(program);

const { diagnostics: transpileDiagnostics, emitSkipped } = new tstl.Transpiler().emit({ program });

const diagnostics = ts.sortAndDeduplicateDiagnostics([
...ts.getPreEmitDiagnostics(program),
...transpileDiagnostics,
]);
const diagnostics = ts.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics]);

diagnostics.forEach(reportDiagnostic);
const exitCode =
Expand Down
20 changes: 20 additions & 0 deletions test/unit/comments.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,23 @@ test("JSDoc is copied on a variable", () => {
expect(lua).toBeDefined();
expect(lua).toContain("This is a variable comment.");
});

// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1299
test("tsdoc comment does not cause a diagnostic (#1299)", () => {
util.testModule`
interface LuaBootstrap {
/**
* @remarks
*
* Links can point to a URL: {@link https://github.com/microsoft/tsdoc}
*/
on_init(f: (() => void) ): void
}

const script : LuaBootstrap = {
on_init: (x) => x()
}

script.on_init(() => {})
`.expectToHaveNoDiagnostics();
});
6 changes: 2 additions & 4 deletions test/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,17 +223,15 @@ export abstract class TestBuilder {
@memoize
public getLuaResult(): tstl.TranspileVirtualProjectResult {
const program = this.getProgram();
const preEmitDiagnostics = ts.getPreEmitDiagnostics(program);
const collector = createEmitOutputCollector();
const { diagnostics: transpileDiagnostics } = new tstl.Transpiler({ emitHost: this.getEmitHost() }).emit({
program,
customTransformers: this.customTransformers,
writeFile: collector.writeFile,
});

const diagnostics = ts.sortAndDeduplicateDiagnostics([
...ts.getPreEmitDiagnostics(program),
...transpileDiagnostics,
]);
const diagnostics = ts.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics]);

return { diagnostics: [...diagnostics], transpiledFiles: collector.files };
}
Expand Down