Rozhraní příkazového řádku
Příkazy
vitest
Spustí Vitest v aktuálním adresáři. Automaticky přejde do režimu sledování (watch mode) ve vývojovém prostředí a do režimu spuštění (run mode) v CI (nebo v neinteraktivním terminálu).
Můžete předat dodatečný argument jako filtr pro testovací soubory, které se mají spustit. Například:
vitest foobar
Spustí pouze testovací soubor, který obsahuje foobar
v cestě. Tento filtr pouze ověřuje přítomnost a nepodporuje regulární výrazy ani glob vzory (pokud je váš terminál nezpracuje předtím, než Vitest obdrží filtr).
Od Vitestu 3 můžete také určit test podle názvu souboru a čísla řádku:
$ vitest basic/foo.test.ts:10
WARNING
Všimněte si, že pro tuto funkci Vitest vyžaduje plný název souboru. Může být relativní k aktuálnímu pracovnímu adresáři nebo absolutní cestou.
$ vitest basic/foo.js:10 # ✅
$ vitest ./basic/foo.js:10 # ✅
$ vitest /users/project/basic/foo.js:10 # ✅
$ vitest foo:10 # ❌
$ vitest ./basic/foo:10 # ❌
Vitest momentálně také nepodporuje rozsahy testů:
$ vitest basic/foo.test.ts:10, basic/foo.test.ts:25 # ✅
$ vitest basic/foo.test.ts:10-25 # ❌
vitest run
Provede jediné spuštění bez režimu sledování.
vitest watch
Spustí všechny testovací sady a sleduje změny, aby znovu spustil testy, když dojde ke změnám. Je to stejné jako volání vitest
bez argumentu. V CI nebo pokud stdin není TTY (neinteraktivní prostředí) se vrátí k vitest run
.
vitest dev
Alias pro vitest watch
.
vitest related
Spustí pouze testy, které pokrývají seznam zdrojových souborů. Funguje se statickými importy (např. import('./index.js')
nebo import index from './index.js
), ale ne s dynamickými importy (např. import(filepath)
). Všechny soubory by měly být relativní ke kořenové složce.
Užitečné při spuštění s lint-staged
nebo s vaším nastavením CI.
vitest related /src/index.ts /src/hello-world.js
TIP
Nezapomeňte, že Vitest se ve výchozím nastavení spouští s povoleným režimem sledování. 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.
export default {
'*.{js,ts}': 'vitest related --run',
};
vitest bench
Spustí pouze srovnávací 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
:
vitest init browser
vitest list
Příkaz vitest list
přebírá všechny možnosti vitest
k tisku seznamu všech odpovídajících testů. Tento příkaz ignoruje možnost reporters
. Ve výchozím nastavení vytiskne názvy všech testů, které odpovídají filtru souborů a vzoru názvu:
vitest list filename.spec.ts -t="some-test"
describe > some-test
describe > some-test > test 1
describe > some-test > test 2
Můžete použít příznak --json
k tisku testů ve formátu JSON nebo je uložit do samostatného souboru:
vitest list filename.spec.ts -t="some-test" --json=./file.json
Pokud s příznakem --json
není zadána hodnota, vypíše JSON na stdout.
Můžete také použít příznak --filesOnly
k tisku pouze testovacích souborů:
vitest list --filesOnly
tests/test1.test.ts
tests/test2.test.ts
Možnosti
TIP
Vitest podporuje jak camel case, tak kebab case pro argumenty CLI. Například --passWithNoTests
a --pass-with-no-tests
oba fungují (výjimkou jsou --no-color
a --inspect-brk
).
Vitest také podporuje různé způsoby specifikace hodnoty: --reporter dot
a --reporter=dot
jsou oba platné.
Pokud možnost podporuje pole hodnot, musíte tuto možnost zadat vícekrát:
vitest --reporter=dot --reporter=default
Logické možnosti lze negovat předponou no-
. Zadání hodnoty false
také funguje:
vitest --no-api
vitest --api=false
root
- CLI:
-r, --root <path>
- Konfig: root
Kořenová cesta projektu.
config
- CLI:
-c, --config <path>
Cesta ke konfiguračnímu souboru.
update
- CLI:
-u, --update
- Konfig: update
Aktualizovat snímky (snapshots).
watch
- CLI:
-w, --watch
- Konfig: watch
Povolit režim sledování změn souborů.
testNamePattern
- CLI:
-t, --testNamePattern <pattern>
- Konfig: testNamePattern
Spustit pouze testy, jejichž plné názvy odpovídají zadanému regulárnímu výrazu.
dir
- CLI:
--dir <path>
- Konfig: dir
Základní adresář pro prohledávání testovacích souborů.
ui
- CLI:
--ui
- Konfig: ui
Povolit uživatelské rozhraní (UI).
open
- CLI:
--open
- Konfig: open
Automaticky otevřít UI v prohlížeči (výchozí: !process.env.CI
).
api.port
- CLI:
--api.port [port]
Určete port serveru. Pokud je port již používán, Vite se automaticky pokusí o další dostupný port, takže to nemusí být skutečný port, na kterém server nakonec poslouchá. Pokud je hodnota true
, bude nastaven na 51204
.
api.host
- CLI:
--api.host [host]
Určete, na kterých IP adresách má server naslouchat. Nastavte tuto hodnotu na 0.0.0.0
nebo true
pro naslouchání na všech adresách, včetně LAN a veřejných adres.
api.strictPort
- CLI:
--api.strictPort
Nastavte tuto hodnotu na true
pro ukončení, pokud je port již používán, namísto automatického pokusu o další dostupný port.
silent
- CLI:
--silent [value]
- Konfig: silent
Potlačit výstup konzole z testů. Použijte 'passed-only'
pro zobrazení logů pouze z neúspěšných testů.
hideSkippedTests
- CLI:
--hideSkippedTests
Skrýt logy pro přeskočené testy.
reporters
- CLI:
--reporter <name>
- Konfig: reporters
Určete reportéry (default, basic, blob, verbose, dot, json, tap, tap-flat, junit, hanging-process, github-actions).
outputFile
- CLI:
--outputFile <filename/-s>
- Konfig: outputFile
Zapsat výsledky testů do souboru, pokud je specifikován podporovaný reportér. Pro jednotlivé výstupy více reportérů použijte tečkovou notaci (například: --outputFile.tap=./tap.txt
).
coverage.all
- CLI:
--coverage.all
- Konfig: coverage.all
Určuje, zda zahrnout všechny soubory, včetně netestovaných, do reportu pokrytí.
coverage.provider
- CLI:
--coverage.provider <name>
- Konfig: coverage.provider
Vyberte nástroj pro sběr pokrytí. Dostupné hodnoty jsou: "v8", "istanbul" a "custom".
coverage.enabled
- CLI:
--coverage.enabled
- Konfig: coverage.enabled
Povoluje sběr pokrytí kódu. Lze přepsat pomocí volby CLI --coverage
(výchozí: false
).
coverage.include
- CLI:
--coverage.include <pattern>
- Konfig: 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
- CLI:
--coverage.exclude <pattern>
- Konfig: coverage.exclude
Soubory, které mají být vyloučeny z pokrytí. Lze specifikovat vícekrát při použití více rozšíření (výchozí: Navštivte coverage.exclude
).
coverage.extension
- CLI:
--coverage.extension <extension>
- Konfig: coverage.extension
Rozšíření souborů, která mají být zahrnuta do pokrytí. Lze specifikovat vícekrát při použití více rozšíření (výchozí: [".js", ".cjs", ".mjs", ".ts", ".mts", ".tsx", ".jsx", ".vue", ".svelte"]
).
coverage.clean
- CLI:
--coverage.clean
- Konfig: coverage.clean
Vyčistit výsledky pokrytí před spuštěním testů (výchozí: true
).
coverage.cleanOnRerun
- CLI:
--coverage.cleanOnRerun
- Konfig: coverage.cleanOnRerun
Vyčistit report pokrytí při opětovném spuštění sledování (výchozí: true
).
coverage.reportsDirectory
- CLI:
--coverage.reportsDirectory <path>
- Konfig: coverage.reportsDirectory
Adresář pro zápis reportu pokrytí (výchozí: ./coverage
).
coverage.reporter
- CLI:
--coverage.reporter <name>
- Konfig: coverage.reporter
Reportéry pokrytí k použití. Pro více informací navštivte coverage.reporter
(výchozí: ["text", "html", "clover", "json"]
).
coverage.reportOnFailure
- CLI:
--coverage.reportOnFailure
- Konfig: coverage.reportOnFailure
Generovat report pokrytí i v případě selhání testů (výchozí: false
).
coverage.allowExternal
- CLI:
--coverage.allowExternal
- Konfig: coverage.allowExternal
Sbírat pokrytí souborů mimo kořen projektu (výchozí: false
).
coverage.skipFull
- CLI:
--coverage.skipFull
- Konfig: coverage.skipFull
Nezobrazovat soubory se 100% pokrytím příkazů, větví a funkcí (výchozí: false
).
coverage.thresholds.100
- CLI:
--coverage.thresholds.100
- Konfig: coverage.thresholds.100
Zkratka pro nastavení všech prahových hodnot pokrytí na 100 % (výchozí: false
).
coverage.thresholds.perFile
- CLI:
--coverage.thresholds.perFile
- Konfig: coverage.thresholds.perFile
Kontrolovat prahové hodnoty pokrytí pro každý soubor. Skutečné prahové hodnoty naleznete v --coverage.thresholds.lines
, --coverage.thresholds.functions
, --coverage.thresholds.branches
a --coverage.thresholds.statements
(výchozí: false
).
coverage.thresholds.autoUpdate
- CLI:
--coverage.thresholds.autoUpdate
- Konfig: coverage.thresholds.autoUpdate
Automaticky aktualizovat prahové hodnoty: "lines", "functions", "branches" a "statements" v konfiguračním 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í implementace poskytovatelů.
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í implementace poskytovatelů.
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í implementace poskytovatelů.
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í implementace poskytovatelů.
coverage.ignoreClassMethods
- CLI:
--coverage.ignoreClassMethods <name>
- Konfig: coverage.ignoreClassMethods
Pole názvů metod tříd, které mají být ignorovány pro pokrytí. Pro více informací navštivte istanbuljs. Tato možnost je dostupná pouze pro poskytovatele Istanbul (výchozí: []
).
coverage.processingConcurrency
- CLI:
--coverage.processingConcurrency <number>
- Konfig: coverage.processingConcurrency
Limit souběžnosti použitý při zpracování výsledků pokrytí. (výchozí: minimum z 20 a počtu CPU).
coverage.customProviderModule
- CLI:
--coverage.customProviderModule <path>
- Konfig: coverage.customProviderModule
Určuje název modulu nebo cestu k modulu vlastní implementace poskytovatele pokrytí. Pro více informací navštivte Custom Coverage Provider. Tato možnost je dostupná pouze pro vlastní implementace poskytovatelů.
coverage.watermarks.statements
- CLI:
--coverage.watermarks.statements <watermarks>
Horní a dolní prahové hodnoty pro pokrytí příkazů ve formátu <high>,<low>
.
coverage.watermarks.lines
- CLI:
--coverage.watermarks.lines <watermarks>
Horní a dolní prahové hodnoty pro pokrytí řádků ve formátu <high>,<low>
.
coverage.watermarks.branches
- CLI:
--coverage.watermarks.branches <watermarks>
Horní a dolní prahové hodnoty pro pokrytí větví ve formátu <high>,<low>
.
coverage.watermarks.functions
- CLI:
--coverage.watermarks.functions <watermarks>
Horní a dolní prahové hodnoty pro pokrytí funkcí ve formátu <high>,<low>
.
mode
- CLI:
--mode <name>
- Konfig: mode
Přepsat režim Vite (výchozí: test
nebo benchmark
).
workspace
- CLI:
--workspace <path>
- Konfig: workspace
[Zastaralé] Cesta ke konfiguračnímu souboru pracovního prostoru.
isolate
- CLI:
--isolate
- Konfig: isolate
Spustit každý testovací soubor izolovaně. Pro vypnutí izolace použijte --no-isolate
(výchozí: true
).
globals
- CLI:
--globals
- Konfig: globals
Globálně injektovat API.
dom
- CLI:
--dom
Mockovat API prohlížeče pomocí happy-dom.
browser.enabled
- CLI:
--browser.enabled
- Konfig: browser.enabled
Spustit testy v prohlížeči (výchozí: false
).
browser.name
- CLI:
--browser.name <name>
- Konfig: browser.name
Spustit všechny testy v konkrétním prohlížeči. Některé prohlížeče jsou dostupné pouze u konkrétních poskytovatelů (viz --browser.provider
). Pro více informací navštivte browser.name
.
browser.headless
- CLI:
--browser.headless
- Konfig: browser.headless
Spustit prohlížeč v bezhlavém režimu (tj. bez otevření grafického uživatelského rozhraní (GUI)). Pokud spouštíte Vitest v CI, bude ve výchozím nastavení povoleno (výchozí: process.env.CI
).
browser.api.port
- CLI:
--browser.api.port [port]
- Konfig: browser.api.port
Určete port serveru. Pokud je port již používán, Vite se automaticky pokusí o další dostupný port, takže to nemusí být skutečný port, na kterém server nakonec poslouchá. Pokud je hodnota true
, bude nastaven na 63315
.
browser.api.host
- CLI:
--browser.api.host [host]
- Konfig: browser.api.host
Určete, na kterých IP adresách má server naslouchat. Nastavte tuto hodnotu 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
- CLI:
--browser.api.strictPort
- Konfig: browser.api.strictPort
Nastavte tuto hodnotu na true
pro ukončení, pokud je port již používán, namísto automatického pokusu o další dostupný port.
browser.provider
- CLI:
--browser.provider <name>
- Konfig: browser.provider
Poskytovatel použitý pro spouš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. Pro více informací navštivte browser.provider
(výchozí: "preview"
).
browser.providerOptions
- CLI:
--browser.providerOptions <options>
- Konfig: browser.providerOptions
Možnosti, které jsou předány poskytovateli prohlížeče. Pro více informací navštivte browser.providerOptions
.
browser.isolate
- CLI:
--browser.isolate
- Konfig: browser.isolate
Spustit každý testovací soubor prohlížeče izolovaně. Pro vypnutí izolace použijte --browser.isolate=false
(výchozí: true
).
browser.ui
- CLI:
--browser.ui
- Konfig: browser.ui
Zobrazit Vitest UI při spouštění testů (výchozí: !process.env.CI
).
browser.fileParallelism
- CLI:
--browser.fileParallelism
- Konfig: 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
).
browser.connectTimeout
- CLI:
--browser.connectTimeout <timeout>
- Konfig: browser.connectTimeout
Pokud připojení k prohlížeči trvá déle, testovací sada selže (výchozí: 60_000
).
pool
- CLI:
--pool <pool>
- Konfig: pool
Určete pool, pokud neběží v prohlížeči (výchozí: forks
).
poolOptions.threads.isolate
- CLI:
--poolOptions.threads.isolate
- Konfig: poolOptions.threads.isolate
Izolovat testy v poolu vláken (výchozí: true
).
poolOptions.threads.singleThread
- CLI:
--poolOptions.threads.singleThread
- Konfig: poolOptions.threads.singleThread
Spouštět testy v jednom vlákně (výchozí: false
).
poolOptions.threads.maxThreads
- CLI:
--poolOptions.threads.maxThreads <workers>
- Konfig: poolOptions.threads.maxThreads
Maximální počet nebo procento vláken pro spouštění testů.
poolOptions.threads.minThreads
- CLI:
--poolOptions.threads.minThreads <workers>
- Konfig: poolOptions.threads.minThreads
Minimální počet nebo procento vláken pro spouštění testů.
poolOptions.threads.useAtomics
- CLI:
--poolOptions.threads.useAtomics
- Konfig: poolOptions.threads.useAtomics
Použít 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
- CLI:
--poolOptions.vmThreads.isolate
- Konfig: poolOptions.vmThreads.isolate
Izolovat testy v poolu VM vláken (výchozí: true
).
poolOptions.vmThreads.singleThread
- CLI:
--poolOptions.vmThreads.singleThread
- Konfig: poolOptions.vmThreads.singleThread
Spouštět testy v jednom vlákně (výchozí: false
).
poolOptions.vmThreads.maxThreads
- CLI:
--poolOptions.vmThreads.maxThreads <workers>
- Konfig: poolOptions.vmThreads.maxThreads
Maximální počet nebo procento VM vláken pro spouštění testů.
poolOptions.vmThreads.minThreads
- CLI:
--poolOptions.vmThreads.minThreads <workers>
- Konfig: poolOptions.vmThreads.minThreads
Minimální počet nebo procento VM vláken pro spouštění testů.
poolOptions.vmThreads.useAtomics
- CLI:
--poolOptions.vmThreads.useAtomics
- Konfig: poolOptions.vmThreads.useAtomics
Použít 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
- CLI:
--poolOptions.vmThreads.memoryLimit <limit>
- Konfig: poolOptions.vmThreads.memoryLimit
Limit paměti pro pool VM vláken. Pokud zaznamenáte úniky paměti, zkuste tuto hodnotu upravit.
poolOptions.forks.isolate
- CLI:
--poolOptions.forks.isolate
- Konfig: poolOptions.forks.isolate
Izolovat testy v poolu forků (výchozí: true
).
poolOptions.forks.singleFork
- CLI:
--poolOptions.forks.singleFork
- Konfig: poolOptions.forks.singleFork
Spouštět testy v jednom child_process (výchozí: false
).
poolOptions.forks.maxForks
- CLI:
--poolOptions.forks.maxForks <workers>
- Konfig: poolOptions.forks.maxForks
Maximální počet nebo procento procesů pro spouštění testů.
poolOptions.forks.minForks
- CLI:
--poolOptions.forks.minForks <workers>
- Konfig: poolOptions.forks.minForks
Minimální počet nebo procento procesů pro spouštění testů.
poolOptions.vmForks.isolate
- CLI:
--poolOptions.vmForks.isolate
- Konfig: poolOptions.vmForks.isolate
Izolovat testy v poolu VM forků (výchozí: true
).
poolOptions.vmForks.singleFork
- CLI:
--poolOptions.vmForks.singleFork
- Konfig: poolOptions.vmForks.singleFork
Spouštět testy v jednom child_process (výchozí: false
).
poolOptions.vmForks.maxForks
- CLI:
--poolOptions.vmForks.maxForks <workers>
- Konfig: poolOptions.vmForks.maxForks
Maximální počet nebo procento VM procesů pro spouštění testů.
poolOptions.vmForks.minForks
- CLI:
--poolOptions.vmForks.minForks <workers>
- Konfig: poolOptions.vmForks.minForks
Minimální počet nebo procento VM procesů pro spouštění testů.
poolOptions.vmForks.memoryLimit
- CLI:
--poolOptions.vmForks.memoryLimit <limit>
- Konfig: poolOptions.vmForks.memoryLimit
Limit paměti pro pool VM forků. Pokud zaznamenáte úniky paměti, zkuste tuto hodnotu upravit.
fileParallelism
- CLI:
--fileParallelism
- Konfig: 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
- CLI:
--maxWorkers <workers>
- Konfig: maxWorkers
Maximální počet nebo procento workerů pro spouštění testů.
minWorkers
- CLI:
--minWorkers <workers>
- Konfig: minWorkers
Minimální počet nebo procento workerů pro spouštění testů.
environment
- CLI:
--environment <name>
- Konfig: environment
Určete prostředí runneru, pokud neběží v prohlížeči (výchozí: node
).
passWithNoTests
- CLI:
--passWithNoTests
- Konfig: passWithNoTests
Testy projdou, i když nejsou nalezeny žádné testy.
logHeapUsage
- CLI:
--logHeapUsage
- Konfig: logHeapUsage
Zobrazit velikost haldy pro každý test při spouštění v Node.
allowOnly
- CLI:
--allowOnly
- Konfig: allowOnly
Povolit testy a sady, které jsou označeny jako only
(výchozí: !process.env.CI
).
dangerouslyIgnoreUnhandledErrors
- CLI:
--dangerouslyIgnoreUnhandledErrors
- Konfig: dangerouslyIgnoreUnhandledErrors
Ignorovat veškeré neošetřené chyby, které se vyskytnou.
sequence.shuffle.files
- CLI:
--sequence.shuffle.files
- Konfig: sequence.shuffle.files
Spouštět soubory v náhodném pořadí. Povolení této možnosti nezajistí dřívější spuštění dlouhotrvajících testů. (výchozí: false
).
sequence.shuffle.tests
- CLI:
--sequence.shuffle.tests
- Konfig: sequence.shuffle.tests
Spouštět testy v náhodném pořadí (výchozí: false
).
sequence.concurrent
- CLI:
--sequence.concurrent
- Konfig: sequence.concurrent
Spouštět testy paralelně (výchozí: false
).
sequence.seed
- CLI:
--sequence.seed <seed>
- Konfig: sequence.seed
Nastavit semeno pro randomizaci. Tato možnost nebude mít žádný účinek, pokud je --sequence.shuffle
nastaveno na false
. Pro více informací navštivte stránku "Random Seed".
sequence.hooks
- CLI:
--sequence.hooks <order>
- Konfig: sequence.hooks
Mění pořadí, ve kterém jsou spouštěny hooky. Přijatelné hodnoty jsou: "stack", "list" a "parallel". Pro více informací navštivte sequence.hooks
(výchozí: "parallel"
).
sequence.setupFiles
- CLI:
--sequence.setupFiles <order>
- Konfig: 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", soubory nastavení se spustí paralelně (výchozí: "parallel"
).
inspect
- CLI:
--inspect [[host:]port]
- Konfig: inspect
Povolit Node.js inspektor (výchozí: 127.0.0.1:9229
).
inspectBrk
- CLI:
--inspectBrk [[host:]port]
- Konfig: inspectBrk
Povolit Node.js inspektor a zastavit se před spuštěním testu.
testTimeout
- CLI:
--testTimeout <timeout>
- Konfig: testTimeout
Výchozí časový limit testu v milisekundách (výchozí: 5000
). Použijte 0
pro úplné vypnutí časového limitu.
hookTimeout
- CLI:
--hookTimeout <timeout>
- Konfig: hookTimeout
Výchozí časový limit hooku v milisekundách (výchozí: 10000
). Použijte 0
pro úplné vypnutí časového limitu.
bail
- CLI:
--bail <number>
- Konfig: bail
Zastavit provádění testů, když selže daný počet testů (výchozí: 0
).
retry
- CLI:
--retry <times>
- Konfig: retry
Opakovat test zadaný početkrát, pokud selže (výchozí: 0
).
diff.aAnnotation
- CLI:
--diff.aAnnotation <annotation>
- Konfig: diff.aAnnotation
Anotace pro očekávané řádky (výchozí: Expected
).
diff.aIndicator
- CLI:
--diff.aIndicator <indicator>
- Konfig: diff.aIndicator
Indikátor pro očekávané řádky (výchozí: -
).
diff.bAnnotation
- CLI:
--diff.bAnnotation <annotation>
- Konfig: diff.bAnnotation
Anotace pro přijaté řádky (výchozí: Received
).
diff.bIndicator
- CLI:
--diff.bIndicator <indicator>
- Konfig: diff.bIndicator
Indikátor pro přijaté řádky (výchozí: +
).
diff.commonIndicator
- CLI:
--diff.commonIndicator <indicator>
- Konfig: diff.commonIndicator
Indikátor pro společné řádky (výchozí: ).
diff.contextLines
- CLI:
--diff.contextLines <lines>
- Konfig: diff.contextLines
Počet řádků kontextu, které se mají zobrazit kolem každé změny (výchozí: 5
).
diff.emptyFirstOrLastLinePlaceholder
- CLI:
--diff.emptyFirstOrLastLinePlaceholder <placeholder>
- Konfig: diff.emptyFirstOrLastLinePlaceholder
Zástupný symbol pro prázdný první nebo poslední řádek (výchozí: ""
).
diff.expand
- CLI:
--diff.expand
- Konfig: diff.expand
Rozbalit všechny společné řádky (výchozí: true
).
diff.includeChangeCounts
- CLI:
--diff.includeChangeCounts
- Konfig: diff.includeChangeCounts
Zahrnout počty změn do výstupu diffu (výchozí: false
).
diff.omitAnnotationLines
- CLI:
--diff.omitAnnotationLines
- Konfig: diff.omitAnnotationLines
Vynechat řádky anotací z výstupu (výchozí: false
).
diff.printBasicPrototype
- CLI:
--diff.printBasicPrototype
- Konfig: diff.printBasicPrototype
Vytisknout základní prototyp objektu a pole (výchozí: true
).
diff.maxDepth
- CLI:
--diff.maxDepth <maxDepth>
- Konfig: diff.maxDepth
Omezit hloubku rekurze při tisku vnořených objektů (výchozí: 20
).
diff.truncateThreshold
- CLI:
--diff.truncateThreshold <threshold>
- Konfig: diff.truncateThreshold
Počet řádků, které se mají zobrazit před a po každé změně (výchozí: 0
).
diff.truncateAnnotation
- CLI:
--diff.truncateAnnotation <annotation>
- Konfig: diff.truncateAnnotation
Anotace pro zkrácené řádky (výchozí: ... Diff result is truncated
).
exclude
- CLI:
--exclude <glob>
- Konfig: exclude
Další glob vzory souborů, které mají být vyloučeny z testu.
expandSnapshotDiff
- CLI:
--expandSnapshotDiff
- Konfig: expandSnapshotDiff
Zobrazit úplný diff, když snapshot selže.
disableConsoleIntercept
- CLI:
--disableConsoleIntercept
- Konfig: disableConsoleIntercept
Zakázat automatické zachycování logování konzole (výchozí: false
).
typecheck.enabled
- CLI:
--typecheck.enabled
- Konfig: typecheck.enabled
Povolit kontrolu typů spolu s testy (výchozí: false
).
typecheck.only
- CLI:
--typecheck.only
- Konfig: typecheck.only
Spustit pouze testy kontroly typů. Tím se automaticky povolí kontrola typů (výchozí: false
).
typecheck.checker
- CLI:
--typecheck.checker <name>
- Konfig: typecheck.checker
Určete 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
- CLI:
--typecheck.allowJs
- Konfig: typecheck.allowJs
Povolit kontrolu typů souborů JavaScript. Ve výchozím nastavení přebírá hodnotu z tsconfig.json.
typecheck.ignoreSourceErrors
- CLI:
--typecheck.ignoreSourceErrors
- Konfig: typecheck.ignoreSourceErrors
Ignorovat chyby typů ze zdrojových souborů.
typecheck.tsconfig
- CLI:
--typecheck.tsconfig <path>
- Konfig: typecheck.tsconfig
Cesta k vlastnímu souboru tsconfig.
typecheck.spawnTimeout
- CLI:
--typecheck.spawnTimeout <time>
- Konfig: typecheck.spawnTimeout
Minimální čas v milisekundách, který trvá spuštění nástroje pro kontrolu typů.
project
- CLI:
--project <name>
- Konfig: project
Název projektu, který má být spuštěn, pokud používáte funkci pracovního prostoru Vitest. Tuto možnost lze použít vícekrát pro více projektů: --project=1 --project=2
. Projekty můžete také filtrovat pomocí zástupných znaků, např. --project=packages*
, a vyloučit projekty pomocí --project=!pattern
.
slowTestThreshold
- CLI:
--slowTestThreshold <threshold>
- Konfig: slowTestThreshold
Prahová hodnota v milisekundách pro test nebo sadu, která má být považována za pomalou (výchozí: 300
).
teardownTimeout
- CLI:
--teardownTimeout <timeout>
- Konfig: teardownTimeout
Výchozí časový limit funkce teardown v milisekundách (výchozí: 10000
).
maxConcurrency
- CLI:
--maxConcurrency <number>
- Konfig: maxConcurrency
Maximální počet souběžných testů v sadě (výchozí: 5
).
expect.requireAssertions
- CLI:
--expect.requireAssertions
- Konfig: expect.requireAssertions
Vyžadovat, aby všechny testy měly alespoň jedno tvrzení.
expect.poll.interval
- CLI:
--expect.poll.interval <interval>
- Konfig: expect.poll.interval
Interval dotazování v milisekundách pro tvrzení expect.poll()
(výchozí: 50
).
expect.poll.timeout
- CLI:
--expect.poll.timeout <timeout>
- Konfig: expect.poll.timeout
Časový limit dotazování v milisekundách pro tvrzení expect.poll()
(výchozí: 1000
).
printConsoleTrace
- CLI:
--printConsoleTrace
- Konfig: printConsoleTrace
Vždy tisknout trasování zásobníku konzole.
includeTaskLocation
- CLI:
--includeTaskLocation
- Konfig: includeTaskLocation
Sbírat umístění testů a sad ve vlastnosti location
.
attachmentsDir
- CLI:
--attachmentsDir <dir>
- Konfig: attachmentsDir
Adresář, kam se ukládají přílohy z context.annotate
(výchozí: .vitest-attachments
).
run
- CLI:
--run
Vypnout režim sledování.
color
- CLI:
--no-color
Odebere barvy z výstupu konzole.
clearScreen
- CLI:
--clearScreen
Vymaže obrazovku terminálu při opětovném spouštění testů v režimu sledování (výchozí: true
).
configLoader
- CLI:
--configLoader <loader>
Použijte bundle
pro zabalení konfigurace s esbuild nebo runner
(experimentální) pro její zpracování za běhu. Tato možnost je dostupná pouze ve verzi Vite 6.1.0 a vyšší (výchozí: bundle
).
standalone
- CLI:
--standalone
Spustit Vitest bez spouštění testů. Filtry souborů budou ignorovány; testy se spustí pouze při změně (výchozí: false
).
changed
- Typ:
boolean | string
- Výchozí: false
Spustí testy pouze na změněných souborech. Pokud není zadána žádná hodnota, spustí testy na nepotvrzených změnách (včetně staged a unstaged).
Pro spuštění testů na základě změn provedených 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 použití s pokrytím kódu bude zpráva obsahovat pouze soubory, které souvisely se změnami.
Při spárování s konfigurační možností 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 testovací sadu.
shard
- Typ:
string
- Výchozí: disabled
Část testovací sady, která se má spustit ve formátu <index>
/<count>
, kde:
count
je kladné celé číslo, počet částí, na které se dělíindex
je kladné celé číslo, index jedné z rozdělených částí
Tento příkaz rozdělí všechny testy na count
stejných částí a spustí pouze ty, které se nacházejí v části s indexem index
. Například pro rozdělení testovací sady na tři části použijte toto:
vitest run --shard=1/3
vitest run --shard=2/3
vitest run --shard=3/3
WARNING
Tuto možnost nelze použít, pokud je --watch
povolen (ve výchozím nastavení povoleno ve vývojovém režimu).
TIP
Pokud je použit --reporter=blob
bez výstupního souboru, výchozí cesta bude obsahovat aktuální konfiguraci shardu, aby se zabránilo kolizím s jinými procesy Vitest.
merge-reports
- Typ:
boolean | string
Sloučí všechny zprávy typu blob umístěné v určené složce (ve výchozím nastavení .vitest-reports
). S tímto příkazem lze použít libovolné reportéry (kromě blob
):
vitest --merge-reports --reporter=junit