PhpStorm 2026.1 Help

Jest

Jest は、クライアント側 JavaScript アプリケーションや特に React アプリケーション向けのテストプラットフォームです。 プラットフォームの詳細については、 Jest(英語) の公式 Web サイトを参照してください。

PhpStorm で Jest テストの実行やデバッグができます。 テスト結果はツリービューで確認でき、そこからテストソースに簡単に移動できます。 テストのステータスは、エディターでテストの横に表示され、すぐに実行したりデバッグすることができます。

始める前に

  1. Node.js をダウンロードしてインストールします。

  2. 設定で JavaScript and TypeScript プラグインが有効になっていることを確認します。 Ctrl+Alt+S を押して設定を開き、 プラグイン を選択します。 インストール済み タブをクリックします。 検索フィールドに JavaScript and TypeScript と入力します。 プラグインの詳細については、 プラグイン管理を参照してください。

Jest をインストールして構成する

  • 組み込み ターミナル (Alt+F12) で次のように入力します。

    npm install --save-dev jest

Jest 公式 Web サイトで オンラインドキュメント(英語)および Jest の設定(英語)の詳細を参照してください。

テストの実行

PhpStorm を使うと、エディターから単一の Jest テストをすぐに実行したり、実行/デバッグ構成を作成してテストの一部またはすべてを実行できます。

JavaScript および TypeScript コードの Vitest テスト作成方法の詳細は、Vitest 公式ウェブサイトの Vitest features を参照してください。

エディターから単一のテストを実行する

  • ガターで the Run icon または リラン アイコン をクリックし、リストから 実行 <test_name> を選択します。

    Run single test from the editor

    エディターでテストが成功したか失敗したかは、ガターの テストステータス アイコン テスト成功テスト失敗 で確認できます。

プロジェクトツールウィンドウからフォルダー内のすべてのテストを実行する

  • プロジェクト ツールウィンドウ(Alt+1 )で、テストが入っているフォルダーを選択し、次に 「<folder name>」内のテストを実行 を選択します。

    フォルダー内のすべてのテストを実行する

Jest 実行構成を作成する

  1. 実行 / デバッグ構成ダイアログ (メインメニューの 実行 | 実行構成の編集) を開き、左側のペインで 追加ボタン をクリックし、リストから Jest を選択します。 実行/デバッグ構成:Jest ダイアログが開きます。

  2. 使用する Node.js ランタイムを指定します。

    プロジェクト エイリアスを選択すると、PhpStorm は JavaScript ランタイムページの ノードランタイム フィールドにあるプロジェクトのデフォルトインタープリターを自動的に使用します。 ほとんどの場合、PhpStorm はプロジェクトのデフォルトランタイムを検出してフィールドへ自動入力します。

    別の構成済みのローカルインタープリターまたはリモートインタープリターを選択するか、 閲覧ボタン をクリックして新しいインタープリターを構成することもできます。

  3. jestreact-scriptsreact-script-tsreact-super-scriptsreact-awesome-scripts パッケージの場所を指定します。

  4. アプリケーションの作業ディレクトリを指定します。 デフォルトでは、 作業ディレクトリ フィールドにはプロジェクトのルートフォルダーが表示されます。 この事前定義された設定を変更するには、目的のフォルダーへのパスを指定してください。

  5. 実行するテストを指定します。 これは、特定のテストまたはスイート、テストファイル全体、テストファイルを含むフォルダーにすることができます。

  6. オプション:

    使用する jest.config.js または jest.config.ts ファイルを指定します:リストから該当ファイルを選択するか、 閲覧ボタン をクリックし、開いたダイアログで選択するか、フィールドにパスを入力してください。

    フィールドが空の場合、PhpStormは jest キーを持つ package.json ファイルを探します。 検索は、 作業ディレクトリから上に向かってファイルシステムで実行されます。 適切な package.json ファイルが見つからない場合、 Jest のデフォルト設定(英語)がオンザフライで生成されます。

  7. オプション:

    関連するソースファイルの変更時に自動的に再実行されるテストを構成します。 これを行うには、 Jest オプション フィールドに --watch フラグを追加します。

    テストセッション中に 実行 ツールウィンドウの 変更のウォッチ トグルボタンを押して、後で ウォッチモードをオンにすることもできます。以下の 変更時にテストを自動的に再実行する (ウォッチモード)を参照してください。

  8. オプション:

    コマンドを実行するための環境変数を指定します。 PhpStormは、これらの変数を process.env の補完リストに表示します。

    Jest 実行構成からの環境変数の補完
  9. ノード オプション フィールドに、必要に応じて、Node.js 実行可能ファイルに渡される Node.js 固有のコマンドラインオプションを入力します。 許容されるオプションは次のとおりです。

    • 実行中に CoffeeScript ファイルをオンザフライで JavaScript にコンパイルするには、 --require coffeescript/register を使用します。

      このモードでは、 coffeescript パッケージの一部である register.js ファイルがプロジェクト内に配置されている必要があります。 CoffeeScript コンパイラーをインストールの説明に従って、 coffeescript パッケージがローカルにインストールされていることを確認してください。

    • Chrome デバッグプロトコル(英語)サポートには --インスペクション または --inspect-brk パラメーターを使用します。

    • プロジェクトで ECMAScript モジュール(英語)を使用するには、 —experimental-vm-modules フラグを ノード オプション フィールドに追加します。

