PhpStorm 2020.2 ヘルプ

Karma

Karma(英語) はクライアントサイドの JavaScript をテストするためのツールです。Karma は、実際のブラウザで実行されているアプリケーションに対してテストを実行します。これにより、テスト結果の正確性と信頼性が保証されます。PhpStorm は Karma と統合されているため、IDE 内部からテストの実行範囲を実行、デバッグ、および監視できます。テスト結果はツリービューで表示され、そこからテストソースに簡単に移動できます。テストステータスはエディターのテストの横に表示され、すばやく実行またはデバッグすることができます。

始める前に

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

  2. JetBrains リポジトリからプラグインをインストールする説明に従って、設定 / 環境設定 | プラグインページで Karma プラグインをインストールして有効にします。

Karma とプラグインのインストール

  • 埋め込まれたターミナルAlt+F12)で、次のいずれかのコマンドを入力します。

    • Karma および必要なすべてのプラグインが package.json ですでに定義されている場合は、npm install

    • Karma と必要なプラグイン(たとえば karma-jasmine または jasmine-core)を開発依存関係(英語)としてインストールするには:

      npm install --save-dev karma npm install --save-dev <required_karma_plugin> <another_required_karma_plugin>

    Karma オフィシャル Web サイト(英語)の詳細を参照してください。

npm、pnpm、および Yarn に従って、Node.js と NPM ページkarma パッケージをインストールすることもできます。

Karma 構成ファイルの生成

Karma テストは、対話モードで生成された karma.conf.js 構成ファイルに従って実行されます。既にプロジェクトに karma.conf.js がある場合は、この手順をスキップしてください。Karma の設定の詳細については、Karma オフィシャル Web サイト(英語)を参照してください。

Karma 構成ファイルを作成するには

  1. ターミナルを開き、オペレーティングシステムに応じて次のいずれかを入力して karma.conf.js 生成ウィザードを開始します。

    • macOS および Linux の場合:
      ./node_modules/karma/bin/karma init

    • Windows の場合:
      npm install -g karma-cli
      karma init

  2. ウィザードの質問に答えて、使用するテストフレームワークと自動的にキャプチャーされるブラウザを指定します。

    Karma ファイル : パターンマッチング(英語)も参照してください。

テストの実行

PhpStorm を使用すると、Karma テストをエディターから簡単に実行したり、実行 / デバッグ構成を作成してテストの一部または全部を実行することができます。

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

  • 左側のガターのthe Run buttonまたはthe Rerun buttonをクリックして、リストから実行 <テスト名> を選択します。

    ガターのテストステータスアイコンTest passedおよびTest failedにより、エディターでテストが成功したか失敗したかを確認することもできます。

Karma 実行構成を作成するには

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

  2. 使用する Node.js インタープリターを指定してください。これはローカル Node.js インタープリターまたは Windows Subsystem for Linux の Node.js です。

    オプションで、Node.js に渡す Node.js 固有のオプションパラメーター環境変数(英語)を指定します。

  3. karma パッケージの場所と karma.conf.js へのパスを指定します。

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

  5. 必要に応じて、Karma に渡すコマンドラインオプションを指定して、karma.conf.js 構成ファイルのデフォルト設定を上書きします。

    例:Headless Chrome でテストを実行またはデバッグするには、Karma オプションフィールドに --browsers ChromeHeadless と入力します。詳細はヘッドレス Chrome による自動テスト(英語)を参照してください。

    利用可能な CLI オプションをすべて表示するには、ターミナルAlt+F12)に karma start --help と入力します。

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

  1. メインツールバーのリストから Karma 実行 / デバッグ構成を選択し、リストの右側にあるthe Run iconをクリックします。

    ws_select_run_configuration_karma.png

  2. Karma テストサーバーは自動的に起動します。実行ツールウィンドウの Karma サーバータブで、テストサーバーからのメッセージを表示および分析します。

  3. 実行ツールウィンドウのテストランナータブのテスト実行の監視

失敗したテストを再実行する

  • テストランナータブで、ツールバーのRerun Failed Tests buttonをクリックします。PhpStorm は前のセッションで失敗したすべてのテストを実行します。

    Rerun a failed Karma test

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

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

ナビゲーション

PhpStorm を使用すると、ファイルと関連テストファイルの間、またはテストランナータブのテスト結果からテストにジャンプできます。

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

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

  • 失敗したテストの場合、PhpStorm はスタックトレースからテストの失敗ラインに移動します。正確な行がスタックトレースにない場合は、テスト定義に移動します。

デバッグテスト

PhpStorm を使用すると、エディターから Karma テストのデバッグをすぐに開始することも、テストの一部または全部をデバッグするための実行 / デバッグ構成を作成することもできます。

エディターから単一のテストのデバッグを開始するには

  • 左側のガターのthe Run buttonまたはthe Rerun buttonをクリックして、リストからデバッグ <テスト名> を選択します。

