Komut Satırı Arayüzü

Komutlar

vitest

Vitest'i geçerli dizinde başlatır. Geliştirme ortamında izleme moduna, CI ortamında ise otomatik olarak çalıştırma moduna geçer.

Çalıştırılacak test dosyalarının filtresi olarak ek bir argüman geçirebilirsiniz. Örneğin:

vitest foobar

Yalnızca yollarında foobar bulunan test dosyaları çalıştırılır. Bu filtre yalnızca içerme durumunu kontrol eder ve regexp veya glob desenlerini desteklemez (terminaliniz bunu Vitest'ten önce işlemediği sürece).

vitest run

İzleme modu olmadan tek bir çalıştırma yapar.

vitest watch

Tüm test paketlerini çalıştırır, ancak değişiklikleri izler ve değişiklik olduğunda testleri yeniden çalıştırır. Argümansız vitest komutuyla aynıdır. CI ortamında vitest run komutuna dönüşür.

vitest dev

vitest watch için takma addır.

vitest related

Yalnızca belirtilen kaynak dosyalarından etkilenen testleri çalıştırır. Statik içe aktarmalarla (örneğin, import('./index.ts') veya import index from './index.ts') çalışır, ancak dinamik içe aktarmalarla (örneğin, import(filepath)) çalışmaz. Tüm dosyalar kök dizine göre belirtilmelidir.

lint-staged veya CI kurulumunuzla birlikte kullanmak için uygundur.

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

TIP

Vitest'in varsayılan olarak izleme modu etkin şekilde çalıştığını unutmayın. lint-staged gibi araçlar kullanıyorsanız, komutun normal şekilde çıkabilmesi için --run seçeneğini de belirtmelisiniz.

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

vitest bench

Yalnızca performans sonuçlarını karşılaştıran benchmark testlerini çalıştırır.

Seçenekler

Seçenekler
-v, --version	Sürüm numarasını gösterir.
-r, --root <path>	Proje kök dizinini tanımlar.
-c, --config <path>	Yapılandırma dosyasının yolunu belirtir.
-u, --update	Snapshot'ları günceller.
-w, --watch	Akıllı ve anında izleme modunu etkinleştirir.
-t, --testNamePattern <pattern>	Tam adları belirtilen desenle eşleşen testleri çalıştırır.
--dir <path>	Test dosyalarının aranacağı temel dizini belirtir.
--ui	UI'yı etkinleştirir.
--open	Etkinse UI'yı otomatik olarak açar (varsayılan: true).
--api [api]	API'yi sunar, mevcut seçenekler: --api.port <port>, --api.host [host] ve --api.strictPort.
--threads	İş parçacıklarını etkinleştirir (varsayılan: true).
--single-thread	Testleri tek bir iş parçacığı içinde çalıştırır, --threads gerektirir (varsayılan: false).
--experimental-vm-threads	Testleri VM yalıtımı kullanarak bir çalışan havuzunda çalıştırır (varsayılan: false).
--experimental-vm-worker-memory-limit	Bir çalışan için izin verilen maksimum belleği ayarlar. Bu limite ulaşıldığında yeni bir çalışan oluşturulur.
--silent	Testlerden gelen konsol çıktılarını sessize alır.
--isolate	Her test dosyası için ortamı yalıtır (varsayılan: true).
--reporter <name>	Raporlayıcıyı seçer: default, verbose, dot, junit, json veya özel bir raporlayıcının yolu.
--outputFile <filename/-s>	--reporter=json veya --reporter=junit seçeneği de belirtildiğinde test sonuçlarını bir dosyaya yazar. cac'ın nokta gösterimi aracılığıyla birden çok raporlayıcı için ayrı çıktılar belirtebilirsiniz.
--coverage	Kapsam raporlamasını etkinleştirir.
--run	İzleme yapmadan çalıştırır.
--mode	Vite modunu geçersiz kılar (varsayılan: test).
--mode <name>	Vite modunu geçersiz kılar (varsayılan: test).
--globals	API'leri global olarak enjekte eder.
--dom	Happy DOM kullanarak tarayıcı API'lerini taklit eder.
--browser [options]	Tarayıcıda testleri çalıştırır (varsayılan: false).
--environment <env>	Çalıştırma ortamını belirtir (varsayılan: node).
--passWithNoTests	Test bulunamadığında başarılı olarak kabul eder.
--logHeapUsage	Her test için yığın kullanımını gösterir.
--allowOnly	only olarak işaretlenmiş testlere ve test paketlerine izin verir (CI'da varsayılan olarak false, aksi takdirde true).
--dangerouslyIgnoreUnhandledErrors	Meydana gelen işlenmemiş hataları yok sayar.
--changed [since]	Değişen dosyalardan etkilenen testleri çalıştırır (varsayılan: false). Daha fazla bilgi için belgelere bakın.
--shard <shard>	Testleri belirtilen bir parçada yürütür.
--sequence	Testlerin hangi sırada çalıştırılacağını tanımlar. Seçenekleri belirtmek için [cac'ın nokta gösterimini] kullanın (örneğin, testleri rastgele bir sırayla çalıştırmak için --sequence.shuffle veya belirli bir sırada çalıştırmak için --sequence.shuffle --sequence.seed SEED_ID kullanın).
--no-color	Konsol çıktısındaki renkleri kaldırır.
--inspect	Node.js denetleyicisini etkinleştirir.
--inspect-brk	Kesme noktasıyla Node.js denetleyicisini etkinleştirir.
--bail <number>	Belirtilen sayıda test başarısız olduğunda test yürütmeyi durdurur.
--retry <times>	Başarısız olursa testi belirtilen sayıda kez yeniden dener.
-h, --help	Mevcut CLI seçeneklerini gösterir.

TIP

Vitest, CLI argümanları için hem camel case hem de kebab case'i destekler. Örneğin, --passWithNoTests ve --pass-with-no-tests her ikisi de çalışır (--no-color ve --inspect-brk istisnalardır).

Vitest ayrıca değeri belirtmenin farklı yollarını da destekler: --reporter dot ve --reporter=dot her ikisi de geçerlidir.

Seçenek bir değer dizisini destekliyorsa, seçeneği birden çok kez geçirmeniz gerekir:

vitest --reporter=dot --reporter=default

Boole seçenekleri no- önekiyle olumsuzlanabilir. Değeri false olarak belirtmek de işe yarar:

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

changed

• Tür: boolean | string

• Varsayılan: false

  Yalnızca değişen dosyalar için testleri çalıştırır. Değer sağlanmazsa, commit edilmemiş değişikliklere (staged ve unstaged dahil) karşı testler çalıştırılır.

  Son commit'te yapılan değişikliklere karşı testleri çalıştırmak için --changed HEAD~1 kullanabilirsiniz. Ayrıca commit hash'i veya branch adı da belirtebilirsiniz.

  forceRerunTriggers yapılandırma seçeneğiyle eşleştirilirse, bir eşleşme bulunursa tüm test paketi çalıştırılır.

shard

• Tür: string

• Varsayılan: devre dışı

  <index>/<count> biçiminde, yürütülecek test paketinin parçasını belirtir. Burada:

  • count pozitif bir tamsayıdır, bölünmüş parça sayısını temsil eder.
  • index pozitif bir tamsayıdır, bölünmüş parçanın indeksini temsil eder.

  Bu komut, tüm testleri count adet eşit parçaya böler ve yalnızca index numaralı parçadaki testleri çalıştırır. Örneğin, test paketinizi üç eşit parçaya bölmek için şunu kullanın:

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

WARNING

Bu seçenek, --watch etkin durumdayken kullanılamaz (geliştirme ortamında varsayılan olarak etkindir).