実行構成を介してテストを実行する

  1. 構成の一覧から Jest 実行 / デバッグ構成を選択し、一覧またはツールバーの the Run icon をクリックします。

  2. 実行 ツールウィンドウの テストランナー タブで、テストの実行を監視し、テスト結果を分析します。 詳細は テスト結果を調査 を参照してください。

失敗したテストの再実行

  • テスト結果ツールバーの Rerun Failed Tests アイコン をクリックします。 PhpStorm は前回セッションで失敗したすべてのテストを実行します。

  • 特定の失敗したテストを再実行するには、そのコンテキストメニューで <テスト名>を実行; を選択します。

詳細は、 テストの再実行を参照してください。

変更時にテストを自動的に再実行する (ウォッチモード)

PhpStorm は、テスト関連のソースファイルに何らかの変更があった場合に、テストを自動的に再実行する ウォッチモードをサポートしています。 その結果、手動でテストを再実行したり、 Jest 実行 / デバッグ構成を再起動したりすることなく、コードに変更を加えるだけで済みます。

ナビゲーション

PhpStorm を使うことで、ファイルと関連するテストファイル間や、 Test Runner Tab のテスト結果からテストへジャンプできます。

PhpStorm を使うと、ファイルと関連するテストファイル間、またはテストやスイートの定義と テストランナータブでの結果間を移動できます。

  • テストとそのサブジェクト間、またはその逆に移動するには、エディターでファイルを開き、コンテキストメニューから Go to | テスト または Go to | テスト対象 を選択するか、 Ctrl+Shift+T を押します。

  • テスト結果からテスト定義に移動するには、「テストランナー 」タブでテスト名を 2 回クリックするか、コンテキストメニューから「ソースに移動 」を選択するか、単に F4 を押します。 テストファイルがエディターで開き、テスト定義にキャレットが置かれます。

  • テストまたはスイートの定義から テストランナー タブの結果に移動するには、ガターで テスト合格アイコン または テスト失敗アイコン をクリックし、リストから テストツリーで <test_name> を選択する を選択します。

    Jump from test definition to the Test Tree
  • 失敗したテストの場合、PhpStorm はスタックトレースからテストの失敗行に移動します。 正確な行がスタックトレースにない場合は、テスト定義に移動します。

    Jump to the failure line from a failed Jest test

スナップショットテスト

PhpStorm の Jest 連携はスナップショットテストといった優れた機能をサポートします。

.toMatchSnapshot() メソッドでテストを実行すると、Jest は __snapshots__ フォルダーにスナップショットファイルを作成します。 テストから関連するスナップショットに移動するには、テストの横のガターで Go スナップショット(カメラ)アイコンへ移動します。 をクリックするか、 .toMatchSnapshot() メソッドのコンテキストメニューから必要なスナップショットを選択します。

Jest スナップショットテスト: テストファイルから対応するスナップショットに移動する

スナップショットがレンダリングされたアプリケーションと一致しない場合、テストは失敗します。 これは、コードの一部の変更によりこの不一致が発生したか、スナップショットが古いため更新する必要があることを示しています。

この不一致の原因を確認するには、 テストランナー タブの右ペインにある 差異を見るにはクリック リンクから PhpStorm の組み込み 差分ビューアーを開いてください。

Jest snapshots: compare the expected and actual snapshots in the PhpStorm Diff Viewer

実行 ツールウィンドウの テストランナー タブから、古いスナップショットを直接更新できます。

  • 特定のテストのスナップショットを更新するには、テスト名の横にある クリックしてスナップショットを更新 リンクを使用します。

  • テストの古いスナップショットをすべてファイルから更新するには、テストファイル名の横にある クリックして失敗したスナップショットを更新 を使用します。