実行 / デバッグ構成を介してテストデバッグを開始するには

  1. 上記の説明に従って、Karma 実行 / デバッグ構成を作成します。

  2. メインツールバーのリストから Karma 実行 / デバッグ構成を選択し、リストの右側にあるthe Debug iconをクリックします。

    ws_select_run_configuration_karma.png

  3. 開いたデバッグツールウィンドウで、通常どおり続行します。テストのステップ実行、テストの実行の一時停止と再開一時停止 時のテストの確認など。

コードカバレッジの監視

PhpStorm を使用すると、Karma テストでカバーされる(英語)コードの量を監視することもできます。PhpStorm は、この統計を専用のツールウィンドウに表示し、カバーされた行とカバーされていない行をエディターで視覚的にマークします。カバレッジを監視するには、karma-coverage パッケージをインストールして karma.conf.js を更新する必要があります。

karma-coverage をインストールするには

  • 埋め込まれたターミナルAlt+F12)で、次のように入力します。

    npm install --save-dev karma-coverage

karma-coverage 定義を構成ファイルに追加するには

  1. エディターで karma.conf.js を開きます。

  2. reporters 定義を見つけ、coverage を次の形式の値のリストに追加します。

    reporters: ['progress', 'coverage']

  3. preprocessors 定義を追加し、カバレッジスコープを次の形式で指定します。

    preprocessors: {'**/*.js': ['coverage']}

カバレッジでテストを開始する

  1. 上記の説明に従って、Karma 実行 / デバッグ構成を作成します。

  2. メインツールバーのリストから Karma 実行 / デバッグ構成を選択し、リストの右側にあるthe Run with Coverage iconをクリックします。

    ws_select_run_configuration_karma.png

    または、エディターのテストアイコンを使用して、特定のスイートまたはカバレッジ付きのテストをすばやく実行します。

    ws_mocha_quickly-run-with-coverage.png
  3. カバレッジツールウィンドウでコードカバレッジを監視します。

    Karma テストが実行されるたびに、カバレッジレポートが実際にディスク上に生成されます。カバレッジレポートの形式は、次のように設定ファイルで設定できます。

    // karma.conf.js module.exports = function(config) { config.set({ ... // optionally, configure the reporter coverageReporter: { type : 'html', dir : 'coverage/' } ... });};

    次の type 値を使用できます。

    • html は注釈付きソースコードを含む一連の HTML ファイルを生成します。

    • lcovonlylcov.info ファイルを生成します。

    • lcov は HTML + .lcov ファイルを生成します。このフォーマットはデフォルトで適用されます。

    • cobertura は、Hudson を簡単に統合するための cobertura-coverage.xml ファイルを生成します。

    • text-summary は、通常はコンソールに、カバレッジの簡潔なテキスト要約を生成します。

    • text は、すべてのファイルのカバレッジを持つ詳細なテキストテーブルを生成します。

最終更新日 :

関連ページ:

プラグインを管理する

プラグインは PhpStorm のコア機能を拡張します。彼ら:バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざまな言語とフレームワークのコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどで生産性を向上、...

npm、pnpm、および Yarn

PhpStorm はnpm、Yarn、Yarn 2、およびpnpmと統合されているため、IDE 内から再利用可能なコードのパッケージをインストール、検索、更新、削除できます。Node.js と NPM ページは、パッケージを管理するための専用 UI を提供します。もちろん、組み込みのターミナルのコマ...

Node.js および NPM

Windows および Linux 用のファイル | 設定 | 言語およびフレームワーク | Node.js および NPMmacOSのPhpStorm | 環境設定 | 言語およびフレームワーク | Node.js および NPMこのページは、JetBrains リポジト...

実行 / デバッグ構成ダイアログ

実行 | 構成の編集このダイアログを使用して、実行 / デバッグ構成を作成、編集、調整、または削除したり、新しく作成されたすべての実行 / デバッグ構成に適用されるデフォルトのテンプレートを構成したりします。プロジェクト構成は構成タイプによってグループ化されています。デフォルトの構成テンプレート...

Node.js

Node.jsは、ブラウザの外部、たとえばサーバーやコマンドラインで JavaScript を実行するための軽量なランタイム環境です。PhpStorm は Node.js と統合し、アプリケーションの構成、編集、実行、デバッグ、テスト、プロファイリング、およびメンテナンスを支援します。アプリケーショ...

テストランナータブ

テストランナータブは、テストセッションの開始時に実行ツールウィンドウで開き、同じツールバーボタンを備えています。実行ツールバーは、実行ツールウィンドウのツールバーとほとんど同じですが、テスト固有のボタンを備えています。左側のペインには、現在の実行 / デバッグ構成内のすべてのテストのツリービューが表...