Vitest 2

日本語

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

日本語

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

外観

コマンドラインインターフェース ​

コマンド ​

vitest ​

カレントディレクトリでVitestを起動します。開発環境ではウォッチモードが有効になり、CI環境では自動的に実行モードに切り替わります。

実行するテストファイルを絞り込むために、追加の引数を渡すことができます。例：

bash
vitest foobar

このコマンドは、パスにfoobarが含まれるテストファイルのみを実行します。このフィルターは部分一致チェックのみを行い、正規表現やグロブパターンはサポートしていません（ただし、Vitestがフィルターを受け取る前にターミナルが処理する場合を除きます）。

vitest run ​

ウォッチモードなしでテストを一度だけ実行します。

vitest watch ​

すべてのテストスイートを実行し、ファイルの変更を監視します。変更が検出された場合、テストを再実行します。引数なしでvitestを実行するのと同じ動作です。CI環境ではvitest runにフォールバックします。

vitest dev ​

vitest watchのエイリアスです。

指定されたソースファイルに関連するテストのみを実行します。静的インポート（例：import('./index.js')やimport index from './index.js'）には対応していますが、動的インポート（例：import(filepath)）には対応していません。すべてのファイルパスは、プロジェクトのルートディレクトリからの相対パスで指定する必要があります。

lint-stagedやCIセットアップと組み合わせて使用すると便利です。

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

TIP

Vitestはデフォルトでウォッチモードが有効になっていることに注意してください。lint-stagedのようなツールを使用している場合は、コマンドが正常に終了するように--runオプションも渡すようにしてください。

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

vitest bench ​

パフォーマンス比較を行うベンチマークテストのみを実行します。

vitest init ​

vitest init <name>はプロジェクト設定の初期化に利用できます。現時点では、browserの値のみをサポートしています。

bash
vitest init browser

vitest list ​

vitest listコマンドは、該当するすべてのテストの一覧を表示する際に、vitestのすべてのオプションを受け付けます。このコマンドはreportersオプションを無視します。デフォルトでは、ファイルフィルターと名前パターンに一致したすべてのテストの名前を出力します。

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

--jsonフラグを渡すことで、テストをJSON形式で出力したり、別のファイルに保存したりできます。

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

--jsonフラグに値が指定されない場合、JSONは標準出力に出力されます。

--filesOnlyフラグを渡すことで、テストファイルの一覧のみを表示できます。

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

オプション ​

TIP

VitestはCLI引数にキャメルケースとケバブケースの両方をサポートしています。例えば、--passWithNoTestsと--pass-with-no-testsはどちらも有効です（--no-colorと--inspect-brkは例外です）。

Vitestは値の指定方法も複数サポートしており、--reporter dotと--reporter=dotはどちらも有効です。

オプションが値の配列をサポートしている場合、オプションを複数回渡してください。

vitest --reporter=dot --reporter=default

ブール値オプションはno-プレフィックスで否定できます。値をfalseとして指定することも可能です。

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

root ​

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

プロジェクトのルートディレクトリを指定します。

config ​

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

設定ファイルのパスを指定します。

update ​

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

スナップショットを更新します。

watch ​

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

ウォッチモードを有効にします。

testNamePattern ​

指定された正規表現パターンに完全に一致する名前のテストのみを実行します。

dir ​

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

テストファイルをスキャンする際のベースディレクトリを指定します。

ui ​

  • CLI: --ui
  • Config: ui

UIを有効にします。

open ​

  • CLI: --open
  • Config: open

UIを自動的に開きます (デフォルト: !process.env.CI)。

api.port ​

  • CLI: --api.port [port]

サーバーポートを指定します。ポートが既に使用されている場合、Vitestは自動的に次に利用可能なポートを試行するため、実際にサーバーがリッスンするポートと異なる場合があります。trueに設定すると、51204が使用されます。

api.host ​

  • CLI: --api.host [host]

サーバーがリッスンするIPアドレスを指定します。LANアドレスとパブリックアドレスを含むすべてのIPアドレスでリッスンするには、0.0.0.0またはtrueに設定します。

api.strictPort ​

  • CLI: --api.strictPort

ポートが既に使用されている場合に、自動的に次に利用可能なポートを試行せず、終了するにはtrueに設定します。

