Jest24.0.0~の設定変更: setupTestFrameworkScriptFileからsetupFilesAfterEnvへ

まとめ

Jest 24.0.0 から setupTestFrameworkScriptFile から setupFilesAfterEnv への変更はが推奨されました。
より柔軟なテストセットアップを可能にするための改善です。
Jest 24.0.0 以降のバージョンを使用する際は、この変更点に注意してください。

setupTestFrameworkScriptFile とは

以前の Jest バージョンでは、テストの前処理や後処理を行うための設定として setupTestFrameworkScriptFile が使われていました。この設定では、指定したファイルがテストフレームワークのセットアップ時に実行されていました。

{
  "jest": {
    "setupTestFrameworkScriptFile": "<path/to/setup/file>"
  }
}

例えば共通でimportしたいライブラリを記載してみたりして使用します。

import 'jest-enzyme'

setupFilesAfterEnv への変更

しかし、Jest の新しいバージョンでは、setupTestFrameworkScriptFile が非推奨となり、代わりに setupFilesAfterEnv を使用するようになりました。setupFilesAfterEnv は、テスト環境のセットアップ後に実行されるファイルを指定します。

{
  "jest": {
    "setupFilesAfterEnv": ["<path/to/setup/file>"]
  }
}

変更されたバージョン

この変更は、Jest の 24.0.0 バージョンから導入され、setupTestFrameworkScriptFile から setupFilesAfterEnv への移行が推奨されるようになりました。Jest 24.0.0 以降のバージョンを使用する場合は、setupFilesAfterEnv を使用することが望ましいです。
Jest 24.1.0 以降のバージョンでは廃止されました。

変更の理由

この変更は、Jest の内部動作の改善と、より柔軟な設定オプションを提供するために行われました。setupFilesAfterEnv は配列を受け取るため、複数のセットアップファイルを指定することができます。これにより、テストの前処理や後処理を細かく制御できるようになりました。