【Jest】テストを実行する

JavaScriptのテスティングフレームワークである「Jest」を使用して、テストを実行します。

手順

以下のコマンドを実行して、必要なパッケージをインストールする。

npm install -D jest @types/jest ts-jest

プロジェクトのルートディレクトリで以下のコマンドを実行して、
設定ファイルを自動的に作成する。

npx ts-jest config:init

プロジェクトのルートディレクトリにjest.config.jsというファイルが作成される。

sum.tsを以下のように編集する。

export const sum = (a: number, b: number): number => {
    return a + b;
};

sum.test.tsを以下のように編集する。

import { sum } from './sum';

test('1と2を渡すと、3を返す', () => {
    expect(sum(1, 2)).toBe(3);
});

以下のようなコマンドを実行すると、テストが実行される。

npx jest

package.jsonを以下のように編集して「test」スクリプトを設定することで、
スクリプトの内容を「npm run test」というコマンドで実行できるようになって便利です。

{
  ...
  "scripts": {
    "test": "jest"
  },
  ...
}