Parancssori felület

Parancsok

vitest

Elindítja a Vitest alkalmazást az aktuális könyvtárban. Fejlesztői környezetben automatikusan figyelő (watch) módba lép, míg CI-környezetben futtatási (run) módba vált.

További argumentumként átadhatja a futtatandó tesztfájlok szűrőjét. Például:

vitest foobar

Csak azokat a tesztfájlokat futtatja, amelyek elérési útvonalában szerepel a foobar szöveg. Ez a szűrő csak a tartalmazást ellenőrzi, nem támogatja a reguláris kifejezéseket vagy glob mintákat.

vitest run

Egyszeri futtatás figyelő mód nélkül.

vitest watch

Futtatja az összes tesztcsomagot, figyeli a változásokat, és a változásokkor újra futtatja a teszteket. Ugyanaz, mint a vitest argumentum nélküli meghívása. CI-környezetben a vitest run parancsot használja.

vitest dev

A vitest watch parancs aliasa.

vitest related

Csak azokat a teszteket futtatja, amelyek a megadott forrásfájlokat érintik. Statikus importokkal működik (pl. import('./index.ts') vagy import index from './index.ts'), de a dinamikus importokkal nem (pl. import(filepath)). Minden fájlnak a gyökérkönyvtárhoz viszonyított relatív útvonalát kell megadni.

Hasznos a lint-staged vagy CI beállításokkal való használathoz.

vitest related /src/index.ts /src/hello-world.js

TIP

Ne felejtse el, hogy a Vitest alapértelmezés szerint figyelő módban fut. Ha olyan eszközöket használ, mint a lint-staged, akkor a --run opciót is át kell adnia, hogy a parancs normálisan befejeződhessen.

// .lintstagedrc.js
export default {
  '*.{js,ts}': 'vitest related --run',
};

vitest bench

Csak a benchmark teszteket futtatja, amelyek a teljesítményeredményeket hasonlítják össze.

Opciók

Opciók
-v, --version	Verziószám megjelenítése
-r, --root <path>	A projekt gyökérkönyvtárának meghatározása
-c, --config <path>	Konfigurációs fájl elérési útja
-u, --update	Pillanatképek frissítése
-w, --watch	Intelligens és azonnali figyelő mód engedélyezése
-t, --testNamePattern <pattern>	A mintára illeszkedő teljes nevű tesztek futtatása
--dir <path>	A tesztfájlok keresésének alapkönyvtára
--ui	UI engedélyezése
--open	Az UI automatikus megnyitása, ha engedélyezve van (alapértelmezett: true)
--api [api]	API kiszolgálása, elérhető opciók: --api.port <port>, --api.host [host] és --api.strictPort
--threads	Szálak engedélyezése (alapértelmezett: true)
--single-thread	A tesztek egyetlen szálon belül futtatása, --threads szükséges (alapértelmezett: false)
--experimental-vm-threads	A tesztek futtatása egy worker pool-ban VM izolációval (alapértelmezett: false)
--experimental-vm-worker-memory-limit	A worker számára engedélyezett maximális memória beállítása. Ha eléri a limitet, egy új worker jön létre.
--silent	A tesztek konzolkimenetének elnémítása
--isolate	Minden tesztfájlhoz külön környezetet hoz létre.
--reporter <name>	Riportáló kiválasztása: default, verbose, dot, junit, json, vagy egy egyéni riportáló elérési útja
--outputFile <filename/-s>	A teszteredmények fájlba írása, ha a --reporter=json vagy a --reporter=junit opció is meg van adva. A cac's dot notation segítségével több riportálóhoz is megadhat egyedi kimeneteket.
--coverage	Lefedettségi jelentés engedélyezése
--run	Figyelő mód letiltása
--mode	A Vite mód felülbírálása (alapértelmezett: test)
--mode <name>	A Vite mód felülbírálása (alapértelmezett: test)
--globals	API-k globális injektálása
--dom	Böngésző API szimulálása happy-dom segítségével
--browser [options]	Tesztek futtatása a böngészőben (alapértelmezett: false)
--environment <env>	Futtató környezet (alapértelmezett: node)
--passWithNoTests	Akkor is sikeres, ha nem talál teszteket.
--logHeapUsage	A memóriaterület (heap) méretének megjelenítése minden teszthez
--allowOnly	Engedélyezi az only jelöléssel ellátott teszteket és tesztcsomagokat (alapértelmezett: false CI-ben, egyébként true).
--dangerouslyIgnoreUnhandledErrors	A kezeletlen hibák figyelmen kívül hagyása
--changed [since]	Csak a megváltozott fájlok által érintett teszteket futtatja (alapértelmezett: false). Lásd a dokumentációt
--shard <shard>	A teszteket egy megadott shard-ban futtatja.
--sequence	Meghatározza, hogy a tesztek milyen sorrendben fussanak.
--no-color	Eltávolítja a színeket a konzolkimenetből
--inspect	Engedélyezi a Node.js inspectort
--inspect-brk	Engedélyezi a Node.js inspectort break-kel
--bail <number>	Leállítja a teszt végrehajtását, ha a megadott számú teszt megbukott
--retry <times>	A teszt adott számú alkalommal történő újrapróbálkozása, ha megbukik
-h, --help	A rendelkezésre álló CLI opciók megjelenítése

TIP

A Vitest támogatja a camel case és a kebab case formátumot is a CLI argumentumokhoz. Például a --passWithNoTests és a --pass-with-no-tests is működni fog (a --no-color és a --inspect-brk kivételek).

A Vitest a érték megadásának különböző módjait is támogatja: a --reporter dot és a --reporter=dot is érvényes.

Ha az opció értékek tömbjét támogatja, akkor az opciót többször kell átadnia:

vitest --reporter=dot --reporter=default

A logikai opciók a no- előtaggal tagadhatók. Az érték false értékű megadása is működik:

vitest --no-api
vitest --api=false

changed

• Típus: boolean | string

• Alapértelmezett: false

  Csak a megváltozott fájlokon futtat teszteket. Ha nincs érték megadva, akkor a nem véglegesített változtatásokon (beleértve a staged és unstaged fájlokat) futtat teszteket.

  A legutóbbi commitban végrehajtott változtatásokon végzett tesztek futtatásához használhatja a --changed HEAD~1 parancsot. Átadhat commit hash-t vagy ágnevet is.

  Ha a forceRerunTriggers konfigurációs opcióval párosítják, a teljes tesztcsomagot futtatja, ha egyezést talál.

shard

• Típus: string

• Alapértelmezett: letiltva

  A tesztcsomag shard-ját a következő formátumban kell megadni: <index>/<count>, ahol

  • a count egy pozitív egész szám, a felosztott részek száma
  • az index egy pozitív egész szám, a felosztott rész indexe

  Ez a parancs az összes tesztet count egyenlő részre osztja, és csak azokat futtatja, amelyek az index részbe esnek. Például a tesztcsomag három részre osztásához használja a következőt:

  vitest run --shard=1/3
  vitest run --shard=2/3
  vitest run --shard=3/3

WARNING

Ezt az opciót nem használhatja az engedélyezett --watch opcióval (fejlesztői módban alapértelmezés szerint engedélyezve van).