配置远程 Node.js 运行时

在 WebStorm 中，当您希望在安装于远程主机或虚拟环境中的 Node.js 上开发、测试、代码检查、运行和调试应用程序时，您需要配置远程 Node.js 运行时。

远程 Node.js 运行时在配置Node.js 远程解释器对话框中进行配置。您可以从设置对话框的 JavaScript 运行时页面打开此对话框，或在稍后为在远程环境中运行或调试应用程序而创建或编辑 Node.js 运行/调试配置时打开。

建议的方式是在设置对话框中配置远程 Node.js 运行时。在这种情况下，您可以将该运行时及其关联的包管理器设置为项目默认。

直接在 Node.js 运行/调试配置中配置的远程 Node.js 运行时只能与该运行/调试配置一起使用。

通过 SSH 连接可访问的主机上的远程 Node.js 运行时

在开始之前

确保在设置 | 插件页面、已安装选项卡上启用了所需的插件： Node.js、 Node.js Remote Interpreter 和 FTP/SFTP/WebDAV Connectivity。有关更多信息，请参阅管理插件。
按照创建 SSH 配置中的描述，在目标远程主机上配置访问 SSH 服务器，并确保该服务器正在运行。

通过 SSH 的 Node.js 运行时在配置Node.js 远程解释器对话框中进行配置。您可以从 JavaScript 运行时页面（位于设置对话框中）打开此对话框，或者在稍后，当您创建或编辑 Node.js 运行/调试配置以运行或调试您的应用程序时。

建议的方式是在设置对话框中配置远程 Node.js 运行时。在这种情况下，您可以将该运行时及其关联的包管理器设置为项目默认。

直接在 Node.js 运行/调试配置中配置的远程 Node.js 运行时只能与该运行/调试配置一起使用。

在设置对话框中通过 SSH 配置远程 Node.js 运行时

打开设置对话框（Ctrl+Alt+S ），然后转到语言和框架 | JavaScript 运行时。
点击字段旁的 Node.js 运行时。
在包含所有当前已配置运行时列表的 Node.js 运行时对话框中，点击工具栏中的，然后在上下文菜单中选择添加远程.
在打开的配置 Node.js 远程运行时对话框中，选择 SSH。
请选择要使用的 SSH 配置。
或者，点击并按照创建 SSH 配置中的描述创建一个新的 SSH 配置。
点击 OK 返回到 Node.js 解释器对话框，其中已将新运行时添加到列表。
要将新配置的运行时设为项目默认，请在列表中选择它并点击确定返回到 JavaScript 运行时对话框。
每次您从 Node.js 运行时列表中选择 Project 别名时，WebStorm都会自动使用此解释器，例如在创建运行/调试配置时。
若要使用与新运行时关联的包管理器来管理项目依赖项，请将该包管理器设为项目默认。要做到这一点，请在软件包管理器(M) 字段中指定包管理器的位置。
npm 可执行文件的默认位置是 /usr/local/lib/node_modules/npm。

在运行/调试配置中通过 SSH 配置远程 Node.js 运行时

转到运行 | 编辑配置。在弹出的编辑配置对话框中，点击工具栏上的并从上下文菜单中选择 Node.js。将打开运行/调试配置：Node.js 对话框。
请点击旁的 Node.js 运行时字段。
将打开 Node.js 运行时对话框。
点击工具栏中的按钮，并从上下文菜单中选择添加远程。
通过 SSH 配置远程 Node.js 运行时，如上所述。

Docker 容器中的远程 Node.js 运行时

在开始之前

确保在设置 | 插件页面的已安装选项卡上启用了所需的 Node.js、 Node.js Remote Interpreter和 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 运行时对话框中，点击工具栏中的，然后在上下文菜单中选择添加远程.
在打开的配置 Node.js 远程运行时对话框中，选择 Docker 选项。
1. 在服务器字段中，指定要使用的 Docker 配置。有关更多信息，请参阅配置 Docker 守护程序连接设置。从列表中选择一个配置，或点击新建… 并在打开的 Docker 页面上创建一个新配置。
2. 在镜像名称字段中，指定要使用的基础 Docker 镜像。从列表中选择一个先前下载的或自定义的图像，或者手动输入图像名称，例如， node:argon 或 mhart/alpine-node。当您稍后启动运行配置时，Docker 将在您的机器上搜索指定的镜像。如果搜索失败，将从 Docker 注册表页面的存储库中下载镜像。建议您使用官方 Node.js Docker 镜像。
3. Node.js 运行时路径字段显示指定镜像中的默认 Node.js 解释器的位置。
4. 当您点击 OK 时，WebStorm 会关闭配置 Node.js 远程解释器对话框，并将您带到 Node.js 运行时对话框，在其中会将新的运行时配置添加到列表中。点击确定返回运行配置。

