WebStorm 2024.3 ヘルプ

実行 / デバッグ構成: Jest

作成: 実行 | 実行構成の編集 | Add New Configuration | Jest

このページでは、構成固有の項目と、すべての実行 / デバッグ構成に共通のオプションについて説明します。この構成の使用方法の詳細については、「Jest」を参照してください。

このダイアログでは、Jest(英語) テストを実行するための構成を作成します。JavaScript および TypeScript コードの Vitest テストの作成の詳細については、Vitest 公式 Web サイトの Vitest の機能(英語)を参照してください。

始める前に

  • お使いのコンピューターに Node.js(英語) がインストールされていることを確認してください。

Jest 固有の構成設定

項目

説明

構成ファイル

このフィールドでは、必要に応じて、使用する jest.config.js または jest.config.ts ファイルを指定します。リストから関連ファイルを選択するか、the Browse button をクリックして開いたダイアログで選択するか、フィールドにパスを入力します。

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

Node インタープリター

このフィールドで、使用する Node.js インタープリターを指定します。

プロジェクトエイリアスを選択すると、WebStorm は Node.js ページの Node インタープリターフィールドからプロジェクトの既定のインタープリターを自動的に使用します。ほとんどの場合、WebStorm はプロジェクトの既定のインタープリターを検出し、フィールド自体に入力します。

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

詳細については、「リモート Node.js インタープリターの構成」、「ローカル Node.js インタープリターの構成」、「Windows Subsystem for Linux で Node.js を使用する」を参照してください。

Node オプション

このフィールドに、Node.js 実行可能ファイルに渡される Node.js 固有のコマンドラインオプションを入力します。受け入れ可能なオプションは次のとおりです。

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

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

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

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

Jest パッケージ

このフィールドで、jestreact-scriptsreact-script-tsreact-super-scriptsreact-awesome-scripts パッケージの場所を指定します。

作業ディレクトリ

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

Jest オプション

このフィールドに、Jest に渡す Jest CLI オプション(英語)を入力します。例: 自動テストのようなランナーをオンにするために --watch フラグを追加します。その結果、再実行ボタン Rerun をクリックせずに、関連するソースコードを変更すると、現在の実行構成のテストが自動的に再開されます。

環境変数

このフィールドでは、必要に応じて、コマンドを実行するための環境変数を指定します。WebStorm は、これらの変数を process.env の補完リストに表示します。

Completion for environment variables from Jest run configuration

テスト

この領域に、実行するテストを指定します。使用可能なオプションは次のとおりです。

  • すべてのテスト : jest.config.js または jest.config.ts 構成ファイル、または生成された Jest のデフォルト設定(英語)からすべてのテストを実行するには、このオプションを選択します。デフォルトの構成では、テストは testRegex プロパティ(英語)のデフォルト値によって認識されます。

  • テストファイル : 1 つのファイルからテストのみを実行し、テストファイルフィールドにこのファイルへのパスを指定するには、このオプションを選択してください。

  • スイート : このオプションを選択して、テストファイルから個々のスイートを実行し、テストファイルフィールドにこのファイルへのパスを指定します。スイート名フィールドで the Browse button をクリックし、Add ボタンと Remove ボタンを使用して実行するスイートのリストを構成します。

  • テスト : このオプションを選択して、テストファイルから個々のテストを実行し、テストファイルフィールドにこのファイルへのパスを指定します。テスト名フィールドで the Browse button をクリックし、Add および Remove ボタンを使用して実行するテストのリストを構成します。

Docker コンテナーの設定

この読み取り専用フィールドには、ポートとボリュームのバインディングが表示されます。the Expand button をクリックして、コマンドプレビューを開きます。

Run/debug configuration: Jest. Docker container settings

Docker Compose

この領域では、Docker Compose に渡すコマンドとオプションを指定します。デフォルト設定を受け入れるか、「 the Expand button 」をクリックしてカスタム設定 (たとえば、--rm--service-ports などのカスタム Docker Compose フラグ) を指定します。詳細については、Docker オフィシャル Web サイト(英語)を参照してください。

コマンドプレビューを確認してください。

