リモート Node.js インタープリターの構成

IntelliJ IDEA では、リモートホストまたは仮想環境にインストールされた Node.js でアプリケーションを開発、テスト、リント、実行、デバッグするときに、リモート Node.js インタープリターを構成する必要があります。

リモート Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで構成されます。このダイアログは、リモート環境でアプリケーションを実行またはデバッグするための Node.js 実行 / デバッグ構成を作成または編集するときに、設定ダイアログの Node.js ページ以降から開くことができます。

推奨される方法は、設定ダイアログでリモート Node.js インタープリターを構成することです。この場合、プロジェクトのデフォルトとしてインタープリターと関連するパッケージマネージャーを設定できます。

Node.js の実行 / デバッグ構成で直接構成するリモート Node.js インタープリターは、この実行 / デバッグ構成でのみ使用できます。

SSH 接続を介してアクセス可能なホスト上のリモート Node.js インタープリター

始める前に

JetBrains マーケットプレイスからプラグインをインストールする説明に従って、Node.js および Node.js リモートインタープリタープラグインを設定 | プラグインページのマーケットプレースタブにインストールします。
設定で FTP/SFTP/WebDAV 接続プラグインが有効になっていることを確認します。Ctrl+Alt+S を押して設定を開き、プラグインを選択します。インストール済みタブをクリックします。検索フィールドに FTP/SFTP/WebDAV 接続と入力します。プラグインの詳細については、プラグインのマッピングを参照してください。
SSH 構成を作成する説明に従って、ターゲットリモートホスト上の SSH サーバーへのアクセスを構成し、このサーバーが実行されていることを確認します。

SSH 経由の Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで構成されます。このダイアログは、Node.js の実行 / デバッグ構成を作成または編集するを使用してアプリケーションを実行またはデバッグするときに、設定ダイアログの Node.js ページ以降から開くことができます。

Node.js の実行 / デバッグ構成で直接構成するリモート Node.js インタープリターは、この実行 / デバッグ構成でのみ使用できます。

設定で SSH 経由でリモート Node.js インタープリターを構成するダイアログ

設定ダイアログ（Ctrl+Alt+S）を開き、言語 & フレームワーク | Node.js に移動します。
Node インタープリターフィールドの横にあるをクリックします。
現在構成されているすべてのインタープリターのリストが表示された Node.js インタープリターダイアログで、ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
開いた Node.js リモートインタープリターの構成ダイアログで、SSH を選択します。
使用する SSH 構成を選択します。
または、をクリックして、SSH 構成を作成する説明に従って新しい SSH 構成を作成します。
OK をクリックして、新しいインタープリターがリストに追加される Node.js インタープリターダイアログに戻ります。
新しく構成されたインタープリターをプロジェクトのデフォルトとして設定するには、リストでインタープリターを選択し、OK をクリックして Node.js ダイアログに戻ります。
IntelliJ IDEA は、たとえば実行 / デバッグ構成を作成するときに、Node インタープリターリストから Project エイリアスを選択するたびに、このインタープリターを自動的に使用します。
新しいインタープリターに関連付けられたパッケージマネージャーを使用してプロジェクトの依存関係を管理するには、このパッケージマネージャーをプロジェクトのデフォルトとして設定します。これを行うには、パッケージマネージャーフィールドでパッケージマネージャーの場所を指定します。
npm 実行可能ファイルのデフォルトの場所は /usr/local/lib/node_modules/npm です。

実行 / デバッグ構成で SSH 経由でリモート Node.js インタープリターを構成する

実行 | 実行構成の編集に進みます。開いた構成の編集ダイアログで、ツールバーのをクリックし、コンテキストメニューから Node.js を選択します。「実行 / デバッグ構成: Node.js」ダイアログが開きます。
Node インタープリターフィールドの横にあるをクリックします。
Node.js インタープリターダイアログが開きます。
ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
上記のように、 SSH 経由でリモート Node.js インタープリターを構成します。

Docker コンテナー内のリモート Node.js インタープリター

