PyCharm 2024.3 ヘルプ

実行 / デバッグ構成: Node.js

作成: 実行 | 実行構成の編集 | Add New Configuration | Node.js

次の Node.js バージョンは、PyCharm 2023.3 以降でサポートされています。

  • Node.js 20 - アクティブな長期サポート (LTS) バージョン

  • Node.js 21 - 現在のバージョン

サポートされている Node.js バージョンの詳細を参照してください。

このダイアログで、コンピューター上の Node.js アプリケーションと一緒にデバッガーを開始するための構成を作成します。

始める前に

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

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

構成タブ

項目

説明

Node インタープリター

このフィールドに、使用する Node.js インタープリターを指定します。これはローカルまたはリモート Node.js インタープリターまたは Windows Subsystem for Linux の Node.js です。リストからインタープリターを選択するか、the Browse button をクリックして表示されるダイアログで新しいインタープリターを設定します。

Node パラメーター

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

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

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

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

完全なリストについては、Node.js コマンドラインオプション(英語)を参照してください。

作業ディレクトリ

このフィールドでは、アプリケーションの作業ディレクトリ(英語)を指定します。デフォルトでは、フィールドにはプロジェクトのルートフォルダーが表示されます

JavaScript ファイル

このフィールドには、それを開始するアプリケーションのメインファイルへのパスを指定します(たとえば、Express(英語) アプリケーションの場合は bin/www)。

CoffeeScript をデバッグする場合は、ソースマップを含む生成された JavaScript ファイルへのパスを指定します。ファイルは外部で生成することも、ファイルウォッチャーを使用したコンパイルを通じて生成することもできます。詳細については、CoffeeScript のデバッグを参照してください。

アプリケーションパラメーター

このフィールドに、起動時に process.argv(英語) 配列を介してアプリケーションに渡される Node.js 固有の引数を入力します。

環境変数

このフィールドで、必要に応じて Node.js 実行可能ファイルの環境変数(英語)を指定します。フィールドの右側にある参照 the Browse button をクリックし、環境変数ダイアログで変数のリストを構成します。次のように開きます。

  • 新しい変数を定義するには、the Add button をクリックして、変数の名前と値を指定します。

  • 変数定義を破棄するには、リストでそれを選択して the Remove button をクリックします。

  • 準備ができたら、OK をクリック

変数の定義は、環境変数読み取り専用フィールドにセミコロンを区切り文字として表示されます。例:

  • NODE_PATH : モジュール検索パスの前に付いたディレクトリの : -separated リスト。

  • NODE_MODULE_CONTEXTS : 独自のグローバルコンテキストでモジュールをロードするには 1 に設定します。

  • NODE_DISABLE_COLORS : REPL の色を無効にするには 1 に設定します。

Docker コンテナーの設定

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

Node.js with Docker: run/debug configuration, Docker container settings

Docker Compose

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

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

ブラウザー / ライブ編集タブ

このタブで、ブラウザーの動作を設定し、アプリケーションのクライアント側コードのデバッグを有効にします。この機能は JavaScript Debug 実行構成によって提供されるため、技術的には、PyCharm はサーバー側とクライアント側のコードに対して別々の実行構成を作成しますが、すべての設定を 1 つの専用 Node.js 実行構成で指定します。

項目

説明

ブラウザーを開く

この領域のフィールドに、プロジェクトの HTML ファイルを指定して、内蔵 Web サーバーで起動するプロジェクトルートに従ってこのファイルへの正しい URL を作成します。例: project_root/inner_folder/index.html を選択した場合、結果の URL は http://localhost:63342/project_root/inner_folder/index.html になります。起動後チェックボックスを選択すると、ブラウザーはアプリケーションの起動後にこのページを自動的に開きます。別の方法として、手動で選択のブラウザーでこの URL アドレスでページを開くことによって同じ結果を見ることができます。

起動後