共通設定

実行構成を編集するとき(ただし実行構成テンプレートは編集しないとき)、次のオプションを指定できます。

項目

説明

名前

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

複数のインスタンスを許可する

この実行構成の複数のインスタンスを並行して実行できるようにします。

デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、WebStorm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。

プロジェクトファイルとして保存

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、.idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、WebStorm は実行構成設定を .idea/workspace.xml に保存します。

ツールバー

実行 / デバッグ構成のツリー表示には、プロジェクトで使用可能な構成を管理したり、デフォルトの構成テンプレートを調整したりするのに役立つツールバーがあります。

項目

ショートカット

説明

the Add button

Alt+Insert

実行 / デバッグ構成を作成します。

the Remove button

Alt+Delete

選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。

Copy

Ctrl+D

選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。

Save configuration

このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。

Move into new folder / Create new folder

新しいフォルダーに移動 / 新しいフォルダーを作成します。実行 / デバッグ構成は、フォルダーに配置することでグループ化できます。

フォルダーを作成するには、カテゴリ内の設定を選択し、Folder をクリックしてフォルダー名を指定します。カテゴリだけにフォーカスがある場合は、空のフォルダーが作成されます。

次に、設定をフォルダー内、フォルダー間、フォルダー外に移動するには、ドラッグまたは Move Up ボタンと Move Down ボタンを使用します。

グループ化を解除するには、フォルダーを選択して Remove Configuration をクリックします。

Sort configurations

このボタンをクリックすると、設定がアルファベット順にソートされます。

起動前

この領域では、選択した実行 / デバッグ構成を開始する前に実行するタスクを指定できます。タスクは、リストに表示されている順序で実行されます。

項目

ショートカット

説明

the Add button

Alt+Insert

このアイコンをクリックして、以下の使用可能なタスクのいずれかを追加します。

  • Web ブラウザーの起動 : ブラウザーを起動するにはこのオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 URL を入力します。また、ブラウザーを JavaScript デバッガーで起動するかどうかを指定します。

  • 外部ツールの実行 : 外部アプリケーションを実行することを選択します。開いたダイアログで、実行する 1 つまたは複数のアプリケーションを選択します。WebStorm でまだ定義されていない場合は、定義を追加します。詳細については、「外部ツールおよび外部ツール」を参照してください。

  • 別の構成を実行 : 別の実行 / デバッグ構成を実行することを選択し、それが完了するまで待ってから現在の構成を開始します。複数の構成を並行して実行する場合は、複合実行 / デバッグ構成を使用してください。

  • ファイル監視の実行 : WebStorm に現在アクティブなすべての File Watchers を適用させるには、このオプションを選択します。

  • リモート外部ツールの実行 : リモート SSH 外部ツールを追加します

  • Grunt タスクの実行 : Grunt タスクを実行するには、このオプションを選択してください。

    表示される Grunt タスクダイアログで、必要なタスクが定義されている Gruntfile.js を指定し、実行するタスクを選択して、Grunt ツールに渡す引数を指定します。

    Node.js インタープリターの場所、渡すパラメーター、grunt-cli パッケージへのパスを指定します。

  • gulp タスクの実行 : Gulp タスクを実行するには、このオプションを選択してください。

    表示される Gulp タスクダイアログで、必要なタスクが定義されている Gulpfile.js を指定し、実行するタスクを選択して、Gulp ツールに渡す引数を指定します。

    Node.js インタープリターの場所、それに渡すパラメーター、gulp パッケージへのパスを指定します。

  • npm スクリプトの実行 : npm スクリプトを実行するには、このオプションを選択してください。

    開いた NPM スクリプトダイアログで、npm 実行 / デバッグ構成設定を指定します。

  • TypeScript のコンパイル : 組み込み TypeScript コンパイラーを実行するように選択し、TypeScript コードに加えたすべての変更が生成された JavaScript ファイルに反映されるようにします。表示される TypeScript のコンパイル設定ダイアログで、エラーの確認チェックボックスを選択または選択解除して、エラーが検出された場合のコンパイラーの動作を設定します。

    • エラーの確認チェックボックスが選択されていると、コンパイラーはすべてのエラーを表示し、実行構成は開始されません。

    • エラーの確認チェックボックスがオフの場合、コンパイラーは検出されたすべてのエラーを表示しますが、実行構成は起動されます。

  • CoffeeScript ソースマップの生成 : CoffeeScript ソースのソースマップを生成するには、このオプションを選択してください。表示されるダイアログで、CoffeeScript のソースファイルがある場所を指定します。

the Remove button

Alt+Delete

このアイコンをクリックして、選択したタスクをリストから削除します。

Edit

Enter

選択したタスクを編集するには、このアイコンをクリックします。開いたダイアログで必要な変更を加えます。

Method up

Method down

Alt+Up

Alt+Down

これらのアイコンをクリックして、選択したタスクをリスト内で 1 行上または下に移動します。タスクは、リストに表示されている順に実行されます。

このページを表示する

実行 / デバッグ構成を実際に開始する前に、実行 / デバッグ構成設定を表示するには、このチェックボックスを選択します。

ツールウィンドウをアクティブにする

デフォルトではこのチェックボックスは選択されており、実行 / デバッグ構成を開始すると実行またはデバッグツールウィンドウが開きます。

それ以外の場合、チェックボックスがオフの場合、ツールウィンドウは非表示になります。ただし、構成が実行されている場合は、Alt+4 または Alt+5 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

関連ページ:

Jest

Jest は、特にクライアント側の JavaScript アプリケーションおよび React アプリケーション用のテストプラットフォームです。プラットフォームの詳細については、Jest の公式 Web サイトを参照してください。WebStorm の Jest でテストを実行し、デバッグすることができます。テスト結果はツリービューで確認でき、そこからテストソースに簡単に移動できます。テストのステータスは、エディターでテストの横に表示され、すぐに実行したりデバッグすることができます。始める前に:お使いのコ...

Node.js

このページは、プラグインのインストールに従って、設定 | プラグインページのインストール済みタブで Node.js バンドルプラグインが有効になっている場合にのみ表示されます。次の Node.js バージョンは、WebStorm 2023.3 以降でサポートされています。Node.js 20 - アクティブな長期サポート (LTS) バージョン、Node.js 21 - 現在のバージョン、サポートされている Node.js バージョンの詳細情報 Node インタープリターこのフィールドでは、現在のプロ...

リモート Node.js インタープリターの構成

WebStorm では、リモートホストまたは仮想環境にインストールされた Node.js でアプリケーションを開発、テスト、リント、実行、デバッグするときに、リモート Node.js インタープリターを構成する必要があります。リモート Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで構成されます。このダイアログは、リモート環境でアプリケーションを実行またはデバッグするための Node.js 実行 / デバッグ構成を作成または編集するときに、設定ダイア...

Node.js

Node.js は、サーバーやコマンドラインなど、ブラウザーの外部で JavaScript を実行するための軽量ランタイム環境です。WebStorm は Node.js と統合されており、アプリケーションの構成、編集、実行、デバッグ、テスト、プロファイリング、保守を支援します。Node.js がアプリケーションのローカルランタイムとして、または npm パッケージの管理、JavaScript リンターの実行、ツールのビルド、フレームワークのテストなどにのみ必要な場合は、Node.js をインストール...

CoffeeScript

WebStorm では、JavaScript にコンパイルされる CoffeeScript を使用できます。WebStorm は *.coffee ファイルを認識し、それらにのマークを付けます。CoffeeScript コードにブレークポイントを直接設定でき、WebStorm はコンパイル中に生成されたソースマップを使用してブレークポイントを認識します。WebStorm は、キーワード、ラベル、変数、パラメーター、関数の補完を提案することにより、CoffeeScript コードの作成を支援します。シンボ...

実行 / デバッグ構成

WebStorm は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。実行 / デバッグ構成には 2 つのタイプがあります。一時的 — コンテキストメニューからを選択するたびに作成されます。コンテキストメニューを呼び出すには、オブジェクトまたは領域を右クリックします。永続的 — テンプレートから明示的に作成されるか、一時的な構成を保存することによって作成されま...