始める前に

JetBrains マーケットプレイスからプラグインをインストールする説明に従って、設定 | プラグインページのマーケットプレースタブに Node.js リモートインタープリタープラグインをインストールして有効にします。
設定 | プラグインページのインストール済みタブで、Node.js および Docker に必要なプラグインが有効になっていることを確認します。詳細については、「プラグインのマッピング」を参照してください。
Docker の説明に従って、Docker をダウンロード、インストール、設定します。

Docker の Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで構成されます。このダイアログは、Docker でアプリケーションを実行またはデバッグするために Node.js の実行 / デバッグ構成を作成または編集するを実行するときに、設定ダイアログの Node.js ページから開くことができます。

推奨される方法は、設定ダイアログでリモート Node.js インタープリターを構成することです。この場合、プロジェクトのデフォルトとしてインタープリターと関連するパッケージマネージャーを設定できます。その結果、Docker で構成された Node.js インタープリターを使用してアプリを実行およびデバッグできるだけでなく、プロジェクトの依存関係を管理し、テストを実行し、コードをリントすることもできます。

Node.js の実行 / デバッグ構成で直接構成するリモート Node.js インタープリターは、この実行 / デバッグ構成でのみ使用できます。

設定で Node.js インタープリターを構成するダイアログ

実行 | 実行構成の編集に進みます。開いた構成の編集ダイアログで、ツールバーのをクリックし、コンテキストメニューから Node.js を選択します。
開いた実行 / デバッグ構成: Node.js ダイアログで、Node インタープリターフィールドの横にあるをクリックします。
現在構成されているすべてのインタープリターのリストが表示された Node.js インタープリターダイアログで、ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
開いた Node.js リモートインタープリターの構成ダイアログで、Docker オプションを選択します。
1. サーバーフィールドに、使用する Docker の設定を指定します。詳細については、Docker デーモンの接続設定を構成するを参照してください。リストから構成を選択するか、をクリックして、開いた Docker ページ上に新しい構成を作成します。
2. イメージ名: フィールドで、使用するベース Docker イメージを指定します。リストから以前にダウンロードしたイメージまたはカスタムイメージのいずれかを選択するか、node:argon や mhart/alpine-node などのイメージ名を手動で入力します。後で実行構成を起動すると、Docker はマシン上で指定されたイメージを検索します。検索が失敗した場合、イメージは Docker レジストリページの Docker 公式イメージ(英語)リポジトリからダウンロードされます。
3. Node.js インタープリターのパスフィールドには、指定されたイメージからのデフォルトの Node.js インタープリターの場所が表示されます。
4. OK をクリックすると、IntelliJ IDEA は Node.js リモートインタープリターの構成ダイアログを閉じ、新しいインタープリター構成がリストに追加される Node.js インタープリターダイアログに移動します。OK をクリックして、実行構成に戻ります。

Node.js の実行 / デバッグ構成で Node.js インタープリターを構成する

実行 | 実行構成の編集に進みます。開いた構成の編集ダイアログで、ツールバーのをクリックし、コンテキストメニューから Node.js を選択します。「実行 / デバッグ構成: Node.js」ダイアログが開きます。
Node インタープリターフィールドの横にあるをクリックします。Node.js インタープリターダイアログが開きます。
ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
上記のようにリモート Node.js インタープリターを構成します。

Docker Compose 定義を持つ Docker コンテナーでリモート Node.js インタープリターを使用する

Docker Compose(英語) を使用すると、Node.js サーバーとアプリケーションコードを別々のサービスとして実行できます。必要に応じてコンテナーを追加することで各サービスを拡張できます。これにより、実稼働環境に似た動的環境で効率的な開発とテストを実行できます。

始める前に

JetBrains マーケットプレイスからプラグインをインストールする説明に従って、設定 | プラグインページのマーケットプレースタブに Node.js リモートインタープリタープラグインをインストールして有効にします。
設定 | プラグインページのインストール済みタブで、Node.js および Docker に必要なプラグインが有効になっていることを確認します。詳細については、「プラグインのマッピング」を参照してください。
Docker の説明に従って、Docker をダウンロード、インストール、設定します。

