Befehlszeilenschnittstelle
Befehle
vitest
Startet Vitest im aktuellen Verzeichnis. Vitest läuft automatisch im Überwachungsmodus in der Entwicklungsumgebung und im Ausführungsmodus in CI.
Sie können ein zusätzliches Argument als Filter für die auszuführenden Testdateien übergeben. Zum Beispiel:
vitest foobar
Führt nur die Testdatei aus, deren Pfad foobar
enthält. Dieser Filter prüft lediglich, ob der Ausdruck enthalten ist, und unterstützt keine regulären Ausdrücke oder Glob-Muster (es sei denn, Ihr Terminal verarbeitet dies, bevor Vitest den Filter empfängt).
vitest run
Führt einen einzelnen Testdurchlauf ohne Überwachungsmodus durch.
vitest watch
Führt alle Test-Suites aus, überwacht jedoch Änderungen und führt Tests erneut aus, wenn sich Dateien ändern. Dies entspricht dem Aufruf von vitest
ohne Argument. In CI wird auf vitest run
zurückgegriffen.
vitest dev
Alias für vitest watch
.
vitest related
Führt nur Tests aus, die sich auf eine Liste von Quelldateien beziehen. Funktioniert mit statischen Importen (z.B. import('./index.js')
oder import index from './index.js
), jedoch nicht mit dynamischen (z.B. import(filepath)
). Alle Dateien müssen relativ zum Stammordner angegeben werden.
Nützlich in Verbindung mit lint-staged
oder Ihrer CI-Einrichtung.
vitest related /src/index.ts /src/hello-world.js
TIP
Beachten Sie, dass Vitest standardmäßig im Überwachungsmodus läuft. Wenn Sie Tools wie lint-staged
verwenden, sollten Sie auch die Option --run
übergeben, damit der Befehl korrekt beendet werden kann.
// .lintstagedrc.js
export default {
'*.{js,ts}': 'vitest related --run',
};
vitest bench
Führt nur Benchmarking-Tests aus, die Leistungsdaten vergleichen.
vitest init
vitest init <name>
kann verwendet werden, um die Projektkonfiguration einzurichten. Derzeit wird nur der Wert browser
unterstützt:
vitest init browser
vitest list
Der Befehl vitest list
übernimmt alle vitest
-Optionen, um die Liste aller übereinstimmenden Tests auszugeben. Dieser Befehl ignoriert die Option reporters
. Standardmäßig werden die Namen aller Tests ausgegeben, die dem Dateifilter und dem Namensmuster entsprechen:
vitest list filename.spec.ts -t="some-test"
describe > some-test
describe > some-test > test 1
describe > some-test > test 2
Sie können das Flag --json
übergeben, um Tests im JSON-Format auszugeben oder in einer separaten Datei zu speichern:
vitest list filename.spec.ts -t="some-test" --json=./file.json
Wird das Flag --json
ohne Wert angegeben, wird das JSON in stdout ausgegeben.
Sie können auch das Flag --filesOnly
übergeben, um nur die Testdateien auszugeben:
vitest list --filesOnly
tests/test1.test.ts
tests/test2.test.ts
Optionen
TIP
Vitest unterstützt sowohl Camel Case als auch Kebab Case für CLI-Argumente. Zum Beispiel funktionieren --passWithNoTests
und --pass-with-no-tests
beide (--no-color
und --inspect-brk
sind die Ausnahmen).
Vitest unterstützt auch verschiedene Arten der Wertangabe: --reporter dot
und --reporter=dot
sind beide gültig.
Wenn eine Option ein Array von Werten unterstützt, müssen Sie die Option mehrmals übergeben:
vitest --reporter=dot --reporter=default
Boolesche Optionen können mit dem Präfix no-
negiert werden. Die Angabe des Wertes als false
funktioniert ebenfalls:
vitest --no-api
vitest --api=false
root
- CLI:
-r, --root <path>
- Config: root
Definiert den Wurzelpfad des Projekts.
config
- CLI:
-c, --config <path>
Gibt den Pfad zur Konfigurationsdatei an.
update
- CLI:
-u, --update
- Config: update
Aktualisiert Snapshots.
watch
- CLI:
-w, --watch
- Config: watch
Aktiviert den Überwachungsmodus.
testNamePattern
- CLI:
-t, --testNamePattern <pattern>
- Config: testNamePattern
Führt Tests aus, deren vollständige Namen dem angegebenen regulären Ausdrucksmuster entsprechen.
dir
- CLI:
--dir <path>
- Config: dir
Legt das Basisverzeichnis für die Suche nach Testdateien fest.
ui
- CLI:
--ui
- Config: ui
Aktiviert die Benutzeroberfläche.
open
- CLI:
--open
- Config: open
Öffnet die Benutzeroberfläche automatisch (Standard: !process.env.CI
).
api.port
- CLI:
--api.port [port]
Gibt den Server-Port an. Beachten Sie: Falls der Port bereits belegt ist, versucht Vite automatisch den nächsten verfügbaren Port. Dies bedeutet, dass der Server möglicherweise nicht auf dem ursprünglich angegebenen Port lauscht. Wenn der Wert auf true
gesetzt ist, wird der Port 51204
verwendet.
api.host
- CLI:
--api.host [host]
Gibt an, auf welchen IP-Adressen der Server empfangen soll. Setzen Sie dies auf 0.0.0.0
oder true
, um auf allen Adressen zu empfangen, einschließlich LAN- und öffentlichen Adressen.
api.strictPort
- CLI:
--api.strictPort
Auf true
setzen, um zu beenden, wenn der Port bereits verwendet wird, anstatt automatisch den nächsten verfügbaren Port zu versuchen.
silent
- CLI:
--silent
- Config: silent
Unterdrückt die Konsolenausgabe von Tests.
hideSkippedTests
- CLI:
--hideSkippedTests
Blendet Logs für übersprungene Tests aus.
reporters
- CLI:
--reporter <name>
- Config: reporters
Gibt die zu verwendenden Reporter an.
outputFile
- CLI:
--outputFile <filename/-s>
- Config: outputFile
Schreibt Testergebnisse in eine Datei, wenn ein unterstützter Reporter angegeben ist. Verwenden Sie die Punktnotation von cac für individuelle Ausgaben mehrerer Reporter (Beispiel: --outputFile.tap=./tap.txt
).
coverage.all
- CLI:
--coverage.all
- Config: coverage.all
Gibt an, ob alle Dateien, einschließlich der ungetesteten, in den Coverage-Bericht aufgenommen werden sollen.
coverage.provider
- CLI:
--coverage.provider <name>
- Config: coverage.provider
Wählt das Tool für die Coverage-Erfassung. Verfügbare Werte sind: "v8", "istanbul" und "custom".
coverage.enabled
- CLI:
--coverage.enabled
- Config: coverage.enabled
Aktiviert die Coverage-Erfassung. Kann über die CLI-Option --coverage
überschrieben werden (Standard: false
).
coverage.include
- CLI:
--coverage.include <pattern>
- Config: coverage.include
Dateien, die in die Coverage aufgenommen werden sollen, als Glob-Muster. Kann bei Verwendung mehrerer Muster mehrfach angegeben werden (Standard: **
).
coverage.exclude
- CLI:
--coverage.exclude <pattern>
- Config: coverage.exclude
Dateien, die von der Coverage ausgeschlossen werden sollen. Kann bei Verwendung mehrerer Muster mehrfach angegeben werden (Standard: Siehe coverage.exclude
).
coverage.extension
- CLI:
--coverage.extension <extension>
- Config: coverage.extension
Dateierweiterungen, die in die Coverage aufgenommen werden sollen. Kann bei Verwendung mehrerer Erweiterungen mehrfach angegeben werden (Standard: [".js", ".cjs", ".mjs", ".ts", ".mts", ".tsx", ".jsx", ".vue", ".svelte"]
).
coverage.clean
- CLI:
--coverage.clean
- Config: coverage.clean
Setzt Coverage-Ergebnisse vor dem Testlauf zurück (Standard: true
).
coverage.cleanOnRerun
- CLI:
--coverage.cleanOnRerun
- Config: coverage.cleanOnRerun
Bereinigt den Coverage-Bericht bei erneutem Watch-Lauf (Standard: true
).
coverage.reportsDirectory
- CLI:
--coverage.reportsDirectory <path>
- Config: coverage.reportsDirectory
Verzeichnis, in das der Coverage-Bericht geschrieben werden soll (Standard: ./coverage
).
coverage.reporter
- CLI:
--coverage.reporter <name>
- Config: coverage.reporter
Die zu verwendenden Coverage-Reporter. Weitere Informationen finden Sie unter coverage.reporter
(Standard: ["text", "html", "clover", "json"]
).
coverage.reportOnFailure
- CLI:
--coverage.reportOnFailure
- Config: coverage.reportOnFailure
Generiert den Coverage-Bericht auch bei fehlgeschlagenen Tests (Standard: false
).
coverage.allowExternal
- CLI:
--coverage.allowExternal
- Config: coverage.allowExternal
Erfasst Coverage von Dateien außerhalb des Projekt-Root-Verzeichnisses (Standard: false
).
coverage.skipFull
- CLI:
--coverage.skipFull
- Config: coverage.skipFull
Zeigt Dateien mit 100% Anweisungs-, Branch- und Funktions-Coverage nicht an (Standard: false
).
coverage.thresholds.100
- CLI:
--coverage.thresholds.100
- Config: coverage.thresholds.100
Kurzbefehl, um alle Coverage-Schwellenwerte auf 100 zu setzen (Standard: false
).
coverage.thresholds.perFile
- CLI:
--coverage.thresholds.perFile
- Config: coverage.thresholds.perFile
Prüft Schwellenwerte pro Datei. Siehe --coverage.thresholds.lines
, --coverage.thresholds.functions
, --coverage.thresholds.branches
und --coverage.thresholds.statements
für die tatsächlichen Schwellenwerte (Standard: false
).
coverage.thresholds.autoUpdate
- CLI:
--coverage.thresholds.autoUpdate
- Config: coverage.thresholds.autoUpdate
Aktualisiert die Schwellenwerte für "lines", "functions", "branches" und "statements" in der Konfigurationsdatei, wenn die aktuelle Coverage über den konfigurierten Schwellenwerten liegt (Standard: false
).
coverage.thresholds.lines
- CLI:
--coverage.thresholds.lines <number>
Schwellenwert für Zeilen-Coverage. Weitere Informationen finden Sie unter istanbuljs. Diese Option ist für benutzerdefinierte Provider nicht verfügbar.
coverage.thresholds.functions
- CLI:
--coverage.thresholds.functions <number>
Schwellenwert für Funktions-Coverage. Weitere Informationen finden Sie unter istanbuljs. Diese Option ist für benutzerdefinierte Provider nicht verfügbar.
coverage.thresholds.branches
- CLI:
--coverage.thresholds.branches <number>
Schwellenwert für Branch-Coverage. Weitere Informationen finden Sie unter istanbuljs. Diese Option ist für benutzerdefinierte Provider nicht verfügbar.
coverage.thresholds.statements
- CLI:
--coverage.thresholds.statements <number>
Schwellenwert für Anweisungs-Coverage. Weitere Informationen finden Sie unter istanbuljs. Diese Option ist für benutzerdefinierte Provider nicht verfügbar.
coverage.ignoreClassMethods
- CLI:
--coverage.ignoreClassMethods <name>
- Config: coverage.ignoreClassMethods
Ein Array von Klassennamen von Methoden, die für die Coverage ignoriert werden sollen. Weitere Informationen finden Sie unter istanbuljs. Diese Option ist nur für Istanbul-Provider verfügbar (Standard: []
).
coverage.processingConcurrency
- CLI:
--coverage.processingConcurrency <number>
- Config: coverage.processingConcurrency
Das Parallelitätslimit, das beim Verarbeiten der Coverage-Ergebnisse verwendet wird (Standard: das Minimum aus 20 und der Anzahl der CPUs).
coverage.customProviderModule
- CLI:
--coverage.customProviderModule <path>
- Config: coverage.customProviderModule
Gibt den Modulnamen oder Pfad für das benutzerdefinierte Coverage-Provider-Modul an. Weitere Informationen finden Sie unter Custom Coverage Provider. Diese Option ist nur für benutzerdefinierte Provider verfügbar.
coverage.watermarks.statements
- CLI:
--coverage.watermarks.statements <watermarks>
Hohe und niedrige Wasserzeichen für Anweisungen im Format <hoch>,<niedrig>
.
coverage.watermarks.lines
- CLI:
--coverage.watermarks.lines <watermarks>
Hohe und niedrige Wasserzeichen für Zeilen im Format <hoch>,<niedrig>
.
coverage.watermarks.branches
- CLI:
--coverage.watermarks.branches <watermarks>
Hohe und niedrige Wasserzeichen für Branches im Format <hoch>,<niedrig>
.
coverage.watermarks.functions
- CLI:
--coverage.watermarks.functions <watermarks>
Hohe und niedrige Wasserzeichen für Funktionen im Format <hoch>,<niedrig>
.
mode
- CLI:
--mode <name>
- Config: mode
Überschreibt den Vite-Modus (Standard: test
oder benchmark
).
workspace
- CLI:
--workspace <path>
- Config: workspace
Pfad zu einer Workspace-Konfigurationsdatei.
isolate
- CLI:
--isolate
- Config: isolate
Führt jede Testdatei isoliert aus. Um die Isolation zu deaktivieren, verwenden Sie --no-isolate
(Standard: true
).
globals
- CLI:
--globals
- Config: globals
Stellt APIs global bereit.
dom
- CLI:
--dom
Mockt Browser-APIs mit happy-dom.
browser.enabled
- CLI:
--browser.enabled
- Config: browser.enabled
Aktiviert das Ausführen von Tests im Browser (Standard: false
).
browser.name
- CLI:
--browser.name <name>
- Config: browser.name
Führt alle Tests in einem bestimmten Browser aus. Einige Browser sind nur für bestimmte Provider verfügbar (siehe --browser.provider
). Weitere Informationen finden Sie unter browser.name
.
browser.headless
- CLI:
--browser.headless
- Config: browser.headless
Führt den Browser im Headless-Modus aus (d.h. ohne Öffnen der grafischen Benutzeroberfläche). Wenn Vitest in CI ausgeführt wird, ist dies standardmäßig aktiviert (Standard: process.env.CI
).
browser.api.port
- CLI:
--browser.api.port [port]
- Config: browser.api.port
Gibt den Server-Port an. Beachten Sie: Falls der Port bereits belegt ist, versucht Vite automatisch den nächsten verfügbaren Port. Dies bedeutet, dass der Server möglicherweise nicht auf dem ursprünglich angegebenen Port lauscht. Wenn der Wert auf true
gesetzt ist, wird der Port 63315
verwendet.
browser.api.host
- CLI:
--browser.api.host [host]
- Config: browser.api.host
Gibt an, auf welchen IP-Adressen der Server empfangen soll. Setzen Sie dies auf 0.0.0.0
oder true
, um auf allen Adressen zu empfangen, einschließlich LAN- und öffentlichen Adressen.
browser.api.strictPort
- CLI:
--browser.api.strictPort
- Config: browser.api.strictPort
Auf true
setzen, um zu beenden, wenn der Port bereits verwendet wird, anstatt automatisch den nächsten verfügbaren Port zu versuchen.
browser.provider
- CLI:
--browser.provider <name>
- Config: browser.provider
Der Provider, der zum Ausführen von Browser-Tests verwendet wird. Einige Browser sind nur für bestimmte Provider verfügbar. Kann "webdriverio", "playwright", "preview" oder der Pfad zu einem benutzerdefinierten Provider sein. Weitere Informationen finden Sie unter browser.provider
(Standard: "preview"
).
browser.providerOptions
- CLI:
--browser.providerOptions <options>
- Config: browser.providerOptions
Optionen, die an einen Browser-Provider weitergegeben werden. Weitere Informationen finden Sie unter browser.providerOptions
.
browser.isolate
- CLI:
--browser.isolate
- Config: browser.isolate
Führt jede Browser-Testdatei isoliert aus. Um die Isolation zu deaktivieren, verwenden Sie --browser.isolate=false
(Standard: true
).
browser.ui
- CLI:
--browser.ui
- Config: browser.ui
Zeigt die Vitest UI beim Ausführen von Tests an (Standard: !process.env.CI
).
browser.fileParallelism
- CLI:
--browser.fileParallelism
- Config: browser.fileParallelism
Legt fest, ob Browser-Testdateien parallel ausgeführt werden sollen. Verwenden Sie --browser.fileParallelism=false
, um dies zu deaktivieren (Standard: true
).
pool
- CLI:
--pool <pool>
- Config: pool
Gibt den Pool an, wenn nicht im Browser ausgeführt wird (Standard: threads
).
poolOptions.threads.isolate
- CLI:
--poolOptions.threads.isolate
- Config: poolOptions.threads.isolate
Isoliert Tests im Threads-Pool (Standard: true
).
poolOptions.threads.singleThread
- CLI:
--poolOptions.threads.singleThread
- Config: poolOptions.threads.singleThread
Führt Tests in einem einzigen Thread aus (Standard: false
).
poolOptions.threads.maxThreads
- CLI:
--poolOptions.threads.maxThreads <workers>
- Config: poolOptions.threads.maxThreads
Maximale Anzahl oder Prozentsatz von Threads, in denen Tests ausgeführt werden sollen.
poolOptions.threads.minThreads
- CLI:
--poolOptions.threads.minThreads <workers>
- Config: poolOptions.threads.minThreads
Minimale Anzahl oder Prozentsatz von Threads, in denen Tests ausgeführt werden sollen.
poolOptions.threads.useAtomics
- CLI:
--poolOptions.threads.useAtomics
- Config: poolOptions.threads.useAtomics
Verwendet Atomics zur Synchronisierung von Threads. Dies kann in einigen Fällen die Leistung verbessern, kann aber in älteren Node-Versionen zu Segmentierungsfehlern führen (Standard: false
).
poolOptions.vmThreads.isolate
- CLI:
--poolOptions.vmThreads.isolate
- Config: poolOptions.vmThreads.isolate
Isoliert Tests im VM-Threads-Pool (Standard: true
).
poolOptions.vmThreads.singleThread
- CLI:
--poolOptions.vmThreads.singleThread
- Config: poolOptions.vmThreads.singleThread
Führt Tests in einem einzigen Thread aus (Standard: false
).
poolOptions.vmThreads.maxThreads
- CLI:
--poolOptions.vmThreads.maxThreads <workers>
- Config: poolOptions.vmThreads.maxThreads
Maximale Anzahl oder Prozentsatz von Threads, in denen Tests ausgeführt werden sollen.
poolOptions.vmThreads.minThreads
- CLI:
--poolOptions.vmThreads.minThreads <workers>
- Config: poolOptions.vmThreads.minThreads
Minimale Anzahl oder Prozentsatz von Threads, in denen Tests ausgeführt werden sollen.
poolOptions.vmThreads.useAtomics
- CLI:
--poolOptions.vmThreads.useAtomics
- Config: poolOptions.vmThreads.useAtomics
Verwendet Atomics zur Synchronisierung von Threads. Dies kann in einigen Fällen die Leistung verbessern, kann aber in älteren Node-Versionen zu Segmentierungsfehlern führen (Standard: false
).
poolOptions.vmThreads.memoryLimit
- CLI:
--poolOptions.vmThreads.memoryLimit <limit>
- Config: poolOptions.vmThreads.memoryLimit
Speicherlimit für den VM-Threads-Pool. Wenn Sie Speicherlecks feststellen, versuchen Sie, diesen Wert anzupassen.
poolOptions.forks.isolate
- CLI:
--poolOptions.forks.isolate
- Config: poolOptions.forks.isolate
Isoliert Tests im Forks-Pool (Standard: true
).
poolOptions.forks.singleFork
- CLI:
--poolOptions.forks.singleFork
- Config: poolOptions.forks.singleFork
Führt Tests in einem einzigen Kindprozess aus (Standard: false
).
poolOptions.forks.maxForks
- CLI:
--poolOptions.forks.maxForks <workers>
- Config: poolOptions.forks.maxForks
Maximale Anzahl oder Prozentsatz der Prozesse, in denen Tests ausgeführt werden sollen.
poolOptions.forks.minForks
- CLI:
--poolOptions.forks.minForks <workers>
- Config: poolOptions.forks.minForks
Minimale Anzahl oder Prozentsatz von Prozessen, in denen Tests ausgeführt werden sollen.
poolOptions.vmForks.isolate
- CLI:
--poolOptions.vmForks.isolate
- Config: poolOptions.vmForks.isolate
Isoliert Tests im VM-Forks-Pool (Standard: true
).
poolOptions.vmForks.singleFork
- CLI:
--poolOptions.vmForks.singleFork
- Config: poolOptions.vmForks.singleFork
Führt Tests in einem einzigen Kindprozess aus (Standard: false
).
poolOptions.vmForks.maxForks
- CLI:
--poolOptions.vmForks.maxForks <workers>
- Config: poolOptions.vmForks.maxForks
Maximale Anzahl oder Prozentsatz von Prozessen, in denen Tests ausgeführt werden sollen.
poolOptions.vmForks.minForks
- CLI:
--poolOptions.vmForks.minForks <workers>
- Config: poolOptions.vmForks.minForks
Minimale Anzahl oder Prozentsatz von Prozessen, in denen Tests ausgeführt werden sollen.
poolOptions.vmForks.memoryLimit
- CLI:
--poolOptions.vmForks.memoryLimit <limit>
- Config: poolOptions.vmForks.memoryLimit
Speicherlimit für den VM-Forks-Pool. Wenn Sie Speicherlecks feststellen, versuchen Sie, diesen Wert anzupassen.
fileParallelism
- CLI:
--fileParallelism
- Config: fileParallelism
Legt fest, ob alle Testdateien parallel ausgeführt werden sollen. Verwenden Sie --no-file-parallelism
, um dies zu deaktivieren (Standard: true
).
maxWorkers
- CLI:
--maxWorkers <workers>
- Config: maxWorkers
Maximale Anzahl oder Prozentsatz von Workern, in denen Tests ausgeführt werden sollen.
minWorkers
- CLI:
--minWorkers <workers>
- Config: minWorkers
Minimale Anzahl oder Prozentsatz von Workern, in denen Tests ausgeführt werden sollen.
environment
- CLI:
--environment <name>
- Config: environment
Gibt die Runner-Umgebung an, wenn nicht im Browser ausgeführt wird (Standard: node
).
passWithNoTests
- CLI:
--passWithNoTests
- Config: passWithNoTests
Markiert den Testlauf als bestanden, wenn keine Tests gefunden werden.
logHeapUsage
- CLI:
--logHeapUsage
- Config: logHeapUsage
Zeigt die Größe des Heaps für jeden Test an, wenn er in Node ausgeführt wird.
allowOnly
- CLI:
--allowOnly
- Config: allowOnly
Erlaubt nur Tests und Suiten, die als "only" markiert sind (Standard: !process.env.CI
).
dangerouslyIgnoreUnhandledErrors
- CLI:
--dangerouslyIgnoreUnhandledErrors
- Config: dangerouslyIgnoreUnhandledErrors
Ignoriert alle unbehandelten Fehler, die auftreten.
sequence.shuffle.files
- CLI:
--sequence.shuffle.files
- Config: sequence.shuffle.files
Führt Dateien in zufälliger Reihenfolge aus. Langlaufende Tests starten nicht früher, wenn Sie diese Option aktivieren (Standard: false
).
sequence.shuffle.tests
- CLI:
--sequence.shuffle.tests
- Config: sequence.shuffle.tests
Führt Tests in zufälliger Reihenfolge aus (Standard: false
).
sequence.concurrent
- CLI:
--sequence.concurrent
- Config: sequence.concurrent
Führt Tests parallel aus (Standard: false
).
sequence.seed
- CLI:
--sequence.seed <seed>
- Config: sequence.seed
Legt den Randomisierungs-Seed fest. Diese Option hat keine Auswirkung, wenn --sequence.shuffle
deaktiviert ist. Weitere Informationen finden Sie auf der Seite "Random Seed".
sequence.hooks
- CLI:
--sequence.hooks <order>
- Config: sequence.hooks
Ändert die Reihenfolge, in der Hooks ausgeführt werden. Akzeptierte Werte sind: "stack", "list" und "parallel". Weitere Informationen finden Sie unter sequence.hooks
(Standard: "parallel"
).
sequence.setupFiles
- CLI:
--sequence.setupFiles <order>
- Config: sequence.setupFiles
Ändert die Reihenfolge, in der Setup-Dateien ausgeführt werden. Akzeptierte Werte sind: "list" und "parallel". Wenn auf "list" gesetzt, werden Setup-Dateien in der Reihenfolge ausgeführt, in der sie definiert sind. Wenn auf "parallel" gesetzt, werden Setup-Dateien parallel ausgeführt (Standard: "parallel"
).
inspect
- CLI:
--inspect [[host:]port]
- Config: inspect
Aktiviert den Node.js Inspector (Standard: 127.0.0.1:9229
).
inspectBrk
- CLI:
--inspectBrk [[host:]port]
- Config: inspectBrk
Aktiviert den Node.js Inspector und hält vor dem Start des Tests an.
testTimeout
- CLI:
--testTimeout <timeout>
- Config: testTimeout
Standard-Timeout für Tests in Millisekunden (Standard: 5000
).
hookTimeout
- CLI:
--hookTimeout <timeout>
- Config: hookTimeout
Standard-Hook-Timeout in Millisekunden (Standard: 10000
).
bail
- CLI:
--bail <number>
- Config: bail
Stoppt die Testausführung, wenn die angegebene Anzahl von Tests fehlgeschlagen ist (Standard: 0
).
retry
- CLI:
--retry <times>
- Config: retry
Wiederholt den Test bei Fehlschlag eine bestimmte Anzahl von Malen (Standard: 0
).
diff
- CLI:
--diff <path>
- Config: diff
Pfad zu einer Diff-Konfiguration, die zur Generierung der Diff-Ansicht verwendet wird.
exclude
- CLI:
--exclude <glob>
- Config: exclude
Zusätzliche Dateiglobs, die von Tests ausgeschlossen werden sollen.
expandSnapshotDiff
- CLI:
--expandSnapshotDiff
- Config: expandSnapshotDiff
Zeigt den vollständigen Diff an, wenn der Snapshot fehlschlägt.
disableConsoleIntercept
- CLI:
--disableConsoleIntercept
- Config: disableConsoleIntercept
Deaktiviert das automatische Abfangen der Konsolenprotokollierung (Standard: false
).
typecheck.enabled
- CLI:
--typecheck.enabled
- Config: typecheck.enabled
Aktiviert die Typüberprüfung während der Tests (Standard: false
).
typecheck.only
- CLI:
--typecheck.only
- Config: typecheck.only
Führt nur Typüberprüfungs-Tests aus. Dies aktiviert die Typüberprüfung automatisch (Standard: false
).
typecheck.checker
- CLI:
--typecheck.checker <name>
- Config: typecheck.checker
Gibt den zu verwendenden Typüberprüfer an. Verfügbare Werte sind: "tsc" und "vue-tsc" sowie ein Pfad zu einer ausführbaren Datei (Standard: "tsc"
).
typecheck.allowJs
- CLI:
--typecheck.allowJs
- Config: typecheck.allowJs
Erlaubt JavaScript-Dateien zur Typüberprüfung. Übernimmt standardmäßig den Wert aus tsconfig.json.
typecheck.ignoreSourceErrors
- CLI:
--typecheck.ignoreSourceErrors
- Config: typecheck.ignoreSourceErrors
Ignoriert Typfehler aus Quelldateien.
typecheck.tsconfig
- CLI:
--typecheck.tsconfig <path>
- Config: typecheck.tsconfig
Pfad zu einer benutzerdefinierten tsconfig-Datei.
project
- CLI:
--project <name>
- Config: project
Der Name des Projekts, das ausgeführt werden soll, wenn Sie die Vitest-Workspace-Funktion verwenden. Dies kann für mehrere Projekte wiederholt werden: --project=1 --project=2
. Sie können Projekte auch mit Wildcards filtern, z.B. --project=packages*
.
slowTestThreshold
- CLI:
--slowTestThreshold <threshold>
- Config: slowTestThreshold
Schwellenwert in Millisekunden, ab dem ein Test als langsam gilt (Standard: 300
).
teardownTimeout
- CLI:
--teardownTimeout <timeout>
- Config: teardownTimeout
Standard-Timeout einer Teardown-Funktion in Millisekunden (Standard: 10000
).
maxConcurrency
- CLI:
--maxConcurrency <number>
- Config: maxConcurrency
Maximale Anzahl gleichzeitiger Tests in einer Suite (Standard: 5
).
expect.requireAssertions
- CLI:
--expect.requireAssertions
- Config: expect.requireAssertions
Erfordert, dass alle Tests mindestens eine Assertion haben.
expect.poll.interval
- CLI:
--expect.poll.interval <interval>
- Config: expect.poll.interval
Abfrageintervall in Millisekunden für expect.poll()
-Assertions (Standard: 50
).
expect.poll.timeout
- CLI:
--expect.poll.timeout <timeout>
- Config: expect.poll.timeout
Abfrage-Timeout in Millisekunden für expect.poll()
-Assertions (Standard: 1000
).
printConsoleTrace
- CLI:
--printConsoleTrace
- Config: printConsoleTrace
Gibt Konsolen-Stack-Traces immer aus.
run
- CLI:
--run
Deaktiviert den Watch-Modus.
color
- CLI:
--no-color
Entfernt Farben aus der Konsolenausgabe.
clearScreen
- CLI:
--clearScreen
Leert das Terminal, wenn Tests im Watch-Modus erneut ausgeführt werden (Standard: true
).
standalone
- CLI:
--standalone
Startet Vitest, ohne Tests auszuführen. Dateifilter werden ignoriert, Tests werden nur bei Dateiänderungen ausgeführt (Standard: false
).
changed
- Typ:
boolean | string
- Standard: false
Führt Tests nur für geänderte Dateien aus. Wenn kein Wert angegeben wird, werden Tests für nicht festgeschriebene Änderungen (einschließlich gestageter und ungestageter) ausgeführt.
Um Tests für Änderungen auszuführen, die im letzten Commit vorgenommen wurden, können Sie --changed HEAD~1
verwenden. Sie können auch einen Commit-Hash (z.B. --changed 09a9920
) oder einen Branch-Namen (z.B. --changed origin/develop
) übergeben.
Bei Verwendung mit Code Coverage enthält der Bericht nur die Dateien, die von den Änderungen betroffen waren.
Wenn es in Kombination mit der Konfigurationsoption forceRerunTriggers
verwendet wird, wird die gesamte Testsuite ausgeführt, wenn sich mindestens eine Datei aus der forceRerunTriggers
-Liste ändert. Standardmäßig führen Änderungen an der Vitest-Konfigurationsdatei und package.json
immer die gesamte Suite erneut aus.
shard
- Typ:
string
- Standard: disabled
Test-Suite-Shard, der im Format <index>
/<count>
ausgeführt werden soll, wobei
count
eine positive Ganzzahl ist und die Anzahl der aufgeteilten Teile angibtindex
eine positive Ganzzahl ist und den Index des aufgeteilten Teils angibt
Dieser Befehl teilt alle Tests in count
gleich große Teile und führt nur die Tests aus, die dem index
-Teil zugeordnet sind. Um Ihre Testsuite beispielsweise in drei Teile zu teilen, verwenden Sie dazu Folgendes:
vitest run --shard=1/3
vitest run --shard=2/3
vitest run --shard=3/3
WARNING
Sie können diese Option nicht mit aktiviertem --watch
verwenden (standardmäßig in der Entwicklung aktiviert).
TIP
Wenn --reporter=blob
ohne Ausgabedatei verwendet wird, enthält der Standard-Pfad die aktuelle Shard-Konfiguration, um Kollisionen mit anderen Vitest-Prozessen zu vermeiden.
merge-reports
- Typ:
boolean | string
Führt alle blob
-Berichte zusammen, die sich im angegebenen Ordner befinden (standardmäßig .vitest-reports
). Sie können mit diesem Befehl beliebige Reporter verwenden (außer blob
):
vitest --merge-reports --reporter=junit