PyCharm 2026.1 Help

Vitest

PyCharm は、 VitestVite ネイティブのユニットテストフレームワークと統合されます。 実行、デバッグ、スナップショットテストの実行、およびエディターと実行 / デバッグ構成の両方からのテストカバレッジの測定を行うことができます。

失敗したテストを再実行するか、 ウォッチモードを有効にできます。 このモードでテストセッションを開始すると、PyCharm はプロジェクトのソースコードの変更を監視します。 テストまたはその対象に変更があると、PyCharm が影響を受けたテストを再実行します。実行 / デバッグ構成を再起動する必要はありません。

始める前

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

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

Vitest をインストールする

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

    npm install --save-dev vitest

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

テストの実行とデバッグ

PyCharm を使用すると、エディターから単一の Vitest テストを素早く実行またはデバッグしたり、実行 / デバッグ構成を作成してテストの一部またはすべてを実行またはデバッグしたりできます。

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

エディターから単一のテストを実行またはデバッグする

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

    エディターから 1 つの Vitest テストを実行する

    実行 ツールウィンドウでテストの実行結果を確認します。 失敗したテストについては、エラーが発生した場所と原因に関する情報が表示されます。

    詳細なエラー情報

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

    テスト用のガターのアイコン
  • テストをデバッグするには、テスト内に ブレークポイントを設定し 、ガターで 実行アイコン または 再実行アイコン をクリックし、リストから デバッグ <test_name> を選択します。

    エディターから 1 つの Vitest テストをデバッグする

    デバッグ ツールウィンドウで、 中断されたテストを調べ、 ステップ実行します

    Vitest デバッグセッション

Vitest 実行構成を作成する

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

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

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

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

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

  3. vitest パッケージの場所を指定します。

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

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

  6. デフォルトでは、 vite.config.ts が使用されます。 vite.config.ts が存在しない場合、またはカスタム構成を使用する場合は、使用する vitest.config.ts を指定します。 詳細については、 Vitest オフィシャル Web サイト(英語)を参照してください。

  7. オプション:

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

    他の Vitest オプションを追加することもできます。 詳細については、 Vitest オフィシャル Web サイト(英語)を参照してください。

  8. オプション:

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

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

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

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

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

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

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

    テストをデバッグするには、必要に応じて ブレークポイントを設定し 、実行 / デバッグ構成を選択して、 the Debug button をクリックします。

    Vitest: テスト結果

テストの再実行

指定したスコープ Alt+Shift+R 内のすべてのテストを再実行するか、失敗したテストのみを再実行できます。

--watch モード(英語)でテストを起動することもできます。 このモードでは、PyCharm がテストおよび関連するテスト対象に保存された変更を監視します。 変更が検出されるとすぐに、PyCharm は現在のテストセッションを停止せずに、影響を受けたテストを再実行します。

失敗したテストの再実行

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

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

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

更新されたテストを自動的に再実行する (--watch モード)

  1. Vitest 実行 / デバッグ構成を開くか、 上記のように新しい構成を作成します。

  2. Vitest オプション フィールドに --watch と入力します。 自動生成された すべてのテスト 構成では、 --watch オプションがすでに指定されています。

  3. 実行 / デバッグ構成を起動します。 一部のテストが失敗した場合、テストセッションを停止することなく、それらのテストまたは関連するテストサブジェクトを更新できます。 変更が保存されるとすぐに、PyCharm はそれらを検出し、影響を受けたテストを再実行します。

    以下の例では、 vue.test.ts 29 行でのテストが失敗します。 --watch オプションを使うと、 vue.test.ts '4 x 4 = 18''4 x 4 = 16' に置き換えた後、 Ctrl+S で変更を保存するか PyCharm からフォーカスを移すと、テストが再実行されます。

    Rerun updated test in the --watch mode

スナップショットテスト

PyCharm は Vitest スナップショットテスト もサポートします。 PyCharm が初めて toMatchSnapshot() メソッドでテストを実行すると、スナップショットファイルが作成され、 toMatchSnapshot () のガターに スナップショット アイコンが表示されます。 スナップショットアイコン をクリックして、生成されたスナップショットを開きます。

スナップショット

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

PyCharm を使うことで、コードがどの程度 Vitest テストでカバーされているかも監視できます。 PyCharm は、この統計情報を専用の カバレッジ ツールウィンドウに表示し、カバーされた行とカバーされていない行をエディターおよび Project ツールウィンドウ(Alt+1 )で視覚的にマークします。

Vitest カバレッジレポート

Vitest のコードカバレッジを有効にする

@vitest/ カバレッジ v8(英語) または istanbul(英語) をインストールします。 これを行うには、組み込みの ターミナル Alt+F12 を開き、次のいずれかを入力します。

  • npm install --save-dev @vitest/coverage-v8

  • npm install --save-dev @vitest/coverage-istanbul

Vitest 公式 Web サイトで カバレッジ(英語)の詳細を参照してください。

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

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

    エディターからのカバレッジで Vitest テストを実行する

    あるいは:

    上記の説明に従って、Vitest 実行 / デバッグ構成を作成します。 メインツールバーのリストから Vitest 実行 / デバッグ構成を選択し、リストの右側にある カバレッジ付き実行アイコン をクリックします。

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

2026 年 6 月 1 日