できない.dev

Vitest を 4 から 5 に上げると動かなくなること

Vitest を 4 から 5 に上げると、clearMocks が既定で有効になり、await していない resolves や describe の中の vi.mock でテストが落ちる。
4 と 5 で同じテストを打ち比べた 8 つの変更点と直し方をまとめる。

公開: 更新:

vitest@4 を入れたプロジェクトと、同じファイルのまま vitest@5 に上げたプロジェクトを並べ、同じコマンドを打ち比べた。
各節の出力は「v4 では」「v5 に上げると」「v5 で直すと」の 3 段で並ぶ。

公式の移行ガイドによると、5 は Node.js 22.12.0 以上と Vite 6.4.0 以上を求める。
vitest@5.1.0 の engines は ^22.12.0 || ^24.0.0 || >=26.0.0 で、23 と 25 は含まない。
Vite は vitest の dependencies から外れ、peerDependencies だけに残った。
npm は peerDependencies も自動で入れるので、今回は vitest@5 を入れただけで Vite 8.3.6 が入った。
Yarn は自動で入れないため、yarn add -D vite を別に打つ必要がある。

動かなくなる原因は 4 つに分かれる。
1 つ目は、4.1 が警告だけを出していた書き方が 5 でエラーになったことである。
describe の中の vi.mock と、await していない resolves がこれに当たり、4.1 の出力に「This will become an error in a future version.」のような予告が出ていた。

2 つ目は既定の挙動の変化で、Vitest は変わったことを知らせない。
clearMocks ではテストが AssertionError で落ち、-t では 1 本も当たらないまま終了コード 0 で終わる。
3 つ目は、describe.sequential やベンチマークの書き方のように API が無くなったことである。
4 つ目は設定ファイルを探す場所とレポートを書く場所の変化で、テストのコードはそのままでも結果の出方が変わる。

上げる前に 4.1 で npx vitest run を打つと、describe の中の vi.mock と await していない resolves の 2 つは、Warning: の行や will cause the test to fail を含む行で先に分かる。
ほかの 6 つは、このページの 4.1.12 の出力に 5 での変更を予告する行が出なかった(ベンチマークには、実験的な機能だという断り書きだけが出た)。

このページで打っていない変更点は、公式の移行ガイドに一覧がある。
test.projects にその場で書いたプロジェクトは、ルートの設定を既定で引き継ぐようになった(extends の既定が true)。
test.each と test.for の名前に $ で差し込んだ文字列は、引用符で囲まれなくなった。
toThrow("") はどのエラー文にも一致するようになり、VITEST_WORKER_ID などの番号は 1 から数えるようになった。
ブラウザモードのロケーター、expect.poll のタイムアウト、Temporal の偽装、vitest/reporters などの古い入口の削除も、このページでは打っていない。

clearMocks が既定で有効になった

clearMocks は、各テストの前に vi.clearAllMocks() を呼んでモックの呼び出しの記録を消す設定である。
5 で既定が true になった。
消えるのは呼び出しの記録だけで、mockReturnValue などで決めた振る舞いは残る。
公式の移行ガイドは、beforeAll・セットアップファイル・ファイルの最上位で起きた呼び出しを、あとのテストで数えているテストが最も影響を受けるとしている。
ガイドの例のように、前のテストで起きた呼び出しを次のテストで合わせて数えるテストも、5 では数が合わなくなる。

v4 では

$ cat cart.test.js
import { beforeAll, expect, test, vi } from "vitest";
import { createCart } from "./cart.js";
 
const track = vi.fn();
let cart;
 
beforeAll(() => {
  cart = createCart({ track });
});
 
test("tracks cart creation", () => {
  expect(track).toHaveBeenCalledWith("cart:create");
});
 
