Jest CLI Options
jest
のコマンドラインランナーは多くの便利なオプションを持っています。 jest --help
を実行することで使用可能な全てのオプションを見ることができます。 以下に示すオプションの多くは任意のテストを実行する際に利用できます。 Jest の各設定オプションは CLI から指定することもできます。
以下に簡単な概要を示します。
コマンドラインから実行する
全てのテストを実行する(既定値):
jest
パターンやファイル名で指定されたテストのみ実行する:
jest my-test #or
jest path/to/my-test.js
Hgやgit(の未コミットファイル) に基づいて変更のあったファイルに関連したテストを実行する:
jest -o
path/to/fileA.js
と path/to/fileB.js
に関連したテストを実行する:
jest --findRelatedTests path/to/fileA.js path/to/fileB.js
スペック名に一致するテストを実行する(基本的には describe
またはtest
内にある名前との一致を確認する):
jest -t name-of-spec
ウォッチモードで実行する:
jest --watch #runs jest -o by default
jest --watchAll #runs all tests
ウォッチモードにより特定のテストセットにフォーカスするためにファイル名やファイルパスを特定することも可能となります。
yarn で使用する
Jest を yarn test
で実行する時は、コマンドライン引数を Jest の引数として直接渡せます。
Instead of:
jest -u -t="ColorPicker"
このように使用できます:
yarn test -u -t="ColorPicker"
npm scriptsを使用する
npm test
でJestを実行する場合でも、npm test
とJestの引数との間に --
を指定することで、コマンドライン引数を使用できます。
Instead of:
jest -u -t="ColorPicker"
このように使用できます:
npm test -- -u -t="ColorPicker"
オプション
注意: CLIのオプションはConfigurationの設定値に優先します。
jest <regexForTestFiles>
--bail
--cache
--changedFilesWithAncestor
--changedSince
--ci
--clearCache
--collectCoverageFrom=<glob>
--colors
--config=<path>
--coverage[=<boolean>]
--debug
--detectOpenHandles
--env=<environment>
--errorOnDeprecated
--expand
--findRelatedTests <spaceSeparatedListOfSourceFiles>
--forceExit
--help
--init
--json
--outputFile=<filename>
--lastCommit
--listTests
--logHeapUsage
--maxWorkers=<num>
--noStackTrace
--notify
--onlyChanged
--passWithNoTests
--projects <path1> ... <pathN>
--reporters
--roots
--runInBand
--runTestsByPath
--setupTestFrameworkScriptFile=<file>
--showConfig
--silent
--testNamePattern=<regex>
--testLocationInResults
--testPathPattern=<regex>
--testPathIgnorePatterns=[array]
--testRunner=<path>
--updateSnapshot
--useStderr
--verbose
--version
--watch
--watchAll
--watchman
リファレンス
jest <regexForTestFiles>
引数を付けて jest
コマンドを実行した場合、その引数はプロジェクト配下のファイルを照合する正規表現として扱われます。 パターンを与えてテストスイートを実行することができます。 パターンに一致するファイルだけが選択され、実行されます。 端末によっては、次のように引数をクオートで囲む必要がある場合があります。jest "my.*(complex)?pattern"
また、Windows ではパスの区切りとして /
を使用するか、\
をエスケープして \
を使用する必要があります。
--bail
別名: -b
。 最初に失敗したテストの直後にテストスイートを終了します。
--cache
キャッシュを使用するかを指定します。 既定値ではtrueです。 キャッシュを無効化するには --no-cache
を指定します。 注意: キャッシュの無効化はキャッシュに関連した問題が発生した場合のみ行って下さい。 概して、キャッシュの無効化によりJestの実行時間は2倍になります。
キャッシュを調査したい場合は、 --showConfig
を指定して cacheDirectory
の値を確認して下さい。 キャッシュをクリアする必要がある場合は、 --clearCache
を使用してください。
--changedFilesWithAncestor
現在の変更と前回のコミットで行われた変更に関連するテストを実行します。 --onlyChanged
と同様に動作します。
--changedSince
指定されたブランチもしくはコミットハッシュ値以降の変更に関係するテストを実行します。 現在のブランチが指定されたブランチと大きく異なる場合、ローカルで行われた変更点のみがテストされます。 --onlyChanged
と同様に動作します。
--ci
このオプションが指定された場合、Jestは CI 環境で実行されていると仮定します。 この事によって新しいスナップショットが発生したときの挙動が変わります。 自動的に新しいスナップショットを保存する通常の動作ではなく、テストを失敗させてJestに --updateSnapshot
オプションを指定するように要求します。
--clearCache
Jest のキャッシュディレクトリを削除し、テストを実行せずに終了します。 Jest のデフォルトのキャッシュディレクトリか、もしくはオプションが渡された場合は cacheDirectory
を削除します。 デフォルトのキャッシュディレクトリは jest --showConfig
コマンドで確認できます。 注意: キャッシュをクリアすると、パフォーマンスが低下します。
--collectCoverageFrom=<glob>
A glob pattern relative to rootDir
matching the files that coverage info needs to be collected from.
--colors
標準出力が端末でなくても強制的にテスト結果を強調して表示します。
--config=<path>
別名: -c
。 テストの探索と実行の方法を指定する Jest の設定ファイルのパスを引数に指定します。 If no rootDir
is set in the config, the directory containing the config file is assumed to be the rootDir
for the project. 引数にJSON形式の値を与えることでもJestは設定として使用します。
--coverage[=<boolean>]
エイリアス: --collectCoverage
。 テストのカバレッジ情報が収集され出力に表示されるべきであることを指定します。 <boolean>
の値により設定オプションを上書きします。
--debug
Jestの設定に関するデバック情報を出力します。
--detectOpenHandles
開いているハンドルを収集して出力することを試みます。これにより、Jest が何も出力せずに終了するのを防ぐことができます。 Jestを潜在的な原因を追跡するために終了させるために--forceExit
を使う必要がある際に、このオプションを使用してください。 async_hooks
を使って実装しているため、Node 8以降でしか動作しません。 This option has a significant performance penalty and should only be used for debugging.
--env=<environment>
すべてのテストに使用されるテスト環境。 任意のファイルまたはノードモジュールを指定することができます。 例: jsdom
, node
または path/to/my-environment.js
.
--errorOnDeprecated
Make calling deprecated APIs throw helpful error messages. Useful for easing the upgrade process.
--expand
別名: -e
。 このフラグを指定すると差分とエラーを一部ではなく全体表示します。
--findRelatedTests <spaceSeparatedListOfSourceFiles>
引数で渡された、スペース区切りのソースリストにあるテストを探して実行します。 コミット前に最小限必要なテストを実行するフックで使うのに便利です。 ソースファイルのテストカバレッジを含めるのに、--coverage
が使用でき、--collectCoverageFrom
でファイルを重複して指定する必要はありません。
--forceExit
全テストが終了した後にJestを強制的に終了します。 テストコードにてリソースを適切にクリーンアップできない場合に便利です。 *注意: この機能は緊急の避難口のようなものです。 Jestがテスト実行後に終了しなければ、外部リソースが占有されたままであったり、タイマー処理がコードを保留したままであるという事です。 Jestが正常に終了できるよう各テスト後に外部リソースを開放することをお勧めします。 --detectOpenHandles
で追跡することができます。
--help
このページと同様に、ヘルプ情報を表示します。
--init
基本の設定ファイルを生成する. Based on your project, Jest will ask you a few questions that will help to generate a jest.config.js
file with a short description for each option.
--json
テスト結果を JSON で出力します。 このモードでは、他のすべてのテスト出力とユーザーメッセージが標準エラー出力に送信されます。
--outputFile=<filename>
--json
が同時に指定された場合にテスト結果をファイルに出力します。 The returned JSON structure is documented in testResultsProcessor.
--lastCommit
最後に行ったコミット内のファイル変更の影響を受ける、すべてのテストを実行します。 --onlyChanged
と同様に動作します。
--listTests
この引数が与えられるとJestはすべてのテストをJSON形式でリストして終了します。 --findRelatedTests
と一緒に使用することで、Jest がどのテストを実行するかを知ることができます。
--logHeapUsage
テストごとにヒープ使用量をログに記録します。 メモリリークのデバッグに便利です。 ノードでは --runInBand
と --expose-gc
と一緒に使用してください。
--maxWorkers=<num>
別名: -w
。 テスト実行のためにworker-poolが生成するworkerの最大数を指定します。 In single run mode, this defaults to the number of the cores available on your machine minus one for the main thread. In watch mode, this defaults to half of the available cores on your machine to ensure Jest is unobtrusive and does not grind your machine to a halt. It may be useful to adjust this in resource limited environments like CIs but the defaults should be adequate for most use-cases.
--noStackTrace
テスト結果でスタックトレースを出力しません。
--notify
テスト結果の通知機能を有効にします。 JavaScriptのテスト以外の何かに意識を集中させてしまいたくない場合に適しています。
--onlyChanged
別名: -o
。 現在のリポジトリでそのファイルに変更があったかに基づいて、どのテストを実行するのかを識別しようとします。 git/hgのリポジトリでテストを実行した場合のみ動作し、静的な依存グラフが必要です (言い換えると動的な依存グラフは必要ありません)。
--passWithNoTests
ファイルが1つも存在しなくても、テストスイートがパスするようにします。
--projects <path1> ... <pathN>
Run tests from one or more projects, found in the specified paths; also takes path globs. This option is the CLI equivalent of the projects
configuration option. Note that if configuration files are found in the specified paths, all projects specified within those configuration files will be run.
--reporters
Run tests with specified reporters. Example with multiple reporters:
jest --reporters="default" --reporters="jest-junit"
--roots
Jestがその中でファイルを探索するのに使用するディレクトリのパスを使用します。
--runInBand
別名: -i
。 子プロセスのworker poolを作成せずに現在のプロセスで全てのテストを1つずつ実行します。 デバッグ時に便利です。
--runTestsByPath
パターンやファイル名で指定されたテストのみ実行します。
注: デフォルトの正規表現マッチングは、小規模なテストではうまく機能しますが、複数のパターンを用いる場合や、大規模なテストでは遅くなります。 このオプションは、正規表現のマッチングロジックを置き換え、Jestが特定のテストファイルをフィルタリングするのに掛かる時間を最適化します。
--setupTestFrameworkScriptFile=<file>
各テスト前にテストフレームワークの構成やセットアップを行うためのモジュールへのパスを指定します。 セットアップスクリプトによってインポートされたファイルはテスト中はモックされませんのでご注意ください。
--showConfig
Jestの設定を表示して終了します。
--silent
コンソール経由でメッセージを表示しないようにします。
--testNamePattern=<regex>
別名: -t
。 Run only tests with a name that matches the regex. 例えば、"GET /api/posts with auth"
のような認証に関するテストのみ実行したいのであれば、jest -t=auth
が使用できます。
Note: The regex is matched against the full name, which is a combination of the test name and all its surrounding describe blocks.
--testLocationInResults
テスト結果に location
フィールドを追加します。 レポートでテストの配置場所を表示したい場合に便利です。
column
は 0 でインデントされますが、line
はインデントされないことに注意してください。
{
"column": 4,
"line": 5
}
--testPathPattern=<regex>
テスト実行前に全てのテストのパスに対して照合する正規表現の文字列を指定します。 また、Windows ではパスの区切りとして /
を使用するか、\
をエスケープして \
を使用する必要があります。
--testPathIgnorePatterns=[array]
An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to --testPathPattern
, it will only run those tests with a path that does not match with the provided regexp expressions.
--testRunner=<path>
カスタムテストランナーを指定します。
--updateSnapshot
別名: -u
。 テスト実行中に失敗した全てのスナップショットを再取得する場合にこのフラグを指定します。 スナップショットを再取得するためにテストスイートのファイル名のパターンや --testNamePattern
オプションを同時に利用することができます。
--useStderr
全ての出力を標準エラー出力へ向けます。
--verbose
各テストごとの結果をテストスイートの階層構造とともに表示します。
--version
別名: -v
。 バージョンを出力して終了します。
--watch
変更されたファイルに関連するテストを再実行するためにファイルを監視します。 ファイルが変更されたときにすべてのテストを再実行したい場合は、代わりに --watchAll
オプションを使用してください。
--watchAll
ファイルを監視し、何かが変更されたときにすべてのテストを再実行します。 変更されたファイルに関わるテストのみを再実行したい場合は、 --watch
オプションを使用します。
Use --watchAll=false
to explicitly disable the watch mode. Note that in most CI environments, this is automatically handled for you.
--watchman
Whether to use watchman
for file crawling. デフォルトは true
です。 --no-watchman
で無効になります。