Skip to content

9.1 tsconfig.jsonによるコンパイラオプションの設定

TypeScriptを使用するプロジェクトにおいて環境構築の要となるのが tsconfig.json です。このファイルを用意することで、TypeScriptコンパイラ(tsc)が自動的に設定を読み込んでくれます。

ゼロから手書きする必要はなく、コンパイラの機能を使って自動生成するのが一般的です。

  • 生成コマンド: npx tsc --init を実行することでカレントディレクトリに tsconfig.json が生成されます。
  • ファイルの特徴: 生成されたファイルには、利用可能なコンパイラオプションとその説明がコメントとして多数記載されています。必要なオプションのコメントアウトを外すだけで、簡単に設定を編集できるよう配慮されています。
  • 環境構築の基本手順: npm init でパッケージ管理を開始し、npm install -D typescript でコンパイラをインストールした後、npx tsc --init を実行して設定ファイルを作るのが一般的な流れです。

9.1.2 ファイルパス周りの設定を押さえる

Section titled “9.1.2 ファイルパス周りの設定を押さえる”

「どのファイルをコンパイルの対象とするか」を指定するための主要なオプションです。

  • include オプション: コンパイルの対象(起点)となるファイルを配列で指定します。"src/**/*.ts" のように、**(0個以上のディレクトリ階層)や *(任意のファイル名)といったglobパターンを用いて一括指定することが可能です。
  • exclude オプション: include で指定された範囲から、コンパイルの起点から外したいファイル(例: テストファイルなど)を除外するために使用します。
    • 注意点: exclude は「絶対にコンパイルしない」という設定ではありません。起点からは外れますが、他のコンパイル対象ファイルから import されている場合は、依存関係としてコンパイル対象に含められます。
  • files オプション: include よりも古くからあるオプションで、globパターンを使えずに個別のファイル名を直接配列で指定します。include でカバーしきれない例外的な個別指定(exclude の影響を受けない)などに用いられることがあります。