在 Node.js 运行/调试配置中配置 Node.js 运行时

转到运行 | 编辑配置。在弹出的编辑配置对话框中，点击工具栏上的并从上下文菜单中选择 Node.js。将打开运行/调试配置：Node.js 对话框。
请点击旁的 Node.js 运行时字段。将打开 Node.js 运行时对话框。
点击工具栏中的按钮，并从上下文菜单中选择添加远程。
配置远程 Node.js 运行时，如上所述。

在带有 Docker Compose 定义的 Docker 容器中使用远程 Node.js 运行时

借助 Docker Compose ，您可以将 Node.js 服务器和您的应用程序代码作为单独的服务运行。每个服务都可以通过添加更多的容器来扩展规模（如果需要的话）。这使您能够在类似于生产环境的动态环境中进行高效的开发和测试。

在开始之前

确保在设置 | 插件页面的已安装选项卡上启用了所需的 Node.js、 Node.js Remote Interpreter和 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 ），然后转到语言和框架 | JavaScript 运行时。
点击字段旁的 Node.js 运行时。
在包含所有当前已配置运行时列表的 Node.js 运行时对话框中，点击工具栏中的，然后在上下文菜单中选择添加远程.
在打开的配置 Node.js 远程运行时对话框中，选择 Docker Compose。
从服务器列表中，选择要使用的 Docker 配置。
或者，点击字段旁边的新建按照启用 Docker 支持中的描述配置 Docker 服务器。
在配置文件字段中，指定要使用的 docker-compose 配置文件。点击浏览，并在打开的 Docker Compose 配置文件对话框中创建配置文件列表。
从服务列表中选择要使用的服务：
点击 OK 返回到 Node.js 解释器对话框，其中已将新运行时添加到列表。要将新配置的运行时设置为项目默认，请在列表中选择它并点击确定以返回到 JavaScript 运行时对话框。

每次您从 Node.js 运行时列表中选择 Project 别名时，WebStorm都会自动使用此解释器，例如在创建运行/调试配置时。

若要使用与新运行时关联的包管理器来管理项目依赖项，请将该包管理器设为项目默认。要做到这一点，请在软件包管理器(M) 字段中指定包管理器的位置。详细了解，请参阅在项目中指定默认的 Node.js 运行时和包管理器。

在项目中指定默认的 Node.js 运行时和包管理器

每次您在 Node.js 运行时列表中选择 Project 别名时，WebStorm 都会自动使用项目默认解释器，例如在创建运行/调试配置时。

默认的项目包管理器会自动用于管理依赖项，例如，当您从 <package manager> install 文件运行 package.json 或安装第三方工具（例如 ESLint、Prettier 等）时。

打开设置对话框（Ctrl+Alt+S ），然后转到语言和框架 | JavaScript 运行时。
确保在首选运行时列表中选中 Node.js。
从 Node.js 运行时列表中选择要在当前项目中默认使用的配置。
从包管理器列表中选择与要使用的软件包管理器相关联的别名。 WebStorm 会自动检测其位置。
或者，手动指定所需包管理器的位置。
- npm 可执行文件的默认位置是 /usr/local/lib/node_modules/npm。
- 默认情况下，pnpm 的位置取决于安装方法：
  1. 通过 /usr/local/lib/node_modules/pnpm 安装。
  2. /usr/local/pnpm-global/<version>/node_modules/pnpm 适用于通过 curl 安装（curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm）。
  进一步了解请访问 pnpm official website。
- yarn 的默认位置是 /opt/yarn-<version>5 ，例如， /opt/yarn-v1.22.5 。

在 Node.js 运行/调试配置中使用 Docker Compose 定义配置 Node.js 运行时