test("tracks added items", () => {
  cart.add("apple");
  expect(track).toHaveBeenCalledTimes(2);
});
$ npx vitest run
 RUN  v4.1.12 /work/v4/clear-mocks
 
 ✓ cart.test.js (2 tests) 3ms
 
 Test Files  1 passed (1)
      Tests  2 passed (2)
   Start at  03:36:00
   Duration  121ms (transform 21ms, setup 0ms, import 30ms, tests 3ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run
 RUN  v5.1.0 /work/v5/clear-mocks
 
 ❯ cart.test.js (2 tests | 2 failed) 5ms
   × tracks cart creation 3ms
   × tracks added items 1ms
 
⎯⎯⎯⎯⎯⎯⎯ Failed Tests 2 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  cart.test.js > tracks cart creation
AssertionError: expected "vi.fn()" to be called with arguments: [ 'cart:create' ]
 
Number of calls: 0
 
 ❯ cart.test.js:12:17
     10|
     11| test("tracks cart creation", () => {
     12|   expect(track).toHaveBeenCalledWith("cart:create");
       |                 ^
     13| });
     14|
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/2]⎯
 
 FAIL  cart.test.js > tracks added items
AssertionError: expected "vi.fn()" to be called 2 times, but got 1 times
 ❯ cart.test.js:17:17
     15| test("tracks added items", () => {
     16|   cart.add("apple");
     17|   expect(track).toHaveBeenCalledTimes(2);
       |                 ^
     18| });
     19|
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[2/2]⎯
 
 Test Files  1 failed (1)
      Tests  2 failed (2)
   Start at  03:36:00
   Duration  129ms (transform 49%, import 28%, tests 15%, worker 8%)
$ echo $?
1

v5 で直すと

$ cat vitest.config.js
import { defineConfig } from "vitest/config";
 
export default defineConfig({
  test: { clearMocks: false },
});
$ npx vitest run
 RUN  v5.1.0 /work/v5/clear-mocks
 
 ✓ cart.test.js (2 tests) 5ms
 
 Test Files  1 passed (1)
      Tests  2 passed (2)
   Start at  03:36:01
   Duration  116ms (transform 54%, import 23%, tests 14%, worker 8%)
$ echo $?
0

5 では 2 本とも落ちた。
1 本目は、beforeAll の中で起きた track("cart:create") の記録がテストの前に消え、呼び出しが 0 回になった。
2 本目は、テストの中の cart.add の 1 回だけを数えた。

4 と同じ挙動に戻すには、設定に clearMocks: false を書く。
テストのほうを直すなら、数えたい呼び出しをそのテストの中で起こすように書き直す。
そのテストの中で起きた呼び出しは、cart.add の 1 回のように 5 でも記録に残る。

await していない resolves と rejects でテストが落ちるようになった

4 は、await していない resolves と rejects をテストの終わりに自動で待っていた。
警告は出すが、アサーションが成り立てばテストは通る。
5 は待たずにテストを落とす。
公式の移行ガイドによると、toMatchFileSnapshot も同じ扱いになった。

v4 では

$ cat user.test.js
import { expect, test } from "vitest";
 
const fetchUser = async (id) => ({ id, name: "sato" });
 
test("fetchUser", () => {
  expect(fetchUser(1)).resolves.toEqual({ id: 1, name: "sato" });
});
$ npx vitest run
 RUN  v4.1.12 /work/v4/unawaited-assertion
 
