2017-09-10

TypeScript の tsconfig.json を考える - コンパイル・オプション編

TypeScript の tsconfig.json について検討を続けています. 今回はコンパイル・オプションについて考えます.

作業環境

Windows 10 64bit
Node.js 8.4.0 64bit
TypeScript 2.4

これまでの振り返り

TypeScript で Hello World では、Visual Studio Code の公式ドキュメントの tsconfig.json を基に作成し、最小限のコンパイル・オプションを考え、ECMAScript の最新に合わせた形になりました.

{
    "compilerOptions": {
        "target": "es2017",
        "module": "commonjs",
        "sourceMap": true
    }
}

続いて、TypeScript の tsconfig.json を考えるでは、コンパイル対象のソースファイルを指定する方法として files と include/exclude を考え、とりあえず TypeScript 公式ドキュメントの include/exclude サンプルを使うことにしました.

{
    "compilerOptions": { ... },
    "include": [
        "src/**/*"
    ],
    "exclude": [
        "node_modules",
        "**/*.spec.ts"
    ]
}

コンパイル・オプションの検討

コンパイル・オプションは最小限の設定しか見ていなかったので、しっかりと確認したいと思います.
TypeScript 公式ドキュメントの Compiler Options は https://www.typescriptlang.org/docs/handbook/compiler-options.html になります.
ざっと 70個ぐらいのオプションがあるようで… とりあえず使いそう or 要検討なところをピックアップしたいと思います.

tsc --init で作られる tsconfig.json がカテゴリー別に整理されているので、それに合わせて検討します.

Basic Options

"target": "es2017" は、前回検討の通り最新の es2017 にします.
"module": "commonjs" は、実行環境の Node.js に合わせて commonjs にします
"lib": [] は、コンパイルに含めるライブラリー、必要になったら都度追加します
"declaration": true は、型定義ファイル *.d.ts を生成するので使用します
"sourceMap": true は、デバッガー等のツール連携で使用します
"outDir": "./dist" は、コンパイル結果などの出力先ですが、命名に悩みつつ distribution で dist かな…
"removeComments": true は、コンパイル後もコメントを保持する必要はないので、削除します.

※ outDir は悩ましいところです. 一般的なルールが欲しい… GitHub を見ていると OutDir や out が多いよう感じました.

Strict Type-Checking Options

"strict": true
すべての strict タイプ・オプション(noImplicitAny, strictNullChecks, noImplicitThis, alwaysStrict) を有効化するので使います.
このカテゴリは strict だけで賄えます.

Additional Checks

基本厳しくチェックなので、すべて true にします.

"noUnusedLocals": true は、未使用のローカル変数をエラー報告します
"noUnusedParameters": true は、未使用のパラメーターをエラー報告します
"noImplicitReturns": true は、不正確な return をエラー報告します
"noFallthroughCasesInSwitch": true は、 case 文のフォールスルーをエラー報告します

Module Resolution Options

おそらく types でパッケージを指定するぐらいです.

Source Map Options

ソース・マッピングに関する設定を変更する場合に設定するようですが、使わなそうです.

Experimental Options

実験用. とはいえ、 experimentalDecorators は使いたいです.
Decorators を使えるようにするもので、 2017年8月現在で Stage 2 であり、今後仕様が変わるかもしれませんが、フレームワークなどで使ったりするので、 true にしておきます.

その他

tsc --init で出力されていないけど、設定した方がよさそうなもの.

"newLine": "LF" は、デフォルトがプラットフォーム依存なので明示しておきます
"forceConsistentCasingInFileNames": true は、ファイルの大文字小文字の違いをエラー報告します

とりえずの設定

前回と合わせて、こんな感じでしょうか. まずはこれで始めたいと思います.

{
    "compilerOptions": {
        "target": "es2017",
        "module": "commonjs",
        "declaration": true,
        "sourceMap": true,
        "outDir": "./dist",
        "removeComments": true,
        "strict": true,
        "noUnusedLocals": true,
        "noUnusedParameters": true,
        "noImplicitReturns": true,
        "noFallthroughCasesInSwitch": true,
        "experimentalDecorators": true,
        "newLine": "LF",
        "forceConsistentCasingInFileNames": true
    },
    "include": [
        "src/**/*"
    ],
    "exclude": [
        "node_modules",
        "**/*.spec.ts"
    ]
}