マルチコンテナー Docker アプリケーションの Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで設定します。このダイアログは、設定ダイアログの Node.js ページから、または Node.js の実行 / デバッグ構成を作成または編集しますを使用して Vagrant 環境でアプリケーションを実行またはデバッグする際に、設定ダイアログ以降から開くことができます。

Node.js の実行 / デバッグ構成で直接構成するリモート Node.js インタープリターは、この実行 / デバッグ構成でのみ使用できます。

設定ダイアログ（Ctrl+Alt+S）を開き、言語 & フレームワーク | Node.js に移動します。
Node インタープリターフィールドの横にあるをクリックします。
現在構成されているすべてのインタープリターのリストが表示された Node.js インタープリターダイアログで、ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
開いた Node.js リモートインタープリターの構成ダイアログで、Docker Compose を選択します。
サーバーリストから、使用する Docker 構成を選択します。
または、フィールドの横にある新規をクリックし、Docker サポートを有効にする説明に従って Docker サーバーを構成します。
構成ファイルフィールドで、使用する docker-compose 構成ファイルを指定します。「参照」をクリックし、表示される「Docker Compose 構成ファイル」ダイアログで構成ファイルのリストを作成します。
サービスリストから、使用するサービスを選択します。
OK をクリックすると Node.js インタープリターダイアログに戻り、新しいインタープリターがリストに追加されます。新しく構成されたインタープリターをプロジェクトのデフォルトに設定するには、リストでそのインタープリターを選択し、OK をクリックして Node.js ダイアログに戻ります。

IntelliJ IDEA は、たとえば実行 / デバッグ構成を作成するときに、Node インタープリターリストから Project エイリアスを選択するたびに、このインタープリターを自動的に使用します。

新しいインタープリターに関連付けられたパッケージマネージャーを使用してプロジェクトの依存関係を管理するには、このパッケージマネージャーをプロジェクトのデフォルトとして設定します。これを行うには、パッケージマネージャーフィールドでパッケージマネージャーの場所を指定します。プロジェクトでデフォルトの Node.js インタープリターとパッケージマネージャーを指定するから詳細を参照してください。

プロジェクトでデフォルトの Node.js インタープリターとパッケージマネージャーを指定する

IntelliJ IDEA は、実行 / デバッグ構成の作成時など、Node インタープリターリストから Project エイリアスを選択するたびに、デフォルトのプロジェクトインタープリターを自動的に使用します。

デフォルトのプロジェクトパッケージマネージャーは、依存関係を管理するために自動的に使用されます。たとえば、package.json ファイルから <package manager> install を実行したり、ESLint、Prettier などのサードパーティツールをインストールしたりします。

設定ダイアログ（Ctrl+Alt+S）を開き、言語 & フレームワーク | Node.js に移動します。
Node インタープリターリストから、現在のプロジェクトでデフォルトで使用する構成を選択します。
パッケージマネージャーリストから、使用するパッケージマネージャーに関連付けられているエイリアスを選択します。IntelliJ IDEA はその位置を自動的に検出します。
または、必要なパッケージマネージャーの場所を手動で指定します。
- npm 実行可能ファイルのデフォルトの場所は /usr/local/lib/node_modules/npm です。
- pnpm のデフォルトの場所は、インストール方法によって異なります。
  1. npm を介してインストールするための /usr/local/lib/node_modules/pnpm。
  2. カールを介してインストールするための /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 アプリケーションの実行とデバッグで説明されているいくつかのオプション設定を指定します。
Node インタープリターリストから、Docker Compose を介して関連するリモート Node.js インタープリターを選択します。
または、Node インタープリターフィールドの横にあるをクリックします。そして、上記のようにリモート Node.js インタープリターを構成します。
Docker Compose エリアで、Docker Compose に渡すコマンドとオプションを指定します。デフォルト設定を受け入れるか、「」をクリックしてカスタム設定 (たとえば、--rm や --service-ports などのカスタム Docker Compose フラグ) を指定します。詳細については、Docker オフィシャル Web サイト(英語)を参照してください。
コマンドプレビューを確認してください。

