Node API

WARNING

A Vitest kísérleti, privát API-t tesz elérhetővé. A visszamenőleges kompatibilitást megszakító változások nem feltétlenül követik a szemantikus verziókezelést, ezért javasolt a Vitest verziójának rögzítése használat közben.

startVitest

A Vitest teszteket a Node API segítségével indíthatja el:

import { startVitest } from 'vitest/node';

const vitest = await startVitest('test');

await vitest?.close();

A startVitest függvény egy Vitest példányt ad vissza, amennyiben a tesztek sikeresen elindíthatók. undefined értéket ad vissza, ha az alábbiak valamelyike bekövetkezik:

• A Vitest nem találja a vite csomagot (ez általában a Vitesttel együtt települ).
• Ha a kódlefedettség engedélyezve van, és a futási mód test, de a lefedettségi csomag nincs telepítve (@vitest/coverage-v8 vagy @vitest/coverage-istanbul).
• Ha a környezeti csomag nincs telepítve (jsdom/happy-dom/@edge-runtime/vm).

Ha a függvény undefined értéket ad vissza, vagy a tesztek futás közben sikertelenek, a Vitest a process.exitCode értékét 1-re állítja.

Amennyiben a figyelő mód (watch mode) nincs engedélyezve, a Vitest meghívja a close metódust.

Amennyiben a figyelő mód engedélyezve van, és a terminál támogatja a TTY kezelést, a Vitest regisztrálja a konzol gyorsbillentyűit.

Második argumentumként egy szűrőlistát adhat át. A Vitest csak azokat a teszteket futtatja, amelyek fájlútvonala tartalmaz legalább egyet az átadott stringek közül.

Ezenkívül a harmadik argumentummal CLI argumentumokat adhat át, amelyek felülírják a tesztkonfigurációs beállításokat.

Végül, negyedik argumentumként a teljes Vite konfigurációt is átadhatja, amely elsőbbséget élvez minden más felhasználó által definiált beállítással szemben.

createVitest

A createVitest függvénnyel saját Vitest példányt hozhat létre. Ugyanazt a Vitest példányt adja vissza, mint a startVitest, de nem indítja el automatikusan a teszteket, és nem ellenőrzi a telepített csomagokat.

import { createVitest } from 'vitest/node';

const vitest = await createVitest('test', {
  watch: false,
});

parseCLI

Ezzel a módszerrel elemezheted a parancssori argumentumokat (CLI). Egy karakterláncot fogad el (ahol az argumentumokat egyetlen szóköz választja el) vagy egy karakterlánc tömböt a CLI argumentumokból, ugyanabban a formátumban, amelyet a Vitest CLI használ. Visszaad egy szűrőt és options értékeket, amelyeket később átadhatsz a createVitest vagy a startVitest metódusoknak.

import { parseCLI } from 'vitest/node';

parseCLI('vitest ./files.ts --coverage --browser=chrome');

Vitest

A Vitest példány az aktuális tesztmódot igényli. A következő módok közül választhat:

• test: futásidejű tesztek futtatásakor
• benchmark: benchmark tesztek futtatásakor

mode

test

A teszt mód csak a test vagy it függvényekben található függvényeket hívja meg, és hibát dob, ha bench függvényt talál. Ez a mód a konfigurációs include és exclude opciókat használja a tesztfájlok kereséséhez.

benchmark

A benchmark mód a bench függvényeket hívja meg, és hibát dob, ha test vagy it függvényt talál. Ez a mód a konfigurációs benchmark.include és benchmark.exclude opciókat használja a benchmark fájlok kereséséhez.

start

A start metódussal teszteket vagy benchmark teszteket indíthat el. A tesztfájlok szűréséhez átadható egy string tömb.