转到运行 | 编辑配置。在弹出的编辑配置对话框中，点击工具栏上的并从上下文菜单中选择 Node.js。将打开运行/调试配置：Node.js 对话框。
在文件字段中，指定启动应用程序的主文件路径（例如， bin/www 对于 Express 应用程序）。
如有必要，请按照运行和调试 Node.js 应用程序中描述的方式指定一些可选设置。
从 Node.js 运行时列表中，选择通过 Docker Compose 的相应远程 Node.js 运行时。
或者，单击，位于 Node.js 运行时字段旁边。并按照如上所述配置远程 Node.js 运行时。
在 Docker Compose 区域中，指定要传递给 Docker Compose 的命令和选项。接受默认设置或点击并指定自定义设置，例如，自定义 Docker Compose 标志，像 --rm 或 --service-ports。了解更多信息请访问 Docker 官方网站。
请检查命令预览。

Vagrant 实例中的 Node.js 运行时

使用 Vagrant ，您可以快速引导您的 Node.js 应用程序来运行、调试和分析它的性能，从 WebStorm 开始。了解详情，请参阅使用 Vagrant 的 Node.js。

在开始之前

确保在设置 | 插件页面、已安装选项卡上启用了所需的插件： Node.js、 Node.js Remote Interpreter 和 Vagrant。有关更多信息，请参阅管理插件。
请确保已在您的计算机上下载、安装并配置好 Vagrant 和 Oracle's VirtualBox。更多信息，请参见 Vagrant：使用可复制的开发环境。
请确保以下可执行文件的父文件夹已添加到系统 PATH变量：
- vagrant.bat 或 vagrant 从您的 Vagrant 安装。这应该由 Vagrant 安装程序自动完成。
- VBoxManage.exe 或 VBoxManage 来自您的 Oracle 的 VirtualBox 安装。

Vagrant 环境中的 Node.js 运行时在配置Node.js 远程解释器对话框中进行配置。您可以从设置对话框的 JavaScript 运行时页面打开此对话框，或在稍后为在 Vagrant 环境中运行或调试应用程序而创建或编辑 Node.js 运行/调试配置时打开。

建议的方式是在设置对话框中配置远程 Node.js 运行时。在这种情况下，您可以将该运行时及其关联的包管理器设置为项目默认。

直接在 Node.js 运行/调试配置中配置的远程 Node.js 运行时只能与该运行/调试配置一起使用。

在设置对话框中配置 Node.js 运行时

打开设置对话框（Ctrl+Alt+S ），然后转到语言和框架 | JavaScript 运行时。
点击字段旁的 Node.js 运行时。
在包含所有当前已配置运行时列表的 Node.js 运行时对话框中，点击工具栏中的，然后在上下文菜单中选择添加远程.
在打开的配置 Node.js 远程运行时对话框中，选择 Vagrant。
请指定 Vagrant 实例文件夹，该变量指向您将要使用的环境。
从技术上讲，这是用于所需环境的 VagrantFile 配置文件所在的文件夹。基于此设置，WebStorm 检测到 Vagrant host 并将其作为链接显示在 Vagrant 主机 URL 只读字段中。
默认情况下，该字段显示当前项目文件夹。
在 Node.js 解释器路径字段中，指定 Node.js 可执行文件的位置。
要定位 Node.js 可执行文件，请打开嵌入的终端（Alt+F12 ）并输入：
vagrant ssh whereis node exit
点击确定返回到 Node.js 解释器对话框，其中已将新运行时添加到列表。
要将新配置的运行时设为项目默认，请在列表中选择它并点击确定返回到 JavaScript 运行时对话框。
每次您从 Node.js 运行时列表中选择 Project 别名时，WebStorm都会自动使用此解释器，例如在创建运行/调试配置时。
指定要使用的软件包管理器路径。
要定位包管理器，请打开嵌入的终端（Alt+F12 ）并输入：
vagrant ssh whereis <package manager> exit

在 Node.js 运行/调试配置中配置 Node.js 运行时

转到运行 | 编辑配置。在弹出的编辑配置对话框中，点击工具栏上的并从上下文菜单中选择 Node.js。将打开运行/调试配置：Node.js 对话框。
请点击旁的 Node.js 运行时字段。将打开 Node.js 运行时对话框。
点击工具栏中的按钮，并从上下文菜单中选择添加远程。
在 Vagrant 环境中配置远程 Node.js 运行时，如上所述。

最后修改日期： 2025年 12月 8日