stderr | user.test.js > fetchUser
Promise returned by `expect(actual).resolves.toEqual(expected)` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
    at /work/v4/unawaited-assertion/user.test.js:6:23
 
 ✓ user.test.js (1 test) 6ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:01
   Duration  123ms (transform 13ms, setup 0ms, import 22ms, tests 6ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run
 RUN  v5.1.0 /work/v5/unawaited-assertion
 
 ❯ user.test.js (1 test | 1 failed) 5ms
   × fetchUser 4ms
 
⎯⎯⎯⎯⎯⎯⎯ Failed Tests 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  user.test.js > fetchUser
Error: Promise returned by `expect(actual).resolves.toEqual(expected)` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
 
await expect(actual).resolves.toEqual(expected)
 
 ❯ user.test.js:6:23
      4|
      5| test("fetchUser", () => {
      6|   expect(fetchUser(1)).resolves.toEqual({ id: 1, name: "sato" });
       |                       ^
      7| });
      8|
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  1 failed (1)
   Start at  03:36:02
   Duration  104ms (transform 49%, import 24%, tests 17%, worker 10%)
$ echo $?
1

v5 で直すと

$ cat user.test.js
import { expect, test } from "vitest";
 
const fetchUser = async (id) => ({ id, name: "sato" });
 
test("fetchUser", async () => {
  await expect(fetchUser(1)).resolves.toEqual({ id: 1, name: "sato" });
});
$ npx vitest run
 RUN  v5.1.0 /work/v5/unawaited-assertion
 
 ✓ user.test.js (1 test) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:02
   Duration  105ms (transform 49%, import 32%, worker 10%, tests 8%)
$ echo $?
0

4 の警告にあった「this will cause the test to fail in the next Vitest major」のとおり、5 では同じ文言で始まるエラーになった。
テストの関数を async にし、expect の前に await を付けると通る。
resolves と rejects は Promise を返すので、待たないとテストが終わったあとで結果が出る。

describe の中の vi.mock がエラーになった

vi.mock は、書いた場所にかかわらずファイルの先頭へ巻き上げられる。
describe の中に書いても、モックが効く範囲はその describe に限られず、ファイル全体になる。
4 はこのずれを警告で知らせていたが、5 はエラーで止める。
公式の移行ガイドによると、vi.unmock と vi.hoisted も同じ扱いになった。

v4 では

$ cat calculator.test.js
import { describe, expect, test, vi } from "vitest";
import { add } from "./calculator.js";
 
describe("add", () => {
  vi.mock("./calculator.js", () => ({ add: vi.fn(() => 42) }));
 
  test("returns the mocked value", () => {
    expect(add(1, 2)).toBe(42);
  });
});
$ npx vitest run
 RUN  v4.1.12 /work/v4/hoisted-mock
 
Warning: A vi.mock("./calculator.js") call in "/work/v4/hoisted-mock/calculator.test.js" is not at the top level of the module. Although it appears nested, it will be hoisted and executed before any tests run. Move it to the top level to reflect its actual execution order. This will become an error in a future version.
See: https://vitest.dev/guide/mocking/modules#how-it-works
 ✓ calculator.test.js (1 test) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:03
   Duration  116ms (transform 15ms, setup 0ms, import 26ms, tests 2ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run
 RUN  v5.1.0 /work/v5/hoisted-mock
 
 ❯ calculator.test.js (0 test)
 
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  calculator.test.js [ calculator.test.js ]
Error: 1 call in "calculator.test.js" was defined outside of the module's top level scope:
 
- vi.mock("./calculator.js") at calculator.test.js:5:3
 
Although it appears nested, it will be hoisted and executed before anything in this file. Move it to the top level to reflect its actual execution order.
See: https://vitest.dev/guide/mocking/modules#how-it-works
  Plugin: vitest:mocks
  File: /work/v5/hoisted-mock/calculator.test.js
 ❯ EnvironmentPluginContainer.transform ../node_modules/vite/dist/node/chunks/node.js:8632:51
 ❯ loadAndTransform ../node_modules/vite/dist/node/chunks/node.js:20108:26
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  no tests
   Start at  03:36:03
   Duration  111ms (worker 97%, environment 3%)
$ echo $?
1

v5 で直すと

$ cat calculator.test.js
import { describe, expect, test, vi } from "vitest";
import { add } from "./calculator.js";
 
vi.mock("./calculator.js", () => ({ add: vi.fn(() => 42) }));
 
describe("add", () => {
  test("returns the mocked value", () => {
    expect(add(1, 2)).toBe(42);
  });
});
$ npx vitest run
 RUN  v5.1.0 /work/v5/hoisted-mock
 
 ✓ calculator.test.js (1 test) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:04
   Duration  117ms (transform 60%, import 26%, worker 8%, tests 5%)
$ echo $?
0

vi.mock をファイルの最上位へ移すと通る。
巻き上げたあとの順番と見た目の順番が揃うだけで、モックの効き方は 4 と変わらない。

テストごとに違うモックを使いたいときは、巻き上げられない vi.doMock を使う。
公式の移行ガイドによると、vi.doMock と vi.doUnmock は今までどおりどこで呼んでもよい。
API の説明によると、効くのは呼んだあとに import() したモジュールだけである。
このページでは vi.doMock は打っていない。

describe.sequential と test.sequential が無くなった

describe.sequential と test.sequential は、sequence.concurrent: true などでテストを並行に走らせているときに、一部だけを順番に走らせる指定だった。
5 で無くなり、describe.sequential を呼んだファイルは読み込みの段階で TypeError になる。

v4 では

$ cat vitest.config.js
import { defineConfig } from "vitest/config";
 
export default defineConfig({
  test: { sequence: { concurrent: true } },
});
$ cat counter.test.js
import { describe, expect, test } from "vitest";
 
let count = 0;
 
describe.sequential("counter", () => {
  test("increment", async () => {
    await new Promise((resolve) => setTimeout(resolve, 20));
    count += 1;
  });
 
  test("read", () => {
    expect(count).toBe(1);
  });
});
$ npx vitest run
 RUN  v4.1.12 /work/v4/sequential-removed
 
 ✓ counter.test.js (2 tests) 22ms
 
 Test Files  1 passed (1)
      Tests  2 passed (2)
   Start at  03:36:04
   Duration  122ms (transform 11ms, setup 0ms, import 18ms, tests 22ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run
 RUN  v5.1.0 /work/v5/sequential-removed
 
 ❯ counter.test.js (0 test)
 
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  counter.test.js [ counter.test.js ]
TypeError: describe.sequential is not a function
 ❯ counter.test.js:5:10
      3| let count = 0;
      4|
      5| describe.sequential("counter", () => {
       |          ^
      6|   test("increment", async () => {
      7|     await new Promise((resolve) => setTimeout(resolve, 20));
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  no tests
   Start at  03:36:05
   Duration  123ms (worker 97%, environment 3%)
$ echo $?
1

v5 で直すと

$ cat counter.test.js
import { describe, expect, test } from "vitest";
 
let count = 0;
 
describe("counter", { concurrent: false }, () => {
  test("increment", async () => {
    await new Promise((resolve) => setTimeout(resolve, 20));
    count += 1;
  });
 
  test("read", () => {
    expect(count).toBe(1);
  });
});
$ npx vitest run
 RUN  v5.1.0 /work/v5/sequential-removed
 
 ✓ counter.test.js (2 tests) 22ms
 
 Test Files  1 passed (1)
      Tests  2 passed (2)
   Start at  03:36:05
   Duration  117ms (tests 50%, transform 28%, import 16%, worker 6%)
$ echo $?
0

5 では、describe や test の第 2 引数に { concurrent: false } を渡す。
直したテストは 2 本とも通り、read は increment が count を増やしたあとに走った。
test.sequential("…", fn) は test("…", { concurrent: false }, fn) に書き換える。
オプションのオブジェクトに sequential: true と書いていた場合も、concurrent: false に置き換える。

-t の絞り込みで名前の区切りが「 > 」になった

-t(--testNamePattern)は、テストの名前を正規表現で絞り込むオプションである。
4 は describe の名前とテスト名を空白でつないで照合していた。
5 は、describe の名前とテスト名を「 > 」でつないだ「math > adds」の形で照合する。
レポーターの行と違い、ファイル名は含まない。

v4 では

$ cat math.test.js
import { describe, expect, test } from "vitest";
 
describe("math", () => {
  test("adds", () => {
    expect(1 + 2).toBe(3);
  });
 
  test("subtracts", () => {
    expect(3 - 1).toBe(2);
  });
});
$ npx vitest run -t "math adds"
 RUN  v4.1.12 /work/v4/test-name-pattern
 
 ✓ math.test.js (2 tests | 1 skipped) 3ms
 
 Test Files  1 passed (1)
      Tests  1 passed | 1 skipped (2)
   Start at  03:36:06
   Duration  134ms (transform 15ms, setup 0ms, import 24ms, tests 3ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run -t "math adds"
 RUN  v5.1.0 /work/v5/test-name-pattern
 
 ↓ math.test.js (2 tests | 2 skipped)
 
 Test Files  1 skipped (1)
      Tests  2 skipped (2)
   Start at  03:36:07
   Duration  93ms (transform 55%, import 31%, worker 13%, environment 1%)
$ echo $?
0

v5 で直すと

$ npx vitest run -t "math > adds"
 RUN  v5.1.0 /work/v5/test-name-pattern
 
 ✓ math.test.js (2 tests | 1 skipped) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed | 1 skipped (2)
   Start at  03:36:07
   Duration  87ms (import 45%, transform 24%, worker 19%, tests 11%, environment 1%)
$ echo $?
0

5 では -t "math adds" が 1 本も当たらず、2 本とも飛ばされた。
それでも終了コードは 0 なので、CI はテストを走らせないまま成功する。
package.json の scripts や CI の設定に -t を書いているなら、区切りを「 > 」に直す。
公式の移行ガイドは、区切りに左右されない書き方として -t adds と -t "math.*adds" を挙げている。

親のディレクトリの設定ファイルを読まなくなった

4 は、今いるディレクトリに設定ファイルが無いと、親のディレクトリをさかのぼって vitest.config.js を探していた。
5 はさかのぼらない。
モノレポの直下にだけ設定を置き、packages/web に入って npx vitest run を打つと、5 では設定が読まれない。

v4 では

$ cat vitest.config.js
import { defineConfig } from "vitest/config";
 
export default defineConfig({
  test: { globals: true },
});
$ cat packages/web/sum.test.js
describe("sum", () => {
  it("adds", () => {
    expect(1 + 2).toBe(3);
  });
});
$ npx vitest run
 RUN  v4.1.12 /work/v4/config-parent-dir/packages/web
 
 ✓ sum.test.js (1 test) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:08
   Duration  100ms (transform 9ms, setup 0ms, import 15ms, tests 2ms, environment 0ms)
$ echo $?
0

v5 に上げると

$ npx vitest run
 RUN  v5.1.0 /work/v5/config-parent-dir/packages/web
 
 ❯ sum.test.js (0 test)
 
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  sum.test.js [ sum.test.js ]
ReferenceError: describe is not defined
 ❯ sum.test.js:1:1
      1| describe("sum", () => {
       | ^
      2|   it("adds", () => {
      3|     expect(1 + 2).toBe(3);
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  no tests
   Start at  03:36:08
   Duration  94ms (worker 97%, environment 3%)
$ echo $?
1

v5 で直すと

$ npx vitest run --config ../../vitest.config.js
 RUN  v5.1.0 /work/v5/config-parent-dir/packages/web
 
 ✓ sum.test.js (1 test) 2ms
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:09
   Duration  96ms (transform 49%, import 25%, worker 18%, tests 8%)
$ echo $?
0

5 では globals: true が効かず、describe が定義されていないエラーになった。
設定ファイルそのものが読まれていないので、environment や resolve.alias など、ほかの項目も効かない。

--config で設定ファイルを渡すと通る。
RUN の行は packages/web を指したままで、見つかったテストも sum.test.js の 1 本だった。
公式の移行ガイドは、--config と合わせて --dir でテストを探す範囲を決めるよう勧めている。
毎回 --config を打たずに済ませるなら、パッケージごとに vitest.config.js を置く。

JSON のレポートが標準出力に出なくなった

5 は、json のレポーターの出力を .vitest/json/output.json に書き、標準出力には書いた場所を知らせる 1 行だけを出す。
公式の移行ガイドによると、junit も同じく .vitest/junit/output.xml に書くようになった。
npx vitest run --reporter=json | jq のように、標準出力を別のコマンドに渡していたスクリプトが動かなくなる。

v4 では

$ npx vitest run --reporter=json | jq .numPassedTests
2
$ echo $?
0

v5 に上げると

$ npx vitest run --reporter=json | jq .numPassedTests
parse error: Invalid numeric literal at line 1, column 5
$ echo $?
4
$ npx vitest run --reporter=json
JSON report written to /work/v5/json-reporter/.vitest/json/output.json
$ echo $?
0
$ jq .numPassedTests .vitest/json/output.json
2

v5 で直すと

$ npx vitest run --reporter=json --outputFile=report.json
JSON report written to /work/v5/json-reporter/report.json
$ echo $?
0
$ jq .numPassedTests report.json
2

5 では、jq が 1 行目の 5 文字目で止まった。
パイプを外すと、標準出力には JSON report written to … の 1 行だけが出ており、jq はこの行を JSON として読もうとしていた。
レポートそのものは .vitest/json/output.json に書かれていた。

--outputFile で書き出す先を決め、jq にはそのファイルを読ませる。
公式の移行ガイドによると、設定に reporters: [['json', { stdout: true }]] と書けば標準出力に戻せる。
角括弧は二重で、レポーターの名前とオプションの組を、さらに配列に入れる。

ガイドによると、HTML のレポートや blob のレポートも .vitest の下に移った。
.gitignore に .vitest を 1 行足しておくと、生成物がコミットに混ざらない。

bench を vitest から import できなくなった

4 の bench は vitest から import し、*.bench.js の最上位で呼ぶ関数だった。
5 ではベンチマークの API が作り直され、bench は test の関数が受け取る引数(テストのコンテキスト)から取り出すものになった。
vitest から import した bench は関数ではない。

v4 では

$ cat sort.bench.js
import { bench } from "vitest";
 
bench("sort", () => {
  [3, 1, 2].sort();
});
$ npx vitest bench --run
Benchmarking is an experimental feature.
Breaking changes might not follow SemVer, please pin Vitest's version when using it.
 
 RUN  v4.1.12 /work/v4/bench
 
 ✓ sort.bench.js 1888ms
     name            hz     min     max    mean     p75     p99    p995    p999     rme  samples
   · sort  8,211,949.67  0.0001  2.5473  0.0001  0.0001  0.0003  0.0009  0.0013  ±1.35%  4105975
 
 ✓ sort.bench.js 1888ms
     name            hz     min     max    mean     p75     p99    p995    p999     rme  samples
   · sort  8,211,949.67  0.0001  2.5473  0.0001  0.0001  0.0003  0.0009  0.0013  ±1.35%  4105975
 
 BENCH  Summary
 
  sort - sort.bench.js
$ echo $?
0

v5 に上げると

$ npx vitest bench --run
 RUN  v5.1.0 /work/v5/bench
 
 ❯ |bench| sort.bench.js (0 test)
 
⎯⎯⎯⎯⎯⎯ Failed Suites 1 ⎯⎯⎯⎯⎯⎯⎯
 
 FAIL  |bench| sort.bench.js [ sort.bench.js ]
TypeError: bench is not a function
 ❯ sort.bench.js:3:1
      1| import { bench } from "vitest";
      2|
      3| bench("sort", () => {
       | ^
      4|   [3, 1, 2].sort();
      5| });
 
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
 
 Test Files  1 failed (1)
      Tests  no tests
   Start at  03:36:13
   Duration  100ms (worker 96%, environment 4%)
$ echo $?
1

v5 で直すと

$ cat sort.bench.js
import { test } from "vitest";
 
test("sort", async ({ bench }) => {
  await bench("sort", () => {
    [3, 1, 2].sort();
  }).run();
});
$ npx vitest bench --run
 RUN  v5.1.0 /work/v5/bench
 
 ✓ |bench| sort.bench.js (1 test) 3194ms
   ✓ sort 3194ms
     name             hz     min     max    mean     p75     p99    p995    p999     rme  samples
     sort  10,466,111.06  0.0001  8.4573  0.0001  0.0001  0.0003  0.0003  0.0005  ±1.73%  9050374
 
 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  03:36:14
   Duration  3.28s (tests 99%)
$ echo $?
0

test で包み、引数から受け取った bench に処理を渡して、.run() を await する。
vitest bench --run はそのまま使えた。
bench.skip と bench.only は、包んだ test の test.skip と test.only に置き換える。
--compare や benchmark.outputJson も無くなり、公式の移行ガイドに代わりの書き方が載っている。

検証環境Node.js 24.22.2 / npm 11.19.1 / Python 3.11.2 / 2026-11-08 検証(ほか 5 件)
検証日
実行環境
node:24 Debian GNU/Linux 12 (bookworm)
バージョン
  • Node.js 24.22.2
  • npm 11.19.1
  • Python 3.11.2
  • Git 2.39.5
  • Vitest(旧) 4.1.12
  • Vitest(新) 5.1.0
  • Vite 8.3.6
  • jq jq-1.6

この記事の「実行例」は、上記の環境で実際にコマンドを実行して得られた出力をそのまま掲載しています。 再現手順はリポジトリの検証スクリプトとして管理し、定期的に再実行して出力を更新しています。