Vitest 2

Polski

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

Polski

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

Wygląd

Interfejs Wiersza Poleceń ​

Polecenia ​

vitest ​

Uruchamia Vitest w bieżącym katalogu. Automatycznie przełącza się w tryb obserwacji w środowisku deweloperskim i w tryb jednorazowego wykonania w środowisku CI.

Możesz przekazać dodatkowy argument jako filtr plików testowych do uruchomienia. Na przykład:

bash
vitest foobar

Uruchomi tylko te pliki testowe, których ścieżki zawierają foobar. Ten filtr służy wyłącznie do włączania i nie obsługuje wyrażeń regularnych ani wzorców glob (chyba że Twój terminal przetworzy je, zanim Vitest otrzyma filtr).

vitest run ​

Wykonuje jednorazowe uruchomienie testów bez trybu obserwacji.

vitest watch ​

Uruchamia wszystkie zestawy testowe, a następnie obserwuje zmiany i ponownie wykonuje testy, gdy pliki ulegną modyfikacji. Jest to równoważne wywołaniu vitest bez argumentu. W środowisku CI przełączy się na vitest run.

vitest dev ​

Alias dla vitest watch.

Uruchamia tylko testy, które obejmują listę plików źródłowych. Działa ze statycznymi importami (np. import('./index.js') lub import index from './index.js), ale nie z dynamicznymi (np. import(filepath)). Wszystkie ścieżki plików powinny być względne w stosunku do folderu głównego projektu.

Przydatne w połączeniu z lint-staged lub w konfiguracjach CI.

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

TIP

Pamiętaj, że Vitest domyślnie działa z włączonym trybem obserwacji. Jeśli używasz narzędzi takich jak lint-staged, należy również przekazać opcję --run, aby polecenie mogło zakończyć się normalnie.

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

vitest bench ​

Uruchamia tylko testy benchmarkowe, które służą do porównywania wyników wydajności.

vitest init ​

vitest init <name> może być użyte do skonfigurowania projektu. Obecnie obsługuje tylko wartość browser:

bash
vitest init browser

vitest list ​

Polecenie vitest list przyjmuje wszystkie opcje vitest w celu wyświetlenia listy wszystkich pasujących testów. To polecenie ignoruje opcję reporters. Domyślnie zostaną wyświetlone nazwy wszystkich testów, które pasują do filtra plików i wzorca nazwy testu:

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

Możesz przekazać flagę --json, aby wyeksportować testy w formacie JSON lub zapisać je w oddzielnym pliku.

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

Jeśli flaga --json nie otrzyma wartości, JSON zostanie wyprowadzony na standardowe wyjście (stdout).

Możesz również przekazać flagę --filesOnly, aby wydrukować tylko nazwy plików testowych:

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

Opcje ​

TIP

Vitest obsługuje zarówno notację camel case, jak i kebab case dla argumentów CLI. Na przykład, --passWithNoTests i --pass-with-no-tests będą działać (wyjątkami są --no-color i --inspect-brk).

Vitest obsługuje również różne sposoby określania wartości: --reporter dot i --reporter=dot są oba prawidłowe.

Jeśli opcja obsługuje tablicę wartości, należy przekazać opcję wielokrotnie:

vitest --reporter=dot --reporter=default

Opcje logiczne mogą być negowane za pomocą prefiksu no-. Określenie wartości jako false również jest możliwe:

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

root ​

  • CLI: -r, --root <ścieżka>
  • Config: root

Główna ścieżka projektu.

config ​

  • CLI: -c, --config <ścieżka>

Ścieżka do pliku konfiguracyjnego.

update ​

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

Zaktualizuj migawki.

watch ​

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

Włącz tryb obserwacji.

testNamePattern ​

Uruchom testy, których pełne nazwy pasują do podanego wyrażenia regularnego.

dir ​

  • CLI: --dir <ścieżka>
  • Config: dir

Katalog bazowy do skanowania w poszukiwaniu plików testowych.

ui ​

  • CLI: --ui
  • Config: ui

Włącz interfejs użytkownika (UI).

open ​

  • CLI: --open
  • Config: open

Automatycznie otwórz interfejs użytkownika (domyślnie: !process.env.CI).

api.port ​

  • CLI: --api.port [port]

Określ port serwera. Jeśli port jest już używany, Vite automatycznie spróbuje następnego dostępnego portu, więc może to nie być rzeczywisty port, na którym serwer ostatecznie nasłuchuje. Jeśli ustawiono na true, zostanie ustawiony na 51204.

api.host ​

  • CLI: --api.host [host]

Określ adresy IP, na których serwer powinien nasłuchiwać. Ustaw na 0.0.0.0 lub true, aby nasłuchiwać na wszystkich adresach, w tym adresach LAN i publicznych.

api.strictPort ​

  • CLI: --api.strictPort

Jeśli ustawiono na true, zakończ działanie, jeśli port jest już używany, zamiast automatycznie próbować następnego dostępnego portu.

silent ​

Wycisz wyjście konsoli z testów.

hideSkippedTests ​

  • CLI: --hideSkippedTests

Ukryj dzienniki dla pominiętych testów.

reporters ​

Określ reporterów.

outputFile ​

  • CLI: --outputFile <nazwa_pliku/-s>
  • Config: outputFile

Zapisz wyniki testów do pliku, gdy określony jest również obsługiwany reporter; użyj notacji kropkowej dla indywidualnych wyjść wielu reporterów (przykład: --outputFile.tap=./tap.txt).

coverage.all ​

Czy uwzględnić wszystkie pliki, w tym te nieprzetestowane, w raporcie pokrycia.

coverage.provider ​

Wybierz narzędzie do zbierania pokrycia kodu. Dostępne wartości to: "v8", "istanbul" i "custom".

coverage.enabled ​

Włącza zbieranie pokrycia. Może być nadpisane za pomocą opcji CLI --coverage (domyślnie: false).

coverage.include ​

Pliki uwzględnione w pokryciu, określone jako wzorce glob. Może być określone więcej niż raz przy użyciu wielu wzorców (domyślnie: **).

coverage.exclude ​

Pliki do wykluczenia z pokrycia. Można je określić wielokrotnie dla różnych rozszerzeń (domyślnie: Odwiedź coverage.exclude).

coverage.extension ​

Rozszerzenie do uwzględnienia w pokryciu. Może być określone więcej niż raz dla wielu rozszerzeń (domyślnie: [".js", ".cjs", ".mjs", ".ts", ".mts", ".tsx", ".jsx", ".vue", ".svelte"]).

coverage.clean ​

Wyczyść wyniki pokrycia przed uruchomieniem testów (domyślnie: true).

coverage.cleanOnRerun ​

Wyczyść raport pokrycia przy ponownym uruchomieniu w trybie obserwacji (domyślnie: true).

coverage.reportsDirectory ​

Katalog, do którego ma zostać zapisany raport pokrycia (domyślnie: ./coverage).

coverage.reporter ​

Reportery pokrycia do użycia. Odwiedź coverage.reporter po więcej informacji (domyślnie: ["text", "html", "clover", "json"]).

coverage.reportOnFailure ​

Generuj raport pokrycia nawet, gdy testy zakończą się niepowodzeniem (domyślnie: false).

coverage.allowExternal ​

Zbieraj pokrycie plików spoza katalogu głównego projektu (domyślnie: false).

coverage.skipFull ​

Nie pokazuj plików ze 100-procentowym pokryciem instrukcji, gałęzi i funkcji (domyślnie: false).

coverage.thresholds.100 ​

Skrót do ustawienia wszystkich progów pokrycia na 100% (domyślnie: false).

coverage.thresholds.perFile ​

Sprawdź progi pokrycia dla każdego pliku. Zobacz --coverage.thresholds.lines, --coverage.thresholds.functions, --coverage.thresholds.branches i --coverage.thresholds.statements dla rzeczywistych progów (domyślnie: false).

coverage.thresholds.autoUpdate ​

Zaktualizuj wartości progów: "lines", "functions", "branches" i "statements" w pliku konfiguracyjnym, gdy bieżące pokrycie jest powyżej skonfigurowanych progów (domyślnie: false).

coverage.thresholds.lines ​

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

Próg dla linii. Odwiedź istanbuljs po więcej informacji. Ta opcja nie jest dostępna dla niestandardowych dostawców.

coverage.thresholds.functions ​

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

Próg dla funkcji. Odwiedź istanbuljs po więcej informacji. Ta opcja nie jest dostępna dla niestandardowych dostawców.

coverage.thresholds.branches ​

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

Próg dla gałęzi. Odwiedź istanbuljs po więcej informacji. Ta opcja nie jest dostępna dla niestandardowych dostawców.

coverage.thresholds.statements ​

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

Próg dla instrukcji. Odwiedź istanbuljs po więcej informacji. Ta opcja nie jest dostępna dla niestandardowych dostawców.

coverage.ignoreClassMethods ​

Tablica nazw metod klas do zignorowania w pokryciu. Odwiedź istanbuljs po więcej informacji. Ta opcja jest dostępna tylko dla dostawców istanbul (domyślnie: []).

coverage.processingConcurrency ​

Limit współbieżności używany podczas przetwarzania wyników pokrycia (domyślnie: mniejsza z wartości 20 i liczby procesorów).

coverage.customProviderModule ​

Określa nazwę modułu lub ścieżkę do niestandardowego modułu dostawcy pokrycia. Odwiedź Custom Coverage Provider po więcej informacji. Ta opcja jest dostępna tylko dla niestandardowych dostawców.

coverage.watermarks.statements ​

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

Górne i dolne znaki wodne dla instrukcji w formacie <wysoki>,<niski>.

coverage.watermarks.lines ​

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

Górne i dolne znaki wodne dla linii w formacie <wysoki>,<niski>.

coverage.watermarks.branches ​

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

Górne i dolne znaki wodne dla gałęzi w formacie <wysoki>,<niski>.

coverage.watermarks.functions ​

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

Górne i dolne znaki wodne dla funkcji w formacie <wysoki>,<niski>.

mode ​

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

Nadpisz tryb Vite (domyślnie: test lub benchmark).

workspace ​

  • CLI: --workspace <ścieżka>
  • Config: workspace

Ścieżka do pliku konfiguracyjnego obszaru roboczego.

isolate ​

Uruchom każdy plik testowy w izolacji. Aby wyłączyć izolację, użyj --no-isolate (domyślnie: true).

globals ​

Wstrzyknij API globalnie.

dom ​

  • CLI: --dom

Symuluj API przeglądarki za pomocą happy-dom.

browser.enabled ​

Uruchom testy w przeglądarce (domyślnie: false).

browser.name ​

Uruchom wszystkie testy w określonej przeglądarce. Niektóre przeglądarki są dostępne tylko dla określonych dostawców (patrz --browser.provider). Odwiedź browser.name po więcej informacji.

browser.headless ​

Uruchom przeglądarkę w trybie headless (tj. bez otwierania interfejsu graficznego użytkownika (GUI)). Jeśli uruchamiasz Vitest w CI, zostanie to domyślnie włączone (domyślnie: process.env.CI).

browser.api.port ​

Określ port serwera. Jeśli port jest już używany, Vite automatycznie spróbuje następnego dostępnego portu, więc może to nie być rzeczywisty port, na którym serwer ostatecznie nasłuchuje. Jeśli ustawiono na true, zostanie ustawiony na 63315.

browser.api.host ​

Określ adresy IP, na których serwer powinien nasłuchiwać. Ustaw na 0.0.0.0 lub true, aby nasłuchiwać na wszystkich adresach, w tym adresach LAN i publicznych.

browser.api.strictPort ​

Jeśli ustawiono na true, zakończ działanie, jeśli port jest już używany, zamiast automatycznie próbować następnego dostępnego portu.

browser.provider ​

Dostawca używany do uruchamiania testów przeglądarkowych. Niektóre przeglądarki są dostępne tylko dla określonych dostawców. Może to być "webdriverio", "playwright", "preview" lub ścieżka do niestandardowego dostawcy. Odwiedź browser.provider po więcej informacji (domyślnie: "preview").

browser.providerOptions ​

Opcje, które są przekazywane do dostawcy przeglądarki. Odwiedź browser.providerOptions po więcej informacji.

browser.isolate ​

Uruchom każdy plik testowy przeglądarki w izolacji. Aby wyłączyć izolację, użyj --browser.isolate=false (domyślnie: true).

browser.ui ​

Pokaż interfejs użytkownika Vitest podczas uruchamiania testów (domyślnie: !process.env.CI).

browser.fileParallelism ​

Określa, czy pliki testowe przeglądarki powinny być uruchamiane równolegle. Użyj --browser.fileParallelism=false, aby wyłączyć (domyślnie: true).

pool ​

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

Określ pulę, jeśli nie uruchamiasz w przeglądarce (domyślnie: threads).

poolOptions.threads.isolate ​

Izoluj testy w puli wątków (domyślnie: true).

poolOptions.threads.singleThread ​

Uruchom testy w pojedynczym wątku (domyślnie: false).

poolOptions.threads.maxThreads ​

Maksymalna liczba lub procent wątków do uruchamiania testów.

poolOptions.threads.minThreads ​

Minimalna liczba lub procent wątków do uruchamiania testów.

poolOptions.threads.useAtomics ​

Użyj Atomics do synchronizacji wątków. Może poprawić wydajność, ale w starszych wersjach Node może powodować błędy segmentacji (domyślnie: false).

poolOptions.vmThreads.isolate ​

Izoluj testy w puli wątków VM (domyślnie: true).

poolOptions.vmThreads.singleThread ​

Uruchom testy w pojedynczym wątku (domyślnie: false).

poolOptions.vmThreads.maxThreads ​

Maksymalna liczba lub procent wątków do uruchamiania testów.

poolOptions.vmThreads.minThreads ​

Minimalna liczba lub procent wątków do uruchamiania testów.

poolOptions.vmThreads.useAtomics ​

Użyj Atomics do synchronizacji wątków. Może to poprawić wydajność w niektórych przypadkach, ale może spowodować błąd segmentacji w starszych wersjach Node (domyślnie: false).

poolOptions.vmThreads.memoryLimit ​

Limit pamięci dla puli wątków VM. Jeśli widzisz wycieki pamięci, spróbuj dostosować tę wartość.

poolOptions.forks.isolate ​

Izoluj testy w puli forków (domyślnie: true).

poolOptions.forks.singleFork ​

Uruchom testy w pojedynczym procesie potomnym (domyślnie: false).

poolOptions.forks.maxForks ​

Maksymalna liczba lub procent procesów do uruchamiania testów.

poolOptions.forks.minForks ​

Minimalna liczba lub procent procesów do uruchamiania testów.

poolOptions.vmForks.isolate ​

Izoluj testy w puli forków VM (domyślnie: true).

poolOptions.vmForks.singleFork ​

Uruchom testy w pojedynczym procesie potomnym (domyślnie: false).

poolOptions.vmForks.maxForks ​

Maksymalna liczba lub procent procesów do uruchamiania testów.

poolOptions.vmForks.minForks ​

Minimalna liczba lub procent procesów do uruchamiania testów.

poolOptions.vmForks.memoryLimit ​

Limit pamięci dla puli forków VM. Jeśli widzisz wycieki pamięci, spróbuj dostosować tę wartość.

fileParallelism ​

Określa, czy wszystkie pliki testowe powinny być uruchamiane równolegle. Użyj --no-file-parallelism, aby wyłączyć (domyślnie: true).

maxWorkers ​

Maksymalna liczba lub procent workerów do uruchamiania testów.

minWorkers ​

Minimalna liczba lub procent workerów do uruchamiania testów.

environment ​

Określ środowisko uruchomieniowe, jeśli nie uruchamiasz w przeglądarce (domyślnie: node).

passWithNoTests ​

Zakończ pomyślnie, gdy nie znaleziono testów.

logHeapUsage ​

Pokaż rozmiar sterty dla każdego testu podczas uruchamiania w Node.

allowOnly ​

Zezwól na testy i zestawy, które są oznaczone jako "only" (domyślnie: !process.env.CI).

dangerouslyIgnoreUnhandledErrors ​

Ignoruj wszelkie nieobsłużone błędy, które wystąpią.

sequence.shuffle.files ​

Uruchom pliki w losowej kolejności. Długo trwające testy nie rozpoczną się wcześniej, jeśli włączysz tę opcję (domyślnie: false).

sequence.shuffle.tests ​

Uruchom testy w losowej kolejności (domyślnie: false).

sequence.concurrent ​

Spraw, aby testy uruchamiały się równolegle (domyślnie: false).

sequence.seed ​

Ustaw ziarno randomizacji. Ta opcja nie będzie miała wpływu, jeśli --sequence.shuffle ma wartość fałszywą. Odwiedź stronę "Random Seed" po więcej informacji.

sequence.hooks ​

Zmienia kolejność wykonywania hooków. Akceptowane wartości to: "stack", "list" i "parallel". Odwiedź sequence.hooks po więcej informacji (domyślnie: "parallel").

sequence.setupFiles ​

Zmienia kolejność wykonywania plików setup. Akceptowane wartości to: "list" i "parallel". Jeśli ustawiono na "list", pliki setup zostaną uruchomione w kolejności, w jakiej są zdefiniowane. Jeśli ustawiono na "parallel", pliki setup zostaną uruchomione równolegle (domyślnie: "parallel").

inspect ​

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

Włącz inspektora Node.js (domyślnie: 127.0.0.1:9229).

inspectBrk ​

Włącz inspektora Node.js i zatrzymaj się przed rozpoczęciem testu.

testTimeout ​

Domyślny limit czasu testu w milisekundach (domyślnie: 5000).

hookTimeout ​

Domyślny limit czasu hooka w milisekundach (domyślnie: 10000).

bail ​

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

Zatrzymaj wykonywanie testów, gdy podana liczba testów zakończy się niepowodzeniem (domyślnie: 0).

retry ​

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

Ponów test określoną liczbę razy, jeśli się nie powiedzie (domyślnie: 0).

diff ​

  • CLI: --diff <ścieżka>
  • Config: diff

Ścieżka do konfiguracji diff, która zostanie użyta do generowania interfejsu diff.

exclude ​

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

Dodatkowe wzorce glob plików do wykluczenia z testów.

expandSnapshotDiff ​

Pokaż pełny diff, gdy migawka się nie powiedzie.

disableConsoleIntercept ​

Wyłącz automatyczne przechwytywanie logowania konsoli (domyślnie: false).

typecheck.enabled ​

Włącz sprawdzanie typów wraz z testami (domyślnie: false).

typecheck.only ​

Uruchom tylko testy sprawdzania typów. To automatycznie włącza sprawdzanie typów (domyślnie: false).

typecheck.checker ​

Określ narzędzie do sprawdzania typów. Dostępne wartości to: "tsc" i "vue-tsc" oraz ścieżka do pliku wykonywalnego (domyślnie: "tsc").

typecheck.allowJs ​

Zezwól na sprawdzanie typów plików JavaScript. Domyślnie przyjmuje wartość z tsconfig.json.

typecheck.ignoreSourceErrors ​

Ignoruj błędy typów z plików źródłowych.

typecheck.tsconfig ​

Ścieżka do niestandardowego pliku tsconfig.

project ​

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

Nazwa projektu do uruchomienia, jeśli używasz funkcji obszaru roboczego Vitest. Opcję tę można powtórzyć dla wielu projektów: --project=1 --project=2. Możesz również filtrować projekty przy użyciu symboli wieloznacznych, takich jak --project=packages*.

slowTestThreshold ​

Próg w milisekundach, po którym test jest uważany za wolny (domyślnie: 300).

teardownTimeout ​

Domyślny limit czasu funkcji teardown w milisekundach (domyślnie: 10000).

maxConcurrency ​

Maksymalna liczba równoczesnych testów w zestawie (domyślnie: 5).

expect.requireAssertions ​

Wymagaj, aby wszystkie testy miały co najmniej jedno twierdzenie.

expect.poll.interval ​

Interwał odpytywania w milisekundach dla twierdzeń expect.poll() (domyślnie: 50).

expect.poll.timeout ​

Limit czasu odpytywania w milisekundach dla twierdzeń expect.poll() (domyślnie: 1000).

printConsoleTrace ​

Zawsze drukuj ślady stosu konsoli.

run ​

  • CLI: --run

Wyłącz tryb obserwacji.

color ​

  • CLI: --no-color

Usuwa kolory z wyjścia konsoli.

clearScreen ​

  • CLI: --clearScreen

Wyczyść ekran terminala podczas ponownego uruchamiania testów w trybie obserwacji (domyślnie: true).

standalone ​

  • CLI: --standalone

Uruchom Vitest bez uruchamiania testów. Filtry plików zostaną zignorowane, testy będą uruchamiane tylko przy zmianie (domyślnie: false).

changed ​

  • Typ: boolean | string
  • Domyślnie: false

Uruchamia testy tylko dla zmienionych plików. Jeśli nie podano wartości, uruchomi testy dla niezacommitowanych zmian (w tym zmian przygotowanych do commita i nieprzygotowanych).

Aby uruchomić testy dla zmian wprowadzonych w ostatnim commicie, możesz użyć --changed HEAD~1. Możesz również przekazać hash commita (np. --changed 09a9920) lub nazwę gałęzi (np. --changed origin/develop).

W przypadku użycia z pokryciem kodu, raport będzie zawierał tylko pliki, które były powiązane ze zmianami.

W połączeniu z opcją konfiguracyjną forceRerunTriggers uruchomi cały zestaw testów, jeśli zmieni się co najmniej jeden z plików wymienionych na liście forceRerunTriggers. Domyślnie, zmiany w pliku konfiguracyjnym Vitest i package.json zawsze spowodują ponowne uruchomienie całego zestawu testów.

shard ​

  • Typ: string
  • Domyślnie: disabled

Dzieli zestaw testów do wykonania w formacie <index>/<count>, gdzie:

  • count to dodatnia liczba całkowita, oznaczająca liczbę podzielonych części.
  • index to dodatnia liczba całkowita, oznaczająca indeks podzielonej części.

To polecenie podzieli cały zestaw testów na count równych części i uruchomi tylko te, które znajdą się w części o indeksie index. Na przykład, aby podzielić zestaw testów na trzy części, użyj tego:

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

WARNING

Nie możesz używać tej opcji z włączonym --watch (domyślnie włączonym w trybie deweloperskim).

TIP

Jeśli --reporter=blob jest używany bez pliku wyjściowego, domyślna ścieżka będzie zawierać bieżącą konfigurację sharda, aby uniknąć kolizji z innymi procesami Vitest.

merge-reports ​

  • Typ: boolean | string

Łączy każdy raport blob znajdujący się w określonym folderze (domyślnie .vitest-reports). Możesz użyć dowolnych modułów raportujących z tym poleceniem (z wyjątkiem blob):

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

Opublikowano na licencji MIT.

Copyright (c) 2024 Mithril Contributors

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

Opublikowano na licencji MIT.

Copyright (c) 2024 Mithril Contributors