Vitest 2

čeština

English
简体中文
繁體中文
Español
Français
Русский
Português – Brasil
Deutsch
日本語
한국어
Italiano
Polski
Türkçe
magyar

čeština

English
简体中文
繁體中文
Español
Français
Русский
Português – Brasil
Deutsch
日本語
한국어
Italiano
Polski
Türkçe
magyar

Vzhled

Rozhraní příkazového řádku ​

Příkazy ​

vitest ​

Spustí Vitest v aktuální složce. V režimu vývoje automaticky přejde do režimu sledování (watch) a v CI do režimu spuštění (run).

Můžete předat dodatečný argument jako filtr pro testovací soubory, které se mají spustit. Například:

bash
vitest foobar

Spustí pouze testovací soubor, jehož cesta obsahuje foobar. Tento filtr pouze kontroluje, zda cesta obsahuje hledaný výraz, a nepodporuje regulární výrazy ani globální vzory (pokud je váš terminál nezpracuje dříve, než Vitest filtr obdrží).

vitest run ​

Provede jednorázové spuštění testů bez režimu sledování.

vitest watch ​

Spustí všechny testovací sady, sleduje změny a znovu spouští testy, když se změní soubory. Funguje stejně jako volání vitest bez argumentu. V CI se přepne na vitest run.

vitest dev ​

Alias k vitest watch.