Jest スナップショットテスト: スナップショットの更新

デバッグテスト

PhpStorm を使うと、エディターから単一の Jest テストのデバッグをすぐに開始したり、いくつかまたはすべてのテストをデバッグするための実行/デバッグ構成を作成できます。

  • 必要に応じて ブレークポイントを設定します

  • エディターから単一のテストのデバッグを開始するには、ガターで the Run button または リラン アイコン をクリックし、リストから デバッグ <test_name> を選択します。

  • フォルダー内のすべてのテストのデバッグを開始するには、 プロジェクト ツールウィンドウでフォルダーを選択し、コンテキストメニューから 「<folder name>」内のテストをデバッグ を選択します。

    フォルダー内のすべてのテストをデバッグする
  • 実行 / デバッグ構成を介してテストデバッグを開始するには、 上記の説明に従ってJest 実行 / デバッグ構成を作成します。

    次に、構成のリストから Jest 実行 / デバッグ構成を選択し、リストまたはツールバーの デバッグアイコン をクリックします。

開いた デバッグツールウィンドウ で、通常どおり進めてください: プログラムをステップ実行一時停止と再開中断時の調査 、コールスタックや変数の確認、ウォッチの設定、変数の評価、 実際の HTML DOM の表示などを行えます。

コードカバレッジを監視する

PhpStorm を使うと、自分のコードが Jest テストでどの程度カバーされているか も把握できます。 PhpStorm は、専用の カバレッジ ツールウィンドウでこの統計を表示し、カバーされた行・カバーされていない行をエディターと プロジェクト ツールウィンドウ(Alt+1 )上で視覚的にマークします。

カバレッジでテストを実行する

  1. 上記のように Jest 実行 / デバッグ構成を作成します。

  2. メインツールバーのリストから Jest 実行 / デバッグ構成を選択し、リストの右側にある カバレッジあり実行アイコン をクリックします。

    または、エディターからカバレッジ付きで特定のスイートまたはテストをすばやく実行できます。ガターで the Run button または 再実行ボタン をクリックし、リストから カバレッジで <test_name> を実行する を選択します。

    エディターからのカバレッジで Jest テストを実行する
  3. カバレッジツールウィンドウでコードカバレッジを監視します。 このレポートには、テストでカバーされたファイルの数と、その中にカバーされている行の割合が表示されます。 レポートから、ファイルに移動して、どの行が覆われていたか(緑色にマーキングされているか、どの行が覆われていないか)、赤色に表示されているかを確認できます。

    Jest カバレッジレポート

Docker コンテナー内の Node.js で Jest テストを実行する

PhpStorm では、ローカル環境と同様に Docker コンテナー内で Jest テストを実行できます。

始める前に

  1. JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの Marketplace タブに Node.js リモートインタープリタープラグインをインストールして有効にします。

  2. 設定 | プラグイン ページ、 インストール済み タブで、 Node.js および Docker の必要なプラグインが有効になっていることを確認してください。 詳細については、 プラグインの管理を参照してください。

  3. Docker に記載されている手順に従って、 Docker をダウンロード、インストール、設定してください。

  4. Docker で Node.js リモートランタイムを構成するまたは Docker Compose 経由でインストールし、プロジェクトの デフォルトとして設定してください。 また、このリモートランタイムに関連付けられたパッケージマネージャーが プロジェクトのデフォルトとして設定されていることを確認してください。

  5. package.json を開き、Jest が devDependencies セクションにリストされていることを確認します。

    { "name": "node-express", "version": "0.0.0", "private": true, "dependencies": { "cookie-parser": "~1.4.4", "debug": "~2.6.9", "express": "~4.16.1", "http-errors": "~1.6.3", "morgan": "~1.9.1", "pug": "^3.0.2" }, "devDependencies": { "eslint": "^8.1.0", "http-server": "^14.0.0", "jest": "^27.3.1" } }
  6. エディターの任意の場所を右クリックして、コンテキストメニューから 「パッケージマネージャー install」を実行してください。 を選択します。

テストの実行

  1. Jest オフィシャル Web サイト(英語)の指示に従ってテストを作成します。

  2. ローカル開発と同様に進めてください。エディターから単一テストを直接実行・デバッグするか、または実行/デバッグ構成を作成し、一部または全てのテストを テストの実行テストのデバッグで起動します。

2026 年 5 月 22 日