silent ​

テストからのコンソール出力を抑制します。

hideSkippedTests ​

  • CLI: --hideSkippedTests

スキップされたテストのログを非表示にします。

reporters ​

使用するレポーターを指定します。

outputFile ​

サポートされているレポーターが指定されている場合、テスト結果をファイルに書き込みます。複数のレポーターの個別の出力には、cacのドット記法を使用します（例：--outputFile.tap=./tap.txt）。

coverage.all ​

テストされていないファイルを含むすべてのファイルをレポートに含めるかを指定します。

coverage.provider ​

カバレッジ収集に使用するツールを選択します。利用可能な値は "v8"、"istanbul"、"custom" です。

coverage.enabled ​

カバレッジ収集を有効にします。この設定は--coverage CLIオプションで上書きできます (デフォルト: false)。

coverage.include ​

カバレッジに含めるファイルをグロブパターンとして指定します。複数のパターンを使用する場合は、複数回指定できます (デフォルト: **)。

coverage.exclude ​

カバレッジから除外するファイルを指定します。複数のパターンを使用する場合は、複数回指定できます (デフォルト: coverage.excludeを参照)。

coverage.extension ​

カバレッジに含めるファイルの拡張子を指定します。複数の拡張子を使用する場合は、複数回指定できます (デフォルト: [".js", ".cjs", ".mjs", ".ts", ".mts", ".tsx", ".jsx", ".vue", ".svelte"])。

coverage.clean ​

テスト実行前にカバレッジ結果をクリーンアップします (デフォルト: true)。

coverage.cleanOnRerun ​

ウォッチモードでの再実行時にカバレッジレポートをクリーンアップします (デフォルト: true)。

coverage.reportsDirectory ​

カバレッジレポートを書き込むディレクトリを指定します (デフォルト: ./coverage)。

coverage.reporter ​

使用するカバレッジレポーターを指定します。詳細についてはcoverage.reporterを参照してください (デフォルト: ["text", "html", "clover", "json"])。

coverage.reportOnFailure ​

テストが失敗した場合でもカバレッジレポートを生成します (デフォルト: false)。

coverage.allowExternal ​

プロジェクトルート外のファイルのカバレッジを収集します (デフォルト: false)。

coverage.skipFull ​

ステートメント、ブランチ、関数カバレッジが100%のファイルは表示しません (デフォルト: false)。

coverage.thresholds.100 ​

すべてのカバレッジしきい値を100%に設定するショートカットです (デフォルト: false)。

coverage.thresholds.perFile ​

ファイルごとのしきい値を確認します。実際のしきい値については、--coverage.thresholds.lines、--coverage.thresholds.functions、--coverage.thresholds.branches、--coverage.thresholds.statementsを参照してください (デフォルト: false)。

coverage.thresholds.autoUpdate ​

現在のカバレッジが設定されたしきい値を超えている場合、設定ファイル内のしきい値（"lines"、"functions"、"branches"、"statements"）を更新します (デフォルト: false)。

coverage.thresholds.lines ​

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

行のカバレッジしきい値を指定します。詳細についてはistanbuljsを参照してください。このオプションはカスタムプロバイダーでは利用できません。

coverage.thresholds.functions ​

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

関数のカバレッジしきい値を指定します。詳細についてはistanbuljsを参照してください。このオプションはカスタムプロバイダーでは利用できません。

coverage.thresholds.branches ​

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

ブランチのカバレッジしきい値を指定します。詳細についてはistanbuljsを参照してください。このオプションはカスタムプロバイダーでは利用できません。

coverage.thresholds.statements ​

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

ステートメントのカバレッジしきい値を指定します。詳細についてはistanbuljsを参照してください。このオプションはカスタムプロバイダーでは利用できません。

coverage.ignoreClassMethods ​

カバレッジで無視するクラスメソッド名の配列を指定します。詳細についてはistanbuljsを参照してください。このオプションはIstanbulプロバイダーでのみ利用可能です (デフォルト: [])。

coverage.processingConcurrency ​

カバレッジ結果を処理する際に使用される並行処理の制限です (デフォルトは20とCPU数の最小値)。

coverage.customProviderModule ​

