TypeScript プロジェクトに Jest をインストールする

TypeScript のプロジェクトにテストフレームワークの Jest を導入する方法です。

インストール

プロジェクトに Jest を追加します。

yarn add jest @types/jest ts-jest --dev

ts-jest config:init コマンドを実行して ts-jest を初期化します。

yarn ts-jest config:init

コマンドが成功すると jest.config.js ファイルが生成されます。このファイルに Jest の設定を追加していきます。

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
};

jest.config.js にテスト対象とするファイルのパターンを追加します。 test フォルダー内にテストファイルを置いている場合には以下の様になります。

module.exports = {
    preset: "ts-jest",
    testEnvironment: "node",

    testMatch: [
        "**/test/**/*.ts?(x)"
    ],
};

Jest によるテストは jest コマンドで実行します。 package.json の scripts に以下の様にショートカットを追加します。

"test": "jest"

ショートカットを追加した場合、以下のコマンドでテストを実行できるようになります。今はまだテストコードがないため失敗します。

npm test