ECMAScript モジュール
Jest は ECMAScript モジュール (ESM) の実験的なサポートを提供しています。
実装にはバグや機能不足がある可能性があります。 For the latest status check out the issue and the label on the issue tracker.
また、Jest が ESM サポートを実装するのに使用している API は、まだ Node により実験的であるとされていることに注意してください (バージョン 18.8.0
時点)。
With the warnings out of the way, this is how you activate ESM support in your tests.
transform: {}
を渡すことで、コード変換を無効にするか、デフォルトの CommonJS (CJS) ではなく ESM を出力するように変換を設定します。node
を--experimental-vm-modules
オプションを付けて実行します。例:node --experimental-vm-modules node_modules/jest/bin/jest.js
またはNODE_OPTIONS=--experimal-vm-modules npx jest
など。On Windows, you can use
cross-env
to be able to set environment variables.If you use Yarn, you can use
yarn node --experimental-vm-modules $(yarn bin jest)
. This command will also work if you use Yarn Plug'n'Play.Beyond that, we attempt to follow
node
's logic for activating "ESM mode" (such as looking attype
inpackage.json
ormjs
files), see their docs for details.
ESM と CommonJS の違い
Most of the differences are explained in Node's documentation, but in addition to the things mentioned there, Jest injects a special variable into all executed files - the jest
object. To access this object in ESM, you need to import it from the @jest/globals
module.
import {jest} from '@jest/globals';
jest.useFakeTimers();
// etc.
Additionally, since ESM evaluates static import
statements before looking at the code, the hoisting of jest.mock
calls that happens in CJS won't work in ESM. To mock modules in ESM, you need to use require
or dynamic import()
after jest.mock
calls to load the mocked modules - the same applies to modules which load the mocked modules.
const {BrowserWindow, app} = require('electron');
// etc.
module.exports = {example};
import {createRequire} from 'node:module';
import {jest} from '@jest/globals';
const require = createRequire(import.meta.url);
jest.mock('electron', () => ({
app: {
on: jest.fn(),
whenReady: jest.fn(() => Promise.resolve()),
},
BrowserWindow: jest.fn().mockImplementation(() => ({
// 部分的なモック
})),
}));
const {BrowserWindow} = require('electron');
const exported = require('./main.cjs');
// または
const {BrowserWindow} = (await import('electron')).default;
const exported = await import('./main.cjs');
// etc.
Please note that we currently don't support jest.mock
in a clean way in ESM, but that is something we intend to add proper support for in the future. Follow this issue for updates.