カスタムカバレッジプロバイダーモジュールのモジュール名またはパスを指定します。詳細についてはCustom Coverage Providerを参照してください。このオプションはカスタムプロバイダーでのみ利用可能です。

coverage.watermarks.statements ​

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

ステートメントのハイウォーターマークとローウォーターマークを<high>,<low>の形式で指定します。

coverage.watermarks.lines ​

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

行のハイウォーターマークとローウォーターマークを<high>,<low>の形式で指定します。

coverage.watermarks.branches ​

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

ブランチのハイウォーターマークとローウォーターマークを<high>,<low>の形式で指定します。

coverage.watermarks.functions ​

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

関数のハイウォーターマークとローウォーターマークを<high>,<low>の形式で指定します。

mode ​

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

Viteモードを上書きします (デフォルト: test または benchmark)。

workspace ​

ワークスペース設定ファイルへのパスを指定します。

isolate ​

すべてのテストファイルを分離して実行します。分離を無効にするには、--no-isolateを使用します (デフォルト: true)。

globals ​

APIをグローバルに注入します。

dom ​

  • CLI: --dom

Happy-DOMでブラウザAPIをモックします。

browser.enabled ​

ブラウザでテストを実行します。これは--browserと同等です (デフォルト: false)。

browser.name ​

すべてのテストを特定のブラウザで実行します。一部のブラウザは特定のプロバイダーでのみ利用可能です（--browser.providerを参照）。詳細についてはbrowser.nameを参照してください。

browser.headless ​

ブラウザをヘッドレスモード（GUI（グラフィカルユーザーインターフェース）を開かずに）で実行します。VitestをCIで実行している場合、デフォルトで有効になります (デフォルト: process.env.CI)。

browser.api.port ​

サーバーポートを指定します。ポートが既に使用されている場合、Vitestは自動的に次に利用可能なポートを試行するため、実際にサーバーがリッスンするポートと異なる場合があります。trueに設定すると、63315が使用されます。

browser.api.host ​

サーバーがリッスンするIPアドレスを指定します。LANアドレスとパブリックアドレスを含むすべてのIPアドレスでリッスンするには、0.0.0.0またはtrueに設定します。

browser.api.strictPort ​

ポートが既に使用されている場合に、自動的に次に利用可能なポートを試行せず、終了するにはtrueに設定します。

browser.provider ​

ブラウザテストを実行するために使用されるプロバイダー。一部のブラウザは特定のプロバイダーでのみ利用可能です。"webdriverio"、"playwright"、"preview"、またはカスタムプロバイダーへのパスを指定できます。詳細についてはbrowser.providerを参照してください (デフォルト: "preview")。

browser.providerOptions ​

ブラウザプロバイダーに渡されるオプション。詳細についてはbrowser.providerOptionsを参照してください。

browser.isolate ​

すべてのブラウザテストファイルを分離して実行します。分離を無効にするには、--browser.isolate=falseを使用します (デフォルト: true)。

browser.ui ​

テスト実行時にVitest UIを表示します (デフォルト: !process.env.CI)。

browser.fileParallelism ​

ブラウザテストファイルを並行して実行するかどうかを指定します。無効にするには--browser.fileParallelism=falseを使用します (デフォルト: true)。

pool ​

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

ブラウザで実行しない場合、テスト実行に使用するプールを指定します (デフォルト: threads)。

poolOptions.threads.isolate ​

スレッドプールでテストを分離します (デフォルト: true)。

poolOptions.threads.singleThread ​

単一スレッド内でテストを実行します (デフォルト: false)。

poolOptions.threads.maxThreads ​

テストを実行するスレッドの最大数または割合を指定します。

poolOptions.threads.minThreads ​

テストを実行するスレッドの最小数または割合を指定します。

poolOptions.threads.useAtomics ​

スレッドを同期するためにAtomicsを使用します。これにより、パフォーマンスが向上する場合がありますが、古いNodeバージョンではセグメンテーション違反を引き起こす可能性があります (デフォルト: false)。

poolOptions.vmThreads.isolate ​

VMスレッドプールでテストを分離します (デフォルト: true)。

poolOptions.vmThreads.singleThread ​

単一VMスレッド内でテストを実行します (デフォルト: false)。

poolOptions.vmThreads.maxThreads ​

テストを実行するVMスレッドの最大数または割合を指定します。

