リモート Node.js ランタイムの構成
PhpStorm では、リモートホストまたは仮想環境にインストールされた Node.js 上でアプリケーションを開発、テスト、リント、実行、デバッグする場合、リモート Node.js ランタイムを構成する必要があります。
リモート Node.js ランタイムは、 Node.js リモートランタイムを構成する ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイムページから、またはそれ以降に、リモート環境でアプリケーションを実行またはデバッグするための Node.js 実行 / デバッグ構成を作成または編集するときに開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
SSH 接続経由でアクセス可能なホスト上のリモート Node.js ランタイム
始める前に
JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの Marketplace タブに Node.js リモートインタープリタープラグインをインストールして有効にします。
設定で FTP/SFTP/WebDAV 接続プラグインが有効になっていることを確認します。 Ctrl+Alt+S を押して設定を開き、 を選択します。 インストール済み タブをクリックします。 検索フィールドに FTP/SFTP/WebDAV 接続と入力します。 プラグインの詳細については、 プラグイン管理を参照してください。
SSHサーバーへのアクセスをターゲットリモートホストで SSH 設定の作成に従って構成し、このサーバーが稼働していることを確認してください。
SSH 経由の Node.js ランタイムは、 Node.js リモートランタイムを構成する ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイムページから、またはそれ以降にアプリケーションの実行またはデバッグのために Node.js の実行 / デバッグ構成を作成または編集するを実行する際に開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
設定で SSH 経由でリモート Node.js ランタイムを構成するダイアログ
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
ノードランタイム フィールドの横にある
をクリックします。
現在構成されているすべてのランタイムのリストが表示されている Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。
開いた Node.js リモートランタイムを構成するダイアログで、 SSH を選択します。
使用する SSH 構成を選択してください。
または、
をクリックし、 SSH 構成の作成の説明に従って新しい SSH 構成を作成してください。OK をクリックすると、新しいランタイムがリストに追加される Node.js ランタイム ダイアログに戻ります。
新しく構成されたランタイムをプロジェクトのデフォルトとして設定するには、リストでそれを選択し、 OK をクリックして JavaScript ランタイム ダイアログに戻ります。
PhpStorm では、たとえば実行 / デバッグ構成を作成する際など、 ノードランタイム リストから
プロジェクトエイリアスを選択するたびにこのインタープリターが自動的に使用されます。新しいランタイムに関連付けられたパッケージマネージャーをプロジェクトの依存関係の管理に使用するには、このパッケージマネージャーをプロジェクトのデフォルトとして設定します。 そのためには、 パッケージマネージャー フィールドにパッケージマネージャーの場所を指定します。
npm 実行可能ファイルのデフォルトの場所は
/usr/local/lib/node_modules/npmです。
実行 / デバッグ構成で SSH 経由でリモート Node.js ランタイムを構成する
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。 「実行 / デバッグ構成: Node.js 」ダイアログが開きます。ノードランタイム フィールドの横にある
をクリックします。
Node.js ランタイムダイアログが開きます。
ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。
上記の説明に従って、 SSH 経由でリモート Node.js ランタイムを構成します。
Docker コンテナー内のリモート Node.js ランタイム
始める前に
JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの Marketplace タブに Node.js リモートインタープリタープラグインをインストールして有効にします。
設定 | プラグイン ページ、 インストール済み タブで、 Node.js および Docker の必要なプラグインが有効になっていることを確認してください。 詳細については、 プラグインの管理を参照してください。
Docker に記載されている手順に従って、 Docker をダウンロード、インストール、設定してください。
Docker の Node.js ランタイムは、 Node.js リモートランタイムを構成する ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイム ページから、または Docker でアプリケーションを実行またはデバッグするために Node.js 実行/デバッグ構成を作成または編集する際に開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。 これにより、Docker で設定された Node.js ランタイムを使用してアプリを実行およびデバッグできるだけでなく、プロジェクトの依存関係の管理、テストの実行、コードのリンティングも実行できるようになります。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
設定で Node.js ランタイムを構成するダイアログ
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。開いた 実行/デバッグ構成: Node.jsダイアログで、 ノードランタイム フィールドの横にある
をクリックします。現在構成されているすべてのランタイムのリストが表示されている Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。開いた Node.js リモートランタイムを構成するダイアログで、 Docker オプションを選択します。
サーバー フィールドに、使用する Docker の設定を指定します。 詳細については、 Docker デーモンの接続設定を構成するを参照してください。 リストから構成を選択するか、 新規… をクリックして、開いた Docker ページ上に新しい構成を作成します。
イメージ名 フィールドで、使用するベース Docker イメージを指定します。 リストから以前にダウンロードしたイメージまたはカスタムイメージのいずれかを選択するか、
node:argonやmhart/alpine-nodeなどのイメージ名を手動で入力します。 後で実行構成を起動すると、Docker はマシン上で指定されたイメージを検索します。 検索が失敗した場合、イメージは Docker レジストリページの Docker 公式イメージ(英語)リポジトリからダウンロードされます。Node.js ランタイムパス フィールドには、指定されたイメージのデフォルトの Node.js ランタイムの場所が表示されます。
OK をクリックすると、PhpStorm は Node.js リモートインタープリターの構成 ダイアログを閉じ、新しいランタイム構成がリストに追加された Node.js ランタイム ダイアログに移動します。 OK をクリックして、実行構成に戻ります。
Node.js 実行 / デバッグ構成で Node.js ランタイムを構成する
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。 「実行 / デバッグ構成: Node.js 」ダイアログが開きます。ノードランタイム フィールドの横にある
をクリックします。 Node.js ランタイムダイアログが開きます。ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。
上記の説明に従って、リモート Node.js ランタイムを構成します。
Docker Compose 定義を持つ Docker コンテナーでリモート Node.js ランタイムを使用する
Docker Compose(英語) を使用すると、Node.js サーバーとアプリケーションコードを別々のサービスとして実行できます。 必要に応じてコンテナーを追加することで各サービスを拡張できます。 これにより、実稼働環境に似た動的環境で効率的な開発とテストを実行できます。
始める前に
JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの Marketplace タブに Node.js リモートインタープリタープラグインをインストールして有効にします。
設定 | プラグイン ページ、 インストール済み タブで、 Node.js および Docker の必要なプラグインが有効になっていることを確認してください。 詳細については、 プラグインの管理を参照してください。
Docker に記載されている手順に従って、 Docker をダウンロード、インストール、設定してください。
マルチコンテナー Docker アプリケーションの Node.js ランタイムは、 Node.js リモートランタイムを構成する ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイム ページから開くか、または Vagrant 環境でアプリケーションを実行またはデバッグするために Node.js の実行/デバッグ構成を作成または編集する際に開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。 これにより、Docker で設定された Node.js ランタイムを使用してアプリを実行およびデバッグできるだけでなく、プロジェクトの依存関係の管理、テストの実行、コードのリンティングも実行できるようになります。 以下の npm、pnpm、yarn と Docker、 アプリケーションをテストする、 Docker を使用した ESLint を参照してください。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
ノードランタイム フィールドの横にある
をクリックします。現在構成されているすべてのランタイムのリストが表示されている Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。開いた Node.js リモートランタイムを構成するダイアログで、 Docker Compose を選択します。
サーバー リストから、使用する Docker 構成を選択します。
または、フィールドの横にある 新規 をクリックし、 Docker サポートを有効にする説明に従って Docker サーバーを構成します。
構成ファイル フィールドで使用する docker-compose 設定ファイルを指定します。 閲覧 をクリックし、表示される Docker Compose 構成ファイル ダイアログで設定ファイルのリストを作成します。
サービス リストから、使用するサービスを選択します。
OK をクリックすると、新しいランタイムがリストに追加される Node.js ランタイム ダイアログに戻ります。 新しく構成されたランタイムをプロジェクトのデフォルトとして設定するには、リストでそのランタイムを選択し、 OK をクリックして JavaScript ランタイム ダイアログに戻ります。
PhpStorm では、たとえば実行 / デバッグ構成を作成する際など、 ノードランタイム リストから プロジェクト エイリアスを選択するたびにこのインタープリターが自動的に使用されます。
新しいランタイムに関連付けられたパッケージマネージャーをプロジェクトの依存関係の管理に使用するには、このパッケージマネージャーをプロジェクトのデフォルトとして設定します。 そのためには、 パッケージマネージャー フィールドにパッケージマネージャーの場所を指定します。 詳しくは プロジェクトでデフォルトの Node.js ランタイムとパッケージマネージャーを指定するを参照してください。
プロジェクト内のデフォルトの Node.js ランタイムとパッケージマネージャーを指定する
PhpStorm では、実行 / デバッグ構成作成時など、 ノードランタイム リストから プロジェクト エイリアスを選択するたびに、デフォルトのプロジェクトインタープリターが自動的に使用されます。
デフォルトのプロジェクトパッケージマネージャーは、依存関係を管理するために自動的に使用されます。たとえば、 package.json ファイルから <package manager> install を実行したり、ESLint、Prettier などのサードパーティ製ツールをインストールしたりします。
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
推奨ランタイム リストで Node.js が選択されていることを確認します。
ノードランタイム リストから、現在のプロジェクトでデフォルトで使用する構成を選択します。
パッケージマネージャー リストから、使用するパッケージマネージャーに関連付けられているエイリアスを選択します。 PhpStorm はその場所を自動的に検出します。
または、必要なパッケージマネージャーの場所を手動で指定してください。
npm 実行可能ファイルのデフォルトの場所は
/usr/local/lib/node_modules/npmです。pnpm のデフォルトの場所は、インストールメソッドによって異なります：
npm を介してインストールするための /usr/local/lib/node_modules/pnpm 。
カールを介してインストールするための /usr/local/pnpm-global/<version>/node_modules/pnpm （
curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm）。
詳細については、 pnpm 公式 Web サイト(英語)を参照してください。
ヤーンのデフォルトの場所は /opt/yarn-<version>5 で、たとえば /opt/yarn-v1.22.5 です。
Node.js 実行 / デバッグ構成で Docker Compose 定義を使用して Node.js ランタイムを構成する
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。 「実行 / デバッグ構成: Node.js 」ダイアログが開きます。ファイル フィールドで、それを開始するアプリケーションのメインファイルへのパスを指定します（たとえば、 Express(英語) アプリケーションの場合は bin/www ）。
必要に応じて、 Node.js アプリケーションの実行とデバッグで説明されているいくつかのオプション設定を指定します。
ノードランタイム リストから、Docker Compose 経由で関連するリモート Node.js ランタイムを選択します。
または、 ノードランタイム フィールドの横にある
をクリックします。 そして、 上記のようにリモート Node.js ランタイムを構成します。
Docker Compose エリアで、Docker Compose に渡すコマンドとオプションを指定します。 デフォルト設定を受け入れるか、
をクリックしてカスタム設定、例えば --rmや--service-portsなどのカスタム Docker Compose フラグを指定します。 詳細については、 Docker オフィシャル Web サイトを参照してください。コマンドプレビュー を確認してください。
Vagrant インスタンスの Node.js ランタイム
Vagrantを使用すると、Node.js アプリケーションをすばやくブートストラップして、PhpStorm から実行、デバッグ、プロファイリングできます。
始める前に
JetBrains マーケットプレイスからプラグインをインストールする説明に従って、 設定 | プラグイン ページの Marketplace タブに Node.js リモートインタープリタープラグインをインストールして有効にします。
Vagrant(英語) と Oracle の VirtualBox(英語) がコンピューターにダウンロード、インストール、構成されていることを確認してください。 詳細については、 Vagrant を参照してください。
次の実行可能ファイルの親フォルダーがシステム PATH 変数に追加されていることを確認します。
Vagrant から vagrant.bat または vagrant を選択してください。 これは、Vagrant インストーラによって自動的に実行されます。
Oracle VirtualBox インストールからの VBoxManage.exe または VBoxManage 。
Vagrant 環境の Node.js ランタイムは、 Node.js リモートランタイムを構成する ダイアログで設定します。 このダイアログは、 設定 ダイアログの JavaScript ランタイム ページから開くか、または Vagrant 環境でアプリケーションを実行またはデバッグするために Node.js の実行/デバッグ構成を作成または編集する際に開くことができます。
推奨される方法は、 設定 ダイアログでリモート Node.js ランタイムを設定することです。 この場合、ランタイムと関連するパッケージマネージャーをプロジェクトのデフォルトとして設定できます。
Node.js 実行 / デバッグ構成で直接構成したリモート Node.js ランタイムは、この実行 / デバッグ構成でのみ使用できます。
設定で Node.js ランタイムを構成するダイアログ
設定 ダイアログ（Ctrl+Alt+S ）を開き、 に進みます。
ノードランタイム フィールドの横にある
をクリックします。現在構成されているすべてのランタイムのリストが表示されている Node.js ランタイムダイアログで、ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。開いた Node.js リモートランタイムを構成するダイアログで、 Vagrant を選択します。
使用する環境を指す Vagrant インスタンスフォルダー を指定してください。
技術的には、これは目的の環境の VagrantFile 構成ファイルが配置されているフォルダーです。 この設定に基づき、PhpStorm は Vagrant ホスト を検出し、 Vagrant ホスト URL 読み取り専用フィールドにリンクとして表示します。
デフォルトでは、フィールドには現在のプロジェクトフォルダーが表示されます。
Node.js ランタイムパス フィールドで、Node.js 実行可能ファイルの場所を指定します。
Node.js 実行可能ファイルを見つけるには、埋め込み ターミナル （Alt+F12 ）を開いて次のように入力します。
vagrant ssh whereis node exit
OK をクリックすると、新しいランタイムがリストに追加される Node.js ランタイム ダイアログに戻ります。
新しく構成されたランタイムをプロジェクトのデフォルトとして設定するには、リストでそれを選択し、 OK をクリックして JavaScript ランタイム ダイアログに戻ります。
PhpStorm では、たとえば実行 / デバッグ構成を作成する際など、 ノードランタイム リストから
プロジェクトエイリアスを選択するたびにこのインタープリターが自動的に使用されます。使用するパッケージマネージャーへのパスを指定します。
パッケージマネージャーを見つけるには、組み込み ターミナル （Alt+F12 ）を開いて次のように入力します。
vagrant ssh whereis <package manager> exit
Node.js 実行 / デバッグ構成で Node.js ランタイムを構成する
に進みます。 開いた 構成の編集 ダイアログで、ツールバーの
をクリックし、コンテキストメニューから Node.js を選択します。 「実行 / デバッグ構成: Node.js 」ダイアログが開きます。ノードランタイム フィールドの横にある
をクリックします。 Node.js ランタイムダイアログが開きます。ツールバーの
をクリックし、コンテキストメニューから リモートの追加 を選択します。上記の説明に従って、 Vagrant 環境でリモート Node.js ランタイムを構成します。