Vagrant インスタンスの Node.js インタープリター

Vagrant(英語) を使用すると、Node.js アプリケーションをすばやくブートストラップして、IntelliJ IDEA から実行、デバッグ、プロファイリングできます。

始める前に

JetBrains マーケットプレイスからプラグインをインストールする説明に従って、設定 | プラグインページのタブマーケットプレースに Node.js、Node.js リモートインタープリター、Vagrant プラグインをインストールします。
Vagrant(英語) と Oracle の VirtualBox(英語) がコンピューターにダウンロード、インストール、構成されていることを確認してください。詳細については、Vagrant を参照してください。
次の実行可能ファイルの親フォルダーがシステム PATH 変数に追加されていることを確認します。
- Vagrant から vagrant.bat または vagrant を選択してください。これは、Vagrant インストーラによって自動的に実行されます。
- Oracle VirtualBox インストールからの VBoxManage.exe または VBoxManage。

Vagrant 環境の Node.js インタープリターは、Node.js リモートインタープリターの構成ダイアログで構成されます。このダイアログは、Vagrant 環境でアプリケーションを実行またはデバッグするために Node.js の実行 / デバッグ構成を作成または編集しますを使用する場合に、設定ダイアログの Node.js ページ以降から開くことができます。

Node.js の実行 / デバッグ構成で直接構成するリモート Node.js インタープリターは、この実行 / デバッグ構成でのみ使用できます。

設定で Node.js インタープリターを構成するダイアログ

設定ダイアログ（Ctrl+Alt+S）を開き、言語 & フレームワーク | Node.js に移動します。
Node インタープリターフィールドの横にあるをクリックします。
現在構成されているすべてのインタープリターのリストが表示された Node.js インタープリターダイアログで、ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
開いた Node.js リモートインタープリターの構成ダイアログで、Vagrant を選択します。
使用する環境を指す Vagrant インスタンスフォルダーを指定してください。
技術的には、目的の環境の VagrantFile 構成ファイルが配置されているフォルダーです。この設定に基づいて、IntelliJ IDEA は Vagrant ホストを検出し、Vagrant ホスト URL 読み取り専用フィールドにリンクとして表示します。
デフォルトでは、フィールドには現在のプロジェクトフォルダーが表示されます。
Node.js インタープリターのパスフィールドで、Node.js 実行可能ファイルの場所を指定します。
Node.js 実行可能ファイルを見つけるには、埋め込みターミナル（Alt+F12）を開いて次のように入力します。
vagrant ssh whereis node exit
OK をクリックして、新しいインタープリターがリストに追加される Node.js インタープリターダイアログに戻ります。
新しく構成されたインタープリターをプロジェクトのデフォルトとして設定するには、リストでインタープリターを選択し、OK をクリックして Node.js ダイアログに戻ります。
IntelliJ IDEA は、たとえば実行 / デバッグ構成を作成するときに、Node インタープリターリストから Project エイリアスを選択するたびに、このインタープリターを自動的に使用します。
使用するパッケージマネージャーへのパスを指定します。
パッケージマネージャーを見つけるには、組み込みターミナル（Alt+F12）を開いて次のように入力します。
vagrant ssh whereis <package manager> exit

Node.js の実行 / デバッグ構成で Node.js インタープリターを構成する

実行 | 実行構成の編集に進みます。開いた構成の編集ダイアログで、ツールバーのをクリックし、コンテキストメニューから Node.js を選択します。「実行 / デバッグ構成: Node.js」ダイアログが開きます。
Node インタープリターフィールドの横にあるをクリックします。Node.js インタープリターダイアログが開きます。
ツールバーのをクリックし、コンテキストメニューからリモートの追加を選択します。
上記のように、Vagrant 環境でリモート Node.js インタープリターを構成します。