poolOptions.vmThreads.minThreads ​

テストを実行するVMスレッドの最小数または割合を指定します。

poolOptions.vmThreads.useAtomics ​

スレッドを同期するためにAtomicsを使用します。これにより、パフォーマンスが向上する場合がありますが、古いNodeバージョンではセグメンテーション違反を引き起こす可能性があります (デフォルト: false)。

poolOptions.vmThreads.memoryLimit ​

VMスレッドプールのメモリ制限。メモリリークが発生する場合は、この値を調整してください。

poolOptions.forks.isolate ​

フォークプールでテストを分離します (デフォルト: true)。

poolOptions.forks.singleFork ​

単一のchild_process内でテストを実行します (デフォルト: false)。

poolOptions.forks.maxForks ​

テストを実行するプロセスの最大数または割合を指定します。

poolOptions.forks.minForks ​

テストを実行するプロセスの最小数または割合を指定します。

poolOptions.vmForks.isolate ​

VMフォークプールでテストを分離します (デフォルト: true)。

poolOptions.vmForks.singleFork ​

単一のchild_process内でテストを実行します (デフォルト: false)。

poolOptions.vmForks.maxForks ​

テストを実行するVMプロセスの最大数または割合を指定します。

poolOptions.vmForks.minForks ​

テストを実行するVMプロセスの最小数または割合を指定します。

poolOptions.vmForks.memoryLimit ​

VMフォークプールのメモリ制限。メモリリークが発生する場合は、この値を調整してください。

fileParallelism ​

すべてのテストファイルを並行して実行するかどうかを指定します。無効にするには--no-file-parallelismを使用します (デフォルト: true)。

maxWorkers ​

テストを実行するワーカーの最大数または割合を指定します。

minWorkers ​

テストを実行するワーカーの最小数または割合を指定します。

environment ​

ブラウザで実行しない場合、ランナー環境を指定します (デフォルト: node)。

passWithNoTests ​

テストが見つからない場合にテスト実行を成功とします。

logHeapUsage ​

Nodeで実行中に各テストのヒープサイズを表示します。

allowOnly ​

onlyとマークされたテストとスイートを許可します (デフォルト: !process.env.CI)。

dangerouslyIgnoreUnhandledErrors ​

発生した未処理のエラーを無視します。

sequence.shuffle.files ​

ファイルをランダムな順序で実行します。このオプションを有効にしても、実行時間の長いテストが早く開始されることはありません (デフォルト: false)。

sequence.shuffle.tests ​

テストをランダムな順序で実行します (デフォルト: false)。

sequence.concurrent ​

テストを並行して実行します (デフォルト: false)。

sequence.seed ​

ランダム化シードを設定します。--sequence.shuffleがfalseの場合、このオプションは効果がありません。詳細については"Random Seed" ページを参照してください。

sequence.hooks ​

フックが実行される順序を変更します。受け入れられる値は "stack"、"list"、"parallel" です。詳細についてはsequence.hooksを参照してください (デフォルト: "parallel")。

sequence.setupFiles ​

セットアップファイルが実行される順序を変更します。受け入れられる値は "list" と "parallel" です。"list" に設定すると、定義された順序でセットアップファイルが実行されます。"parallel" に設定すると、セットアップファイルが並行して実行されます (デフォルト: "parallel")。

inspect ​

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

Node.jsインスペクターを有効にします (デフォルト: 127.0.0.1:9229)。

inspectBrk ​

Node.jsインスペクターを有効にし、テスト開始前にブレークします。

testTimeout ​

テストのデフォルトのタイムアウト（ミリ秒）です (デフォルト: 5000)。

hookTimeout ​

デフォルトのフックタイムアウト（ミリ秒）です (デフォルト: 10000)。

bail ​

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

指定された数のテストが失敗した場合にテスト実行を停止します (デフォルト: 0)。

retry ​

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

テストが失敗した場合に指定された回数だけ再試行します (デフォルト: 0)。

diff ​

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

diffインターフェースの生成に使用されるdiff設定へのパスを指定します。

exclude ​

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

テストから除外する追加のファイルグロブを指定します。

expandSnapshotDiff ​

スナップショットが失敗した場合に完全な差分を表示します。

disableConsoleIntercept ​