このチェックボックスを選択すると、ブラウザーが自動的に開きます。リストから使用するブラウザーを選択します。

  • システムデフォルトブラウザーを使用するには、デフォルトを選択します。

  • カスタムブラウザーを使用するには、リストからブラウザーを選択します。JavaScript クライアント側コードのデバッグは、Google Chrome(英語) およびその他の Chromium ベースのブラウザー(英語)でのみサポートされていることに注意してください。

  • ブラウザーを構成するには、the Browse button をクリックし、表示されるウェブブラウザーとプレビューダイアログで設定を調整します。詳細については、「ブラウザーの構成」を参照してください。

JavaScript デバッガーを使用する

選択したブラウザーでクライアントサイドコードのデバッグを有効にするには、このチェックボックスをオンにします。

V8 プロファイリングタブ

このタブで V8 CPU とメモリのプロファイリングを有効にします。

項目

説明

CPU プロファイリング情報を記録する

アプリケーションの起動時に CPU プロファイリングデータの記録を開始するには、このチェックボックスをオンにします。下の領域のコントロールが有効になります。以下を指定してください。

  • ログフォルダー : このフィールドでは、記録されたログを保存するフォルダーを指定します。プロファイリングデータはログファイル isolate-<session number> に保存されます。

  • すべての Isolate (V8 インスタンス) に対して 1 つのログファイルを作成する : すべての V8 インスタンスに対して 1 つのログファイル (およびそれに応じて 1 つのプロファイリング結果ビュー) のみを作成するには、このチェックボックスをオンにします。インスタンスごとに個別のファイルを作成するには、チェックボックスをオフにします。Node.js は、デバッグプロセスなどのために追加の V8 インスタンスを作成できます。

ヒープスナップショットの取得を許可する

メモリプロファイリングを実行する場合は、このチェックボックスを選択してください。

ログタブ

このタブでは、実行ツールウィンドウのコンソールタブに morgan(英語) などのログツールによって生成された情報の表示を有効にします。詳細については、Node.js アプリの実行時にログを管理するを参照してください。

共通設定

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

項目

説明

名前

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

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

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

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

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

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

デフォルトでは無効になっており、PyCharm は実行構成設定を .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 つまたは複数のアプリケーションを選択します。PyCharm でまだ定義されていない場合は、定義を追加します。詳細については、「外部ツールおよび外部ツール」を参照してください。

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

  • ファイル監視の実行 : PyCharm に現在アクティブなすべての 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 を押すことにより、構成に対応するツールウィンドウを自分で開くことができます。

関連ページ:

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

プラグインは PyCharm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケット...

サポートされている Node.js バージョン

このページには、アプリケーション開発のために PyCharm でサポートされているすべての Node.js バージョンが一覧表示されます。Node.js 公式 Web サイトでのリリースのステータスに関する情報を使用して、Node.js のリリーススケジュールを見つけます。次の Node.js バージョンは、PyCharm 2023.3 以降でサポートされています。Node.js 20 - アクティブな長期サポート (LTS) バージョン、Node.js 21 - 現在のバージョン、Node.j...

Node.js

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

CoffeeScript

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

Node.js と Docker

Docker を使用すると、Node.js アプリケーションをすばやくブートストラップして、PyCharm から実行、デバッグ、プロファイリングできます。IDE は、新しい Dockerfile を自動的に作成し、イメージをビルドして実行し、ソースコードを同期し、コンテナーに npm 依存関係をインストールすることにより、初期構成を処理します。WebStorm と Docker のクイックツアーでいくつかの例を見つけることができます。始める前に:設定 | プラグインページのインストール済みタブで、J...

V8 CPU とメモリのプロファイリング

PyCharm を使用すると、V8 のサンプルベースのプロファイラーを使用して Node.js アプリケーションの CPU プロファイルとヒープスナップショットをキャプチャーして分析できます。Google Chrome DevTools でキャプチャーされたスナップショットを開いて、クライアント側のコード用に探索することもできます。始める前に:設定で Node.js プラグインが有効になっていることを確認します。を押して設定を開き、を選択します。インストール済みタブをクリックします。検索フィールドに...