TypeScript/コンパイルエラーの取り扱い

はじめに

その実装の参考にするため、TypeScript のコンパイルエラーの取り扱いについて調べたい

メモ

TypeScript コンパイラ内部では、コンパイルエラーは「Diagnostic (診断情報)」というオブジェクトで表される

Diagnostic の定義は以下

code:ts

interface Diagnostic extends DiagnosticRelatedInformation {

reportsUnnecessary?: {};

reportsDeprecated?: {};

source?: string;

relatedInformation?: DiagnosticRelatedInformation[];

}

interface DiagnosticRelatedInformation {

category: DiagnosticCategory;

code: number;

file: SourceFile | undefined;

start: number | undefined;

length: number | undefined;

messageText: string | DiagnosticMessageChain;

}

色付きの出力になる

syntactic diagnostic

シンタックスに関するエラー情報を含むもので、パース時に収集される

semantic diagnostic

シンタックス以外のエラー情報を含むもので、パース以外 (型検査など) のフェーズで収集される

前者は1ファイルだけ解析すれば収集できて、後者は複数ファイルを解析しないと収集できない

code:src/a.ts

const _num == 0; // ',' expected.

const _str: string = 1; // Type 'number' is not assignable to type 'string'.

code:src/b.ts

const _num == 0; // ',' expected.

const _str: string = 1; // Type 'number' is not assignable to type 'string'.

code:console

$ npx tsc

src/a.ts:1:12 - error TS1005: ',' expected.

1 const _num == 0;

~~

src/b.ts:1:12 - error TS1005: ',' expected.

1 const _num == 0;

~~

Found 2 errors in 2 files.

Errors Files

1 src/a.ts:1

1 src/b.ts:1

semantic diagnostic は出力されない

一方 tsserver では semantic diagnostic も出力される

https://gyazo.com/9b4287f11fedcc39fefa9633e9a963a2

構文的に正しくないファイルがある時は、大量の semantic diagnostic が出がち

仮に semantic diagnostic を出力してしまうと開発者が出力の量に圧倒されてしまう

それを避けるために、syntactic diagnostic は出すけど、semantic diagnostic は出さないようにしてるのだろう。勘だが...

気が利いてる