Jestでdotenvを使って環境変数を読み込む

Jest を使ったテストで環境変数を読み込ませたい場合があります。そんなときは dotenv を使いましょう。jest.config.js と VSCode の設定ファイルを修正するだけで動きます。

1. .env ファイルを用意する

dotenv をインストールして、リポジトリのルートに.envファイルを追加します。.envを間違ってコミットする前に、gitignore へと登録しておきましょう。

yarn add dotenv

2. jest.config.js を修正する

以下のように setupFiles を追加します。

module.exports = {
  roots: ["<rootDir>"],
  testMatch: ["**/*.test.ts"],
  transform: {
    "^.+\\.tsx?$": "ts-jest",
  },
  setupFiles: ["dotenv/config"],
};

3. VSCode の settings.json を修正する

VSCode に拡張機能 vscode-jest をインストールして実行している場合は、settings.json も修正します。

// Place your settings in this file to overwrite the default settings
{
  // jest実行コマンド
  "jest.jestCommandLine": "yarn test --run-in-band --setupFiles dotenv/config"
}