Spustí pouze testy, které pokrývají seznam zdrojových souborů. Funguje pro statické importy (např. import('./index.js') nebo import index from './index.js), ale ne s dynamickými (např. import(filepath)). Všechny soubory by měly být relativní ke kořenovému adresáři projektu.

Užitečné pro spuštění s lint-staged nebo s vaším nastavením CI.

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

TIP

Nezapomeňte, že Vitest standardně běží v režimu sledování (watch). Pokud používáte nástroje jako lint-staged, měli byste také předat volbu --run, aby se příkaz mohl řádně ukončit.

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

vitest bench ​

Spustí pouze benchmarkové testy, které porovnávají výsledky výkonu.

vitest init ​

vitest init <name> slouží k nastavení konfigurace projektu. V současné době podporuje pouze hodnotu browser:

bash
vitest init browser

vitest list ​

Příkaz vitest list zdědí všechny možnosti vitest pro vypsání seznamu všech odpovídajících testů. Tento příkaz ignoruje volbu reporters. Ve výchozím nastavení vypíše názvy všech testů, které odpovídají filtru souborů a vzoru názvu:

shell
vitest list filename.spec.ts -t="some-test"
txt
describe > some-test
describe > some-test > test 1
describe > some-test > test 2

Můžete použít příznak --json pro výpis testů ve formátu JSON nebo je uložit do samostatného souboru:

bash
vitest list filename.spec.ts -t="some-test" --json=./file.json

Pokud není pro příznak --json zadána hodnota, vypíše JSON na standardní výstup (stdout).

Můžete také použít příznak --filesOnly pro výpis pouze testovacích souborů:

bash
vitest list --filesOnly
txt
tests/test1.test.ts
tests/test2.test.ts

Možnosti ​

TIP

Vitest podporuje jak formát camelCase, tak kebab-case pro argumenty CLI. Například --passWithNoTests a --pass-with-no-tests budou fungovat (--no-color a --inspect-brk jsou výjimky).

Vitest také podporuje různé způsoby zadávání hodnoty: --reporter dot a --reporter=dot jsou oba platné.

Pokud volba podporuje pole hodnot, musíte ji zadat vícekrát:

vitest --reporter=dot --reporter=default

Booleovské volby lze negovat předponou no-. Zadání hodnoty jako false také funguje:

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

root ​

  • CLI: -r, --root <path>
  • Config: root

Kořenový adresář projektu.

config ​

  • CLI: -c, --config <path>

Cesta k souboru s konfigurací.

update ​

  • CLI: -u, --update
  • Config: update

Aktualizuje snímky (snapshots).

watch ​

  • CLI: -w, --watch
  • Config: watch

Povolí režim sledování změn (watch mode).

testNamePattern ​

Spouští pouze testy, jejichž plné názvy odpovídají zadanému regulárnímu výrazu.

dir ​

  • CLI: --dir <path>
  • Config: dir

Základní adresář pro prohledávání testovacích souborů.

ui ​

  • CLI: --ui
  • Config: ui

Povolí uživatelské rozhraní (UI).

open ​

  • CLI: --open
  • Config: open

Automaticky otevře UI v prohlížeči (výchozí: !process.env.CI).

api.port ​

  • CLI: --api.port [port]

Určuje port serveru. Pokud je port již obsazen, Vite se automaticky pokusí o další dostupný port, takže se nemusí jednat o skutečný port, na kterém server nakonec poslouchá. Pokud je hodnota true, bude nastaven na 51204.

api.host ​

  • CLI: --api.host [host]

Určuje, na kterých IP adresách má server naslouchat. Nastavte na 0.0.0.0 nebo true, aby server naslouchal na všech adresách, včetně LAN a veřejných adres.

api.strictPort ​

  • CLI: --api.strictPort

Pokud je true, aplikace se ukončí, pokud je port již používán, namísto automatického pokusu o další dostupný port.

silent ​

Potlačí výstup konzole z testů.

hideSkippedTests ​

  • CLI: --hideSkippedTests

Skryje záznamy o přeskočených testech.

reporters ​

Určuje reportéry.

outputFile ​

Zapisuje výsledky testů do souboru, pokud je specifikován podporovaný reportér. Pro individuální výstupy více reportérů použijte tečkovou notaci cac (příklad: --outputFile.tap=./tap.txt).

coverage.all ​

Určuje, zda zahrnout všechny soubory, včetně netestovaných, do zprávy o pokrytí.

coverage.provider ​

Vybere nástroj pro sběr pokrytí. Dostupné hodnoty jsou: "v8", "istanbul" a "custom".

coverage.enabled ​

Povoluje sběr pokrytí testů. Lze přepsat pomocí volby CLI --coverage (výchozí: false).

coverage.include ​

Soubory zahrnuté do pokrytí jako glob vzory. Lze specifikovat vícekrát při použití více vzorů (výchozí: **).

coverage.exclude ​

Soubory, které mají být vyloučeny z pokrytí. Lze specifikovat vícekrát při použití více vzorů (výchozí: Navštivte coverage.exclude).

coverage.extension ​

Přípony souborů, které mají být zahrnuty do pokrytí. Lze specifikovat vícekrát pro více přípon (výchozí: [".js", ".cjs", ".mjs", ".ts", ".mts", ".tsx", ".jsx", ".vue", ".svelte"]).

coverage.clean ​

Vyčistí výsledky pokrytí před spuštěním testů (výchozí: true).

coverage.cleanOnRerun ​

Vyčistí report pokrytí při opětovném spuštění v režimu sledování (výchozí: true).

coverage.reportsDirectory ​

Adresář pro zápis reportu pokrytí (výchozí: ./coverage).

coverage.reporter ​

Reportéry pokrytí k použití. Více informací na coverage.reporter (výchozí: ["text", "html", "clover", "json"]).

coverage.reportOnFailure ​

Generuje report pokrytí i v případě selhání testů (výchozí: false).

coverage.allowExternal ​

Sbírá pokrytí souborů mimo kořen projektu (výchozí: false).

coverage.skipFull ​

Nezobrazuje soubory se 100% pokrytím příkazů, větví a funkcí (výchozí: false).

coverage.thresholds.100 ​

Zkratka pro nastavení všech prahových hodnot pokrytí na 100 % (výchozí: false).

coverage.thresholds.perFile ​

Kontroluje prahové hodnoty pro každý soubor. Skutečné prahové hodnoty viz --coverage.thresholds.lines, --coverage.thresholds.functions, --coverage.thresholds.branches a --coverage.thresholds.statements (výchozí: false).

coverage.thresholds.autoUpdate ​

Aktualizuje prahové hodnoty: "lines", "functions", "branches" a "statements" do konfiguračního souboru, pokud je aktuální pokrytí nad nakonfigurovanými prahovými hodnotami (výchozí: false).

coverage.thresholds.lines ​

  • CLI: --coverage.thresholds.lines <number>

Prahová hodnota pro pokrytí řádků. Pro více informací navštivte istanbuljs. Tato možnost není dostupná pro vlastní poskytovatele pokrytí.

coverage.thresholds.functions ​

  • CLI: --coverage.thresholds.functions <number>

Prahová hodnota pro pokrytí funkcí. Pro více informací navštivte istanbuljs. Tato možnost není dostupná pro vlastní poskytovatele pokrytí.

coverage.thresholds.branches ​

  • CLI: --coverage.thresholds.branches <number>

Prahová hodnota pro pokrytí větví. Pro více informací navštivte istanbuljs. Tato možnost není dostupná pro vlastní poskytovatele pokrytí.

coverage.thresholds.statements ​

  • CLI: --coverage.thresholds.statements <number>

Prahová hodnota pro pokrytí příkazů. Pro více informací navštivte istanbuljs. Tato možnost není dostupná pro vlastní poskytovatele pokrytí.

coverage.ignoreClassMethods ​

Pole názvů metod tříd, které se mají ignorovat při sběru pokrytí. Pro více informací navštivte istanbuljs. Tato možnost je dostupná pouze pro poskytovatele Istanbul (výchozí: []).

coverage.processingConcurrency ​

Limit souběžnosti pro zpracování výsledků pokrytí (výchozí: menší z hodnot 20 a počtu CPU).

coverage.customProviderModule ​

Určuje název modulu nebo cestu k modulu vlastního poskytovatele pokrytí. Pro více informací navštivte Custom Coverage Provider. Tato možnost je dostupná pouze pro vlastní poskytovatele pokrytí.

coverage.watermarks.statements ​

  • CLI: --coverage.watermarks.statements <watermarks>

Horní a dolní hranice (watermarks) pro pokrytí příkazů ve formátu <high>,<low>.

coverage.watermarks.lines ​

  • CLI: --coverage.watermarks.lines <watermarks>

Horní a dolní hranice (watermarks) pro pokrytí řádků ve formátu <high>,<low>.

coverage.watermarks.branches ​

  • CLI: --coverage.watermarks.branches <watermarks>

Horní a dolní hranice (watermarks) pro pokrytí větví ve formátu <high>,<low>.

coverage.watermarks.functions ​

  • CLI: --coverage.watermarks.functions <watermarks>

Horní a dolní hranice (watermarks) pro pokrytí funkcí ve formátu <high>,<low>.

mode ​

  • CLI: --mode <name>
  • Config: mode

Nastaví režim Vite (výchozí: test nebo benchmark).

workspace ​

Cesta ke konfiguračnímu souboru pracovního prostoru.

isolate ​

Spustí každý testovací soubor izolovaně. Pro vypnutí izolace použijte --no-isolate (výchozí: true).

globals ​

Globálně injektuje API funkce.

dom ​

  • CLI: --dom

Simuluje API prohlížeče pomocí happy-dom.

browser.enabled ​

Spustí testy v prohlížeči (výchozí: false).

browser.name ​

Spustí všechny testy v konkrétním prohlížeči. Některé prohlížeče jsou dostupné pouze pro konkrétní poskytovatele (viz --browser.provider). Více informací na browser.name.

browser.headless ​

Spustí prohlížeč v bezhlavém režimu (tj. bez otevření grafického uživatelského rozhraní). Pokud spouštíte Vitest v CI, bude tato možnost ve výchozím nastavení povolena (výchozí: process.env.CI).

browser.api.port ​

Určuje port serveru. Pokud je port již obsazen, Vite se automaticky pokusí o další dostupný port, takže se nemusí jednat o skutečný port, na kterém server nakonec poslouchá. Pokud je hodnota true, bude nastaven na 63315.

browser.api.host ​

Určuje, na kterých IP adresách má server naslouchat. Nastavte na 0.0.0.0 nebo true pro naslouchání na všech adresách, včetně LAN a veřejných adres.

browser.api.strictPort ​

Pokud je true, aplikace se ukončí, pokud je port již používán, namísto automatického pokusu o další dostupný port.

browser.provider ​

Poskytovatel použitý ke spuštění testů prohlížeče. Některé prohlížeče jsou dostupné pouze pro konkrétní poskytovatele. Může být "webdriverio", "playwright", "preview" nebo cesta k vlastnímu poskytovateli. Více informací na browser.provider (výchozí: "preview").

browser.providerOptions ​

Možnosti, které jsou předány poskytovateli prohlížeče. Více informací na browser.providerOptions.

browser.isolate ​

Spustí každý testovací soubor prohlížeče izolovaně. Pro vypnutí izolace použijte --browser.isolate=false (výchozí: true).

browser.ui ​

Zobrazí Vitest UI při spouštění testů (výchozí: !process.env.CI).

browser.fileParallelism ​

Určuje, zda se mají soubory testů prohlížeče spouštět paralelně. Pro vypnutí použijte --browser.fileParallelism=false (výchozí: true).

pool ​

  • CLI: --pool <pool>
  • Config: pool

Určuje typ poolu (fondu) pro spouštění testů, pokud neběží v prohlížeči (výchozí: threads).

poolOptions.threads.isolate ​

Izoluje testy v poolu vláken (výchozí: true).

poolOptions.threads.singleThread ​

Spustí testy v jednom vlákně (výchozí: false).

poolOptions.threads.maxThreads ​

Maximální počet nebo procento vláken, ve kterých se mají spouštět testy.

poolOptions.threads.minThreads ​

Minimální počet nebo procento vláken, ve kterých se mají spouštět testy.

poolOptions.threads.useAtomics ​

Používá Atomics pro synchronizaci vláken. To může v některých případech zlepšit výkon, ale může způsobit chybu segmentace (segfault) ve starších verzích Node (výchozí: false).

poolOptions.vmThreads.isolate ​

Izoluje testy v poolu VM vláken (výchozí: true).

poolOptions.vmThreads.singleThread ​

Spustí testy v jednom VM vlákně (výchozí: false).

poolOptions.vmThreads.maxThreads ​

Maximální počet nebo procento VM vláken, ve kterých se mají spouštět testy.

poolOptions.vmThreads.minThreads ​

Minimální počet nebo procento VM vláken, ve kterých se mají spouštět testy.

poolOptions.vmThreads.useAtomics ​

Používá Atomics pro synchronizaci VM vláken. To může v některých případech zlepšit výkon, ale může způsobit chybu segmentace (segfault) ve starších verzích Node (výchozí: false).

poolOptions.vmThreads.memoryLimit ​

Limit paměti pro fond VM vláken. Pokud zaznamenáte úniky paměti, zkuste tuto hodnotu upravit.

poolOptions.forks.isolate ​

Izoluje testy v poolu forků (výchozí: true).

poolOptions.forks.singleFork ​

Spustí testy v jednom child_process (výchozí: false).

poolOptions.forks.maxForks ​

Maximální počet nebo procento procesů, ve kterých se mají spouštět testy.

poolOptions.forks.minForks ​

Minimální počet nebo procento procesů, ve kterých se mají spouštět testy.

poolOptions.vmForks.isolate ​

Izoluje testy v poolu VM forků (výchozí: true).

poolOptions.vmForks.singleFork ​

Spustí testy v jednom child_process (výchozí: false).

poolOptions.vmForks.maxForks ​

Maximální počet nebo procento procesů, ve kterých se mají spouštět testy.

poolOptions.vmForks.minForks ​

Minimální počet nebo procento procesů, ve kterých se mají spouštět testy.

poolOptions.vmForks.memoryLimit ​

Limit paměti pro fond VM forků. Pokud zaznamenáte úniky paměti, zkuste tuto hodnotu upravit.

fileParallelism ​

Určuje, zda se mají všechny testovací soubory spouštět paralelně. Pro vypnutí použijte --no-file-parallelism (výchozí: true).

maxWorkers ​

Maximální počet nebo procento pracovních procesů (workerů), ve kterých se mají spouštět testy.

minWorkers ​

Minimální počet nebo procento pracovních procesů (workerů), ve kterých se mají spouštět testy.

environment ​

Určuje prostředí spouštěče (runneru), pokud testy neběží v prohlížeči (výchozí: node).

passWithNoTests ​

Testy projdou, i když nejsou nalezeny žádné testy.

logHeapUsage ​

Zobrazuje velikost haldy pro každý test při spouštění v prostředí Node.js.

allowOnly ​

Povoluje spouštění testů a sad, které jsou označeny jako "only" (tj. pouze tyto testy/sady) (výchozí: !process.env.CI).

dangerouslyIgnoreUnhandledErrors ​

Ignoruje veškeré neošetřené chyby, které se vyskytnou.

sequence.shuffle.files ​

Spouští soubory v náhodném pořadí. Povolení této možnosti nezajistí, že dlouho běžící testy začnou dříve (výchozí: false).

sequence.shuffle.tests ​

Spouští testy v náhodném pořadí (výchozí: false).

sequence.concurrent ​

Spouští testy paralelně (výchozí: false).

sequence.seed ​

Nastaví semeno pro randomizaci. Tato možnost nebude mít žádný účinek, pokud není --sequence.shuffle povoleno (je falsy). Více informací na stránce "Random Seed".

sequence.hooks ​

Mění pořadí, ve kterém jsou spouštěny hooky (háčky). Přijatelné hodnoty jsou: "stack", "list" a "parallel". Více informací na sequence.hooks (výchozí: "parallel").

sequence.setupFiles ​

Mění pořadí, ve kterém jsou spouštěny soubory nastavení. Přijatelné hodnoty jsou: "list" a "parallel". Pokud je nastaveno na "list", soubory nastavení se spustí v pořadí, v jakém jsou definovány. Pokud je nastaveno na "parallel", spustí se soubory nastavení paralelně (výchozí: "parallel").

inspect ​

  • CLI: --inspect [[host:]port]
  • Config: inspect

Povolí Node.js inspektor (výchozí: 127.0.0.1:9229).

inspectBrk ​

Povolí Node.js inspektor a zastaví se před spuštěním testu.

testTimeout ​

Výchozí časový limit pro test v milisekundách (výchozí: 5000).

hookTimeout ​

Výchozí časový limit pro hook (háček) v milisekundách (výchozí: 10000).

bail ​

  • CLI: --bail <number>
  • Config: bail

Zastaví provádění testů, pokud selže zadaný počet testů (výchozí: 0).

retry ​

  • CLI: --retry <times>
  • Config: retry

Opakuje test zadaný početkrát, pokud selže (výchozí: 0).

diff ​

  • CLI: --diff <path>
  • Config: diff

Cesta k diff konfiguraci, která bude použita pro generování rozdílového rozhraní.

exclude ​

  • CLI: --exclude <glob>
  • Config: exclude

Další glob vzory souborů, které se mají vyloučit z testování.

expandSnapshotDiff ​

Zobrazí úplný rozdíl (diff), když snapshot selže.

disableConsoleIntercept ​

Zakáže automatické zachycování výstupu konzole (výchozí: false).

typecheck.enabled ​

Povoluje kontrolu typů souběžně s testy (výchozí: false).

typecheck.only ​

Spustí pouze testy kontroly typů. Tím se automaticky povolí kontrola typů (výchozí: false).

typecheck.checker ​

Určuje nástroj pro kontrolu typů, který se má použít. Dostupné hodnoty jsou: "tsc", "vue-tsc" a cesta k spustitelnému souboru (výchozí: "tsc").

typecheck.allowJs ​

Povoluje kontrolu typů souborů JavaScript. Ve výchozím nastavení přebírá hodnotu z tsconfig.json.

typecheck.ignoreSourceErrors ​

Ignoruje chyby typů ze zdrojových souborů.

typecheck.tsconfig ​

Cesta k vlastnímu souboru tsconfig.

project ​

  • CLI: --project <name>
  • Config: project

Název projektu, který se má spustit, pokud používáte funkci pracovního prostoru Vitest. Lze zadat vícekrát pro spuštění více projektů: --project=1 --project=2. Projekty můžete také filtrovat pomocí zástupných znaků, jako je --project=packages*.

slowTestThreshold ​

Prahová hodnota v milisekundách, po které je test považován za pomalý (výchozí: 300).

teardownTimeout ​

Výchozí časový limit pro funkci teardown (ukončení) v milisekundách (výchozí: 10000).

maxConcurrency ​

Maximální počet souběžně spouštěných testů v sadě (výchozí: 5).

expect.requireAssertions ​

Vyžaduje, aby všechny testy obsahovaly alespoň jedno tvrzení.

expect.poll.interval ​

Interval dotazování v milisekundách pro tvrzení expect.poll() (výchozí: 50).

expect.poll.timeout ​

Časový limit dotazování v milisekundách pro tvrzení expect.poll() (výchozí: 1000).

printConsoleTrace ​

Vždy tiskne trasování zásobníku konzole.

run ​

  • CLI: --run

Zakáže režim sledování.

color ​

  • CLI: --no-color

Odstraní barvy z výstupu konzole.

clearScreen ​

  • CLI: --clearScreen

Vyčistí obrazovku terminálu při opětovném spouštění testů v režimu sledování (výchozí: true).

standalone ​

  • CLI: --standalone

Spustí Vitest bez spouštění testů. Filtry souborů budou ignorovány a testy se budou spouštět pouze při změně (výchozí: false).

changed ​

  • Typ: boolean | string
  • Výchozí: false

Otestuje pouze změněné soubory. Pokud není zadána žádná hodnota, spustí testy proti nepotvrzeným změnám (včetně staged a unstaged).

Pro spuštění testů proti změnám provedeným v posledním commitu můžete použít --changed HEAD~1. Můžete také předat hash commitu (např. --changed 09a9920) nebo název větve (např. --changed origin/develop).

Při měření pokrytí kódu bude report obsahovat pouze soubory, které se změnami souvisely.

V kombinaci s konfigurační volbou forceRerunTriggers se spustí celá testovací sada, pokud se změní alespoň jeden soubor uvedený v seznamu forceRerunTriggers. Ve výchozím nastavení změny konfiguračního souboru Vitest a package.json vždy znovu spustí celou sadu.

shard ​

  • Typ: string
  • Výchozí: disabled

Rozdělí testovací sady určené k provedení ve formátu <index>/<count>, kde:

  • count je kladné celé číslo, celkový počet částí
  • index je kladné číslo, pořadové číslo rozdělené části

Tento příkaz rozdělí všechny testy na count stejných dílů a spustí pouze ty, které spadají do části index. Například pro rozdělení testovací sady na tři části použijte toto:

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

WARNING

Tuto možnost nelze použít s povoleným --watch (ve výchozím nastavení povoleno ve vývoji).

TIP

Pokud je --reporter=blob použit bez výstupního souboru, výchozí cesta bude zahrnovat aktuální konfiguraci shardu, aby se zabránilo kolizím s jinými procesy Vitest.

merge-reports ​

  • Typ: boolean | string

Sloučí všechny reporty typu blob umístěné ve specifikované složce (ve výchozím nastavení .vitest-reports). S tímto příkazem můžete použít jakékoli reportéry (kromě blob):

sh
vitest --merge-reports --reporter=junit

Vydáno pod licencí MIT.

Copyright (c) 2024 Mithril Contributors

https://v2.vitest.dev/guide/cli

Vydáno pod licencí MIT.

Copyright (c) 2024 Mithril Contributors