TypeScript での Tsconfig 参照

TypeScript で tsconfig 参照を導入します。

TypeScript での tsconfig 参照

tsconfig ファイルを使用すると、アプリケーションのさまざまな部分を個別の TypeScript モジュールとして定義できます。 このファイルを使用すると、各モジュールを個別に構成し、アプリケーションのニーズに応じてビルドできます。

TypeScript 3.0 で導入された主な変更点がいくつかあります。 tsconfig.json ファイルの名前が tsconfig-base.json に変更されました。

これにより、ルート フォルダーは TypeScript プロジェクトと見なされなくなります。TypeScript では、ディレクトリを TypeScript プロジェクトと見なすために tsconfig.json が存在する必要があるためです。

現在のプロジェクト体制は以下の通りです。

tsproject/
    src/
        entity.ts # exports an entity
        tsconfig.json
    test/
        entity.spec.ts # imports an entity
        tsconfig.json
    tsconfig-base.json

上記の例からわかるように、src と test の両方に tsconfig.json ファイルが含まれています。 このため、それらは別個のプロジェクトと見なされます。 しかし、両方のファイルの内容を調べると、それらは似ています。

同時に、すべての構成が tsconfig-base.json ファイルに保存され、このファイルは両方の tsconfig.json ファイルに継承されます。

ここで、src フォルダーと test フォルダーがどのようにリンクされて機能するのか、またこれらのフォルダー間の関係がどのように形成されているのか疑問に思うはずです。 TypeScript 3.0 バージョンでは、両方のフォルダーを composite として宣言することで外部から参照されます。

src および test 構成ファイルの内容を以下に示します。

// src configuration in /src/tsconfig.json
{
    "extends": "../tsconfig-base.json",
    "compilerOptions": {
        // compiler options
        "composite": true
    }
}
// test configuration in /test/tsconfig.json
{
    "extends": "../tsconfig-base.json",
        "references": [
        { "path": "../src" }
    ]
}

それでは、テストを実行する方法について説明しましょう。 テストを実行する前に、src をビルドしたことを確認する必要があります。

以下に示すように、コンソールで次のコマンドを使用して簡単にビルドできます。

tsc --build src