コンソールロギングの自動インターセプトを無効にします (デフォルト: false)。

typecheck.enabled ​

テストと並行して型チェックを有効にします (デフォルト: false)。

typecheck.only ​

型チェックテストのみを実行します。これにより、型チェックが自動的に有効になります (デフォルト: false)。

typecheck.checker ​

使用する型チェッカーを指定します。利用可能な値は "tsc"、"vue-tsc"、および実行可能ファイルへのパスです (デフォルト: "tsc")。

typecheck.allowJs ​

JavaScriptファイルの型チェックを許可します。デフォルトではtsconfig.jsonの値を使用します。

typecheck.ignoreSourceErrors ​

ソースファイルからの型エラーを無視します。

typecheck.tsconfig ​

カスタムtsconfigファイルへのパスを指定します。

project ​

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

Vitestワークスペース機能を使用している場合に実行するプロジェクトの名前。これは複数のプロジェクトに対して繰り返すことができます: --project=1 --project=2。--project=packages*のようなワイルドカードを使用してプロジェクトをフィルタリングすることもできます。

slowTestThreshold ​

テストが遅いと見なされるしきい値（ミリ秒）です (デフォルト: 300)。

teardownTimeout ​

ティアダウン関数のデフォルトのタイムアウト（ミリ秒）です (デフォルト: 10000)。

maxConcurrency ​

スイート内の同時テストの最大数です (デフォルト: 5)。

expect.requireAssertions ​

すべてのテストに少なくとも1つのアサーションが必要であることを要求します。

expect.poll.interval ​

expect.poll()アサーションのポーリング間隔（ミリ秒）です (デフォルト: 50)。

expect.poll.timeout ​

expect.poll()アサーションのポーリングタイムアウト（ミリ秒）です (デフォルト: 1000)。

printConsoleTrace ​

常にコンソールスタックトレースを出力します。

run ​

  • CLI: --run

ウォッチモードを無効にします。

color ​

  • CLI: --no-color

コンソール出力から色を削除します。

clearScreen ​

  • CLI: --clearScreen

ウォッチモード中にテストを再実行する際にターミナル画面をクリアします (デフォルト: true)。

standalone ​

  • CLI: --standalone

テストを実行せずにVitestを開始します。ファイルフィルターは無視され、テストは変更時のみ実行されます (デフォルト: false)。

changed ​

  • 型: boolean | string
  • デフォルト: false

変更されたファイルに対してのみテストを実行します。値が指定されない場合、未コミットの変更（ステージング済み・未ステージングを含む）に対してテストを実行します。

最後のコミットで行われた変更に対してテストを実行するには、--changed HEAD~1を使用できます。コミットハッシュ（例：--changed 09a9920）またはブランチ名（例：--changed origin/develop）を渡すことも可能です。

コードカバレッジ機能と併用する場合、レポートには変更に関連するファイルのみが含まれます。

forceRerunTriggers設定オプションと組み合わせると、forceRerunTriggersリストに記載されているファイルのうち少なくとも1つが変更された場合に、テストスイート全体が実行されます。デフォルトでは、Vitest設定ファイルとpackage.jsonへの変更は常にスイート全体を再実行します。

shard ​

  • 型: string
  • デフォルト: disabled

テストスイートを<index>/<count>形式で分割実行します。この形式では、

  • countは正の整数で、分割数
  • indexは正の整数で、分割インデックス

このコマンドは、すべてのテストをcount個の等しい部分に分割し、そのうちindex番目の部分にあるテストのみを実行します。例えば、テストスイートを3つの部分に分割するには、次のようにします。

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

WARNING

このオプションは--watchが有効な状態（開発環境ではデフォルトで有効）では使用できません。

TIP

--reporter=blobが出力ファイルなしで使用された場合、デフォルトのパスには、他のVitestプロセスとの衝突を避けるために現在のシャード設定が含まれます。

merge-reports ​

  • 型: boolean | string

指定されたフォルダ（デフォルトでは.vitest-reports）にあるすべてのブロブレポートをマージします。このコマンドでは、任意のレポーターを使用できます（blobを除く）。

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

MITライセンス の下で公開されています。

Copyright (c) 2024 Mithril Contributors

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

MITライセンス の下で公開されています。

Copyright (c) 2024 Mithril Contributors