Karma
Karma (英語) は、クライアント側 JavaScript をテストするためのツールです。Karma は、実際のブラウザーで実行されているアプリケーションに対してテストを実行し、テスト結果の正確さと信頼性を保証します。WebStorm は Karma と統合されているため、IDE 内からテストの実行、デバッグ、カバレッジを監視できます。テスト結果はツリービューで確認でき、そこからテストソースに簡単に移動できます。テストのステータスは、エディターのテストの横に表示され、すぐに実行またはデバッグするオプションが表示されます。
始める前に
お使いのコンピューターに Node.js(英語) がインストールされていることを確認してください。
設定で Karma プラグインが有効になっていることを確認します。Ctrl+Alt+S を押して設定を開き、 を選択します。インストール済みタブをクリックします。検索フィールドに Karma と入力します。プラグインの詳細については、プラグインのマッピングを参照してください。
Karma をインストールする
Karma 自体に加えて、karma-jasmine や jasmine-core などの追加のパッケージ (プラグイン) が必要です。Karma オフィシャル Web サイト(英語)から詳細を参照してください。
埋め込まれたターミナル (Alt+F12) を開きます。
次のいずれかのコマンドを入力します。
Karma と必要なすべてのプラグインが package.json にすでに定義されている場合は
npm install
開発の依存関係(英語)として Karma とプラグインをインストールするには:
npm install --save-dev karma npm install --save-dev <karma_plugin> <another_karma_plugin>
Karma 構成ファイルを生成する
Karma テストは、対話モードで生成された karma.conf.js 構成ファイルに従って実行されます。プロジェクトにすでに karma.conf.js がある場合は、この手順をスキップしてください。Karma 構成の詳細については、「Karma オフィシャル Web サイト(英語)」を参照してください。
Karma 構成ファイルを作成する
ターミナルを開き、オペレーティングシステムに応じて次のいずれかを入力して karma.conf.js 生成ウィザードを開始します。
macOS および Linux の場合: ./node_modules/karma/bin/karma init
Windows の場合:
npm install -g karma-cli karma init
ウィザードの質問に答えて、使用するテストフレームワークと自動的にキャプチャーされるブラウザーを指定します。
Karma ファイル: パターンマッチング(英語)も参照してください。
テストの実行
WebStorm を使用すると、Karma テストをエディターから簡単に実行したり、実行 / デバッグ構成を作成してテストの一部または全部を実行することができます。
エディターから単一のテストを実行する
左側のガターの
または
をクリックして、リストから実行 <テスト名> を選択します。
ガターのテストステータスアイコン
および
により、エディターでテストが成功したか失敗したかを確認することもできます。
Karma 実行構成を作成する
実行 / デバッグ構成ダイアログ (メインメニューの ) を開き、左側のペインで
をクリックし、リストから Karma を選択します。「実行 / デバッグ構成: Karma」ダイアログが開きます。
使用する Node.js インタープリターを指定します。
プロジェクトエイリアスを選択すると、WebStorm は Node.js ページの Node インタープリターフィールドからプロジェクトの既定のインタープリターを自動的に使用します。ほとんどの場合、WebStorm はプロジェクトの既定のインタープリターを検出し、フィールド自体に入力します。
別の構成済みのローカルインタープリターまたはリモートインタープリターを選択するか、
をクリックして新しいインタープリターを構成することもできます。
詳細については、「リモート Node.js インタープリターの構成」、「ローカル Node.js インタープリターの構成」、「Linux の Windows サブシステムで Node.js を使用する」を参照してください。
必要に応じて、Node.js に渡す Node.js 固有のオプションパラメーターと環境変数(英語)を指定します。
karma.conf.js へのパスを指定します。
使用する
karma
パッケージを指定します。次のいずれかになります。Karma インストールホーム /npm/node_modules/karma。Node パッケージマネージャーを介して Karma を定期的にインストールした場合、WebStorm は Karma インストールホーム自体を検出します。
node_modules/@angular/cli
へのパス。いいえ(英語)を使用している場合は、
node_modules/nx
へのパス。
アプリケーションの作業ディレクトリを指定します。デフォルトでは、作業ディレクトリフィールドにはプロジェクトのルートフォルダーが表示されます。この定義済みの設定を変更するには、目的のフォルダーへのパスを指定します。
実行するテストを指定します。これは、特定のテストまたはスイート、テストファイル全体、テストファイルを含むフォルダーにすることができます。
必要に応じて、Karma に渡すコマンドラインオプションを指定して、karma.conf.js 構成ファイルのデフォルト設定を上書きします。
例: ヘッドレス Chrome でテストを実行またはデバッグするには、Karma オプションフィールドに
--browsers ChromeHeadless
と入力します。詳細については、「ヘッドレス Chrome による自動テスト(英語)」を参照してください。使用可能なすべての CLI オプションを表示するには、ターミナル Alt+F12 に
karma start --help
と入力します。
実行構成を介してテストを実行する
構成のリストから Karma 実行 / デバッグ構成を選択し、リストまたはツールバーの
をクリックします。
実行ツールウィンドウのテストランナータブで、テストの実行を監視し、テスト結果を分析します。詳細については、テスト結果を調べるを参照してください。
失敗したテストの再実行
テスト結果ツールバーの
をクリックします。WebStorm は、前回のセッション中に失敗したすべてのテストを実行します。
特定の失敗したテストを再実行するには、そのコンテキストメニューで
を選択します。前回のセッションからすべてのテストを再実行するには、テスト結果ツールバーの
をクリックするか、Ctrl+F5 を押します。
関連するソースコードを変更した後にテストを自動的に再実行するには、テスト結果ツールバーの
を押します。
詳細は、テストの再実行を参照してください。
ナビゲーション
WebStorm を使用すると、ファイルと関連テストファイルの間、またはテストランナータブのテスト結果からテストに移動できます。
テストとそのサブジェクト間、またはその逆に移動するには、エディターでファイルを開き、コンテキストメニューから
または を選択するか、Ctrl+Shift+T を押します。テスト結果からテスト定義に移動するには、「テストランナー」タブでテスト名を 2 回クリックするか、コンテキストメニューから「 」を選択するか、単に F4 を押します。テストファイルがエディターで開き、テスト定義にキャレットが置かれます。
失敗したテストの場合、WebStorm はスタックトレースからテストの失敗ラインに移動します。正確な行がスタックトレースにない場合は、テスト定義に移動します。
デバッグテスト
WebStorm を使用すると、エディターから Karma テストのデバッグをすぐに開始することも、テストの一部または全部をデバッグするための実行 / デバッグ構成を作成することもできます。
エディターから単一のテストのデバッグを開始する
テスト中のブレークポイントを設定します。
ガターで
または
をクリックし、リストからデバッグ <テスト名> を選択します。
実行 / デバッグ構成を介してテストデバッグを起動する
必要に応じてブレークポイントの設定。
上記のように Karma 実行 / デバッグ構成を作成します。
構成のリストから Karma 実行 / デバッグ構成を選択し、リストまたはツールバーの
をクリックします。
開いたデバッグツールウィンドウで、通常どおりに進めます。プログラムをステップ実行し、プログラムの実行を停止および再開し、中断されたときにそれを調べ、コールスタックと変数を調べ、ウォッチを設定し、変数を評価し、実際の HTML DOM を表示するなどします。
コードカバレッジを監視する
WebStorm を使用すると、Karma テストでカバーされている(英語)コードの量を監視することもできます。WebStorm は、専用のカバレッジツールウィンドウにこの統計を表示し、カバーされた行とカバーされていない行をエディターとプロジェクトツールウィンドウ Alt+1 に視覚的にマークします。カバレッジを監視するには、karma-coverage パッケージをインストールし、karma.conf.js を更新する必要があります。
カルマカバレッジをインストールする
埋め込まれたターミナル(Alt+F12)で、次のように入力します。
npm install --save-dev karma-coverage
Karma-coverage 定義を構成ファイルに追加する
エディターで karma.conf.js を開きます。
reporters
定義を見つけ、coverage
を次の形式の値のリストに追加します。reporters: ['progress', 'coverage']preprocessors
定義を追加し、カバレッジスコープを次の形式で指定します。preprocessors: {'**/*.js': ['coverage']}
カバレッジ付きでテストを開始する
上記のように Karma 実行 / デバッグ構成を作成します。
構成のリストから Karma 実行 / デバッグ構成を選択し、リストまたはツールバーの
をクリックします。
または、エディターのテストアイコンを使用して、特定のスイートまたはカバレッジ付きのテストをすばやく実行します。
カバレッジツールウィンドウでコードカバレッジを監視します。
Karma テストが実行されるたびに、カバレッジレポートが実際にディスク上に生成されます。カバレッジレポートの形式は、次のように設定ファイルで設定できます。
// karma.conf.js module.exports = function(config) { config.set({ ... // optionally, configure the reporter coverageReporter: { type : 'html', dir : 'coverage/' } ... });};次の
type
値を使用できます。html
はアノテーション付きソースコードを含む一連の HTML ファイルを生成します。lcovonly
は lcov.info ファイルを作成します。lcov
は HTML + .lcov ファイルを生成します。このフォーマットはデフォルトで適用されます。cobertura
は、Hudson と簡単に統合するための cobertura-coverage.xml ファイルを生成します。text-summary
は、通常はコンソールに、カバレッジの簡潔なテキスト要約を生成します。text
は、すべてのファイルのカバレッジを持つ詳細なテキストテーブルを生成します。
関連ページ:

プラグインのインストール
プラグインは WebStorm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。デフォルトでは、WebStorm には多数のプラグインがバンドルされています。バンドルされたプラグインを無効にするこ...

実行 / デバッグ構成ダイアログ
このダイアログを使用して、実行 / デバッグ構成を作成、編集、調整、削除したり、新しく作成されたすべての実行 / デバッグ構成に適用されるデフォルトのテンプレートを構成したりします。既存の実行 / デバッグ構成は、構成タイプごとにグループ化されています。新しい構成を作成するためのテンプレートは編集可能であり、ダイアログの左側のペインにある構成テンプレートの編集リンクから利用できます。共通設定:実行構成を編集するとき(ただし実行構成テンプレートは編集しないとき)、次のオプションを指定できます。名...

実行 / デバッグ構成: Karma
作成: このページでは、構成固有の項目と、すべての実行 / デバッグ構成に共通のオプションについて説明します。この構成の使用方法の詳細については、「Karma」を参照してください。このダイアログで、Karma テストランナーを使用して JavaScript 単体テストを実行およびデバッグするための設定を作成します。始める前に:Node.js をダウンロードしてインストールします。Karma の説明に従って、Karma テストランナーをインストールします。Karma 固有の構成設定:構成ファイルこのフ...

リモート 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 をインストール...

実行 / デバッグ構成: Node.js
作成: 次の Node.js バージョンは、WebStorm 2023.3 以降でサポートされています。Node.js 20 - アクティブな長期サポート (LTS) バージョン、Node.js 21 - 現在のバージョン、サポートされている Node.js バージョンの詳細を参照してください。このページでは、構成固有の項目と、すべての実行 / デバッグ構成に共通のオプションについて説明します。この構成の使用方法の詳細については、「Node.js の実行とデバッグ」を参照してください。このダイアロ...