WebStorm 2025.2 Help

配置远程 Node.js 解释器

在 WebStorm 中,如果希望在安装于远程主机或虚拟环境的 Node.js 上开发、测试、执行 lint、运行及调试应用程序,则需要配置远程 Node.js 解释器。

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

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

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

通过 SSH 连接访问的主机上的远程 Node.js 解释器

准备工作

  1. 请确保在 设置 | 插件 页面、 已安装 选项卡中启用了所需的插件: Node.jsNode.js Remote InterpreterFTP/SFTP/WebDAV Connectivity。 如需了解详情,请参阅 Managing plugins

  2. Create SSH configurations 中所述,在目标远程主机上配置对 SSH 服务器的访问权限,并确保该服务器已运行。

通过 SSH 配置 Node.js 解释器是在 配置Node.js 远程解释器 对话框中完成的。 您可以在 Node.js 页面中的 设置 对话框中打开此对话框,也可以在稍后 创建或编辑用于运行或调试应用的 Node.js 运行/调试配置 时打开。

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

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

在“设置”对话框中通过 SSH 配置远程 Node.js 解释器

  1. 打开 设置 对话框(Ctrl+Alt+S ),然后转到 语言和框架 | Node.js

  2. 点击 浏览按钮 按钮,该按钮位于 Node 解释器(I) 字段旁边。

    添加解释器 - 浏览按钮
  3. Node.js Interpreters 对话框中,列出了当前配置的所有解释器。请点击工具栏上的 添加按钮 ,并在上下文菜单中选择 添加远程

    通过 SSH 配置 Node.js 解释器:添加远程
  4. 在打开的 Configure Node.js Remote Interpreter dialog 对话框中,选择 SSH

  5. 请选择要使用的 SSH 配置。

    通过 SSH 配置远程 Node.js 解释器:选择 SSH 配置

    或者,点击 浏览按钮 并按照 Create SSH configurations 中的说明创建新的 SSH 配置。

  6. 点击 确定 返回 Node.js 解释器 对话框,添加的新解释器将在列表中显示。

    远程解释器对话框:新建的 SSH Node.js 解释器已添加至列表
  7. 要将新配置的解释器设置为项目默认项,请在列表中选中它,然后点击 确定 返回 Node.js 对话框。

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

    要使用与新解释器关联的包管理器来管理项目依赖项,请将该包管理器设置为项目中的默认值。 为此,请在 软件包管理器(M) 字段中指定包管理器的位置。

    npm 可执行文件的默认位置是 /usr/local/lib/node_modules/npm

    通过 SSH 配置 Node.js 解释器:设为默认项目解释器

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

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,点击工具栏上的 新建配置按钮 ,并从上下文菜单中选择 Node.js。 将打开 运行/调试配置:Node.js 对话框。

  2. 点击 浏览按钮 ,该按钮位于 Node 解释器(I) 字段旁边。

    Node.js 运行/调试配置:已指定 JavaScript 文件

    将打开 Node.js Interpreters 对话框。

  3. 点击工具栏上的 添加按钮 ,并从上下文菜单中选择 添加远程

    通过 SSH 配置 Node.js:运行/调试配置,配置解释器,选择添加远程
  4. 上述说明通过 SSH 配置远程 Node.js 解释器。

Docker 容器中的远程 Node.js 解释器

准备工作

  1. 请确保在 设置 | 插件 页面、 已安装 选项卡中启用了所需的插件: Node.jsNode.js Remote InterpreterDocker。 如需了解详情,请参阅 Managing plugins

  2. 请按照 Docker 中的说明下载、安装并配置 Docker

配置Node.js 远程解释器 对话框中配置 Docker 中的 Node.js 解释器。 您可以在 Node.js 页面中的 设置 对话框中打开此对话框,也可以在稍后 创建或编辑用于在 Docker 中运行或调试应用的 Node.js 运行/调试配置 时打开。

建议的方式是在 设置 对话框中配置远程 Node.js 解释器。 在这种情况下,您可以将该解释器及其关联的包管理器设置为项目的默认值。 因此,配置了 Docker 中的 Node.js 解释器后,您不仅可以运行和调试您的应用,还可以管理项目依赖、运行测试并对代码进行 lint 处理。

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

在“设置”对话框中配置 Node.js 解释器

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,点击工具栏上的 新建配置按钮 并从上下文菜单中选择 Node.js

    在打开的 运行/调试配置:Node.js 对话框中,点击 浏览按钮 ,该按钮位于 Node 解释器(I) 字段旁边。

  2. 在包含所有已配置解释器列表的 Node.js 解释器 对话框中,点击工具栏上的 添加按钮 ,然后从上下文菜单中选择 添加远程

  3. 在打开的 配置 Node.js 远程解释器对话框 中,选择 Docker 选项。

    1. 服务器 字段中,指定要使用的 Docker 配置。 如需了解详细信息,请参阅 配置 Docker 守护进程连接设置。 从列表中选择一个配置,或点击 新建... ,然后在打开的 Docker 页面 中创建一个新配置。

    2. 镜像名称 字段中,指定要使用的基础 Docker 镜像。 从列表中选择一个已下载的镜像或自定义镜像,或手动输入镜像名称,例如 node:argonmhart/alpine-node。 随后在启动运行配置时,Docker 将在您的计算机上查找指定的镜像。 如果查找失败,将从 Docker 注册表页面 中的存储库中下载该镜像。 建议使用 官方 Node.js Docker 镜像

    3. Node.js 解释器路径 字段显示了指定镜像中默认 Node.js 解释器的位置。

    4. 点击 确定 后,WebStorm 会关闭 配置 Node.js 远程解释器 对话框并打开 Node.js 解释器 对话框,其中新增的解释器配置将被添加到列表中。 点击 确定 返回运行配置。

在 Node.js 运行/调试配置中配置 Node.js 解释器

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,点击工具栏上的 新建配置按钮 ,然后从上下文菜单中选择 Node.js运行/调试配置:Node.js 对话框将打开。

  2. 点击 浏览按钮 ,该按钮位于 Node 解释器(I) 字段旁边。 Node.js 解释器 对话框将打开。

  3. 点击工具栏上的 添加按钮 ,然后从上下文菜单中选择 添加远程

    使用 Docker 的 Node.js:运行/调试配置,配置解释器,选择添加远程
  4. 上述说明配置远程 Node.js 解释器。

使用带有 Docker Compose 定义的 Docker 容器中的远程 Node.js 解释器

借助 Docker Compose ,您可以将 Node.js 服务器和应用程序代码分别作为独立服务运行。 每个服务都可以通过添加更多容器进行扩展。 这使您能够在类似于生产环境的动态环境中高效地进行开发与测试。

准备工作

  1. 请确保在 设置 | 插件 页面、 已安装 选项卡中启用了必需的 Node.jsNode.js 远程解释器Docker 插件。 如需了解详细信息,请参阅 管理插件

  2. 按照 Docker 中的说明下载、安装并配置 Docker

多容器 Docker 应用中的 Node.js 解释器可在 配置Node.js 远程解释器 对话框中进行配置。 您可通过 设置 对话框中的 Node.js 页面打开此对话框,也可以稍后在 创建或编辑 Node.js 运行/调试配置 以在 Vagrant 环境中运行或调试您的应用时打开。

推荐的方法是在 设置 对话框中配置远程 Node.js 解释器。 在此情况下,您可以将解释器及其关联的包管理器设置为项目的默认值。 因此,您不仅可以使用已在 Docker 中配置的 Node.js 解释器运行和调试应用,还可以管理项目依赖项、运行测试以及执行代码检查。 请参阅下方的 npm、pnpm 与 yarn 配合 Docker 使用测试应用ESLint 与 Docker

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

  1. 打开 设置 对话框(Ctrl+Alt+S ),然后转到 语言和框架 | Node.js

  2. 单击 浏览按钮 ,位于 Node 解释器(I) 字段旁。

    添加解释器 - 浏览按钮
  3. Node.js 解释器 对话框中,列出当前已配置的所有解释器,在工具栏单击 添加按钮 ,然后从上下文菜单中选择 添加远程

    在 Docker 容器中配置 Node.js 解释器:添加远程
  4. 在打开的 配置 Node.js 远程解释器对话框 中,选择 Docker Compose

  5. 服务器 列表中,选择要使用的 Docker 配置。

    通过 Docker Compose 配置 Node.js 解释器:选择 Docker 服务器

    或者,单击字段旁的 新建 ,并按 启用 Docker 支持 中所述配置 Docker 服务器。

  6. 配置文件 字段中,指定要使用的 docker-compose 配置文件。 单击 浏览 并在打开的 Docker Compose 配置文件 对话框中创建配置文件列表。

    通过 Docker Compose 配置 Node.js 解释器:配置文件
  7. 服务 列表中,选择要使用的服务:

    通过 Docker Compose 配置 Node.js 解释器:选择服务
  8. 单击 确定 返回到 Node.js 解释器 对话框,其中新解释器将添加到列表中。 要将新配置的解释器设置为项目默认值,请在列表中选择它,然后单击 确定 返回到 Node.js 对话框。

    远程解释器对话框:新建的 Docker Node.js 解释器已添加至列表

每当从 Project 列表中选择 Node 解释器 别名时(例如,在创建运行/调试配置时),WebStorm 会自动使用此解释器。

要使用与新解释器关联的软件包管理器来管理项目依赖项,请在项目中将其设置为默认软件包管理器。 为此,请在 软件包管理器(M) 字段中指定软件包管理器的位置。 详细了解 在项目中指定默认 Node.js 解释器和软件包管理器

在项目中指定默认 Node.js 解释器和包管理器

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

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

  1. 打开 设置 对话框(Ctrl+Alt+S ),然后转到 语言和框架 | Node.js

  2. Node 解释器(I) 列表中,选择当前项目中要默认使用的配置。

  3. 包管理器 列表中,选择与要使用的软件包管理器关联的别名。 WebStorm 会自动检测其位置。

    设置:新配置的远程 Node.js 解释器已设为默认

    或者,请手动指定所需软件包管理器的位置。

    • npm 可执行文件的默认位置是 /usr/local/lib/node_modules/npm

    • pnpm 的默认位置取决于安装方式:

      1. 通过 npm 安装时,其位置为 /usr/local/lib/node_modules/pnpm

      2. 通过 curl 安装时,其位置为 /usr/local/pnpm-global/<version>/node_modules/pnpm curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm)。

      详细了解请访问 pnpm 官方网站

    • yarn 的默认位置为 /opt/yarn-<version>5 ,例如 /opt/yarn-v1.22.5

在 Node.js 运行/调试配置中通过 Docker Compose 定义配置 Node.js 解释器

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,单击工具栏上的 新建配置按钮 ,并从上下文菜单中选择 Node.js运行/调试配置:Node.js 对话框将打开。

  2. 文件 字段中,指定启动应用程序的主文件路径(例如, bin/www 适用于 Express 应用程序)。

    Node.js 运行/调试配置:已指定 JavaScript 文件
  3. 如有需要,请按 运行和调试 Node.js 应用程序 中所述指定一些可选设置。

  4. Node 解释器(I) 列表中,选择通过 Docker Compose 使用的远程 Node.js 解释器。

    使用 Docker Compose 的 Node.js:运行/调试配置,选择解释器

    或者,单击 浏览按钮 ,位于 Node 解释器(I) 字段旁。 并 按上述说明 配置远程 Node.js 解释器。

    使用 Docker 的 Node.js:运行/调试配置,配置解释器,选择添加远程
  5. Docker Compose 区域中,指定要传递给 Docker Compose 的命令和选项。 接受默认设置,或单击 展开按钮 并指定自定义设置,例如自定义 Docker Compose 标志,如 --rm--service-ports。 详细了解请访问 Docker 官方网站

    检查 命令预览

    Docker Compose 区域预览

Vagrant 实例中的 Node.js 解释器

使用 Vagrant ,您可以快速引导 Node.js 应用程序以便从 WebStorm 运行、调试和分析。 详细了解请访问 使用 Vagrant 的 Node.js

准备工作

  1. 请确保在 设置 | 插件 页面的 已安装 选项卡中启用了所需的 Node.jsNode.js Remote InterpreterVagrant插件。 如需了解更多信息,请参阅 Managing plugins

  2. 请确保已在您的计算机上下载、安装并配置好 VagrantOracle 的 VirtualBox。 如需了解更多信息,请参阅 Vagrant:使用可复现的开发环境进行开发

  3. 请确保以下可执行文件的父文件夹已添加到系统 PATH变量中:

    • 来自您的 Vagrant 安装的 vagrant.bat vagrant 。 此操作应由 Vagrant 安装程序自动完成。

    • 来自您 Oracle 的 VirtualBox 安装的 VBoxManage.exe VBoxManage

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

推荐的方法是在 设置 对话框中配置远程 Node.js 解释器。 在这种情况下,您可以将解释器及其关联的包管理器设置为项目默认值。

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

在“设置”对话框中配置 Node.js 解释器

  1. 打开 设置 对话框(Ctrl+Alt+S ),然后转到 语言和框架 | Node.js

  2. 单击 浏览按钮 ,该按钮位于 Node 解释器(I) 字段旁边。

    添加解释器 - 浏览按钮
  3. 在显示所有当前已配置解释器列表的 Node.js Interpreters对话框中,单击工具栏上的 添加按钮 ,然后从上下文菜单中选择 添加远程

    配置 Node.js 远程解释器:添加远程
  4. 在打开的 Configure Node.js Remote Interpreter dialog对话框中,选择 Vagrant

  5. 指定指向所要使用环境的 Vagrant 实例文件夹

    从技术上讲,这是存放所选环境的 VagrantFile配置文件的文件夹。 根据此设置,WebStorm 会检测 Vagrant host ,并在 Vagrant 主机 URL 只读字段中显示为链接。

    默认情况下,该字段显示当前项目文件夹。

  6. Node.js 解释器路径 字段中指定 Node.js 可执行文件的位置。

    Vagrant 环境中配置远程 Node.js 解释器:指定实例文件夹和 Node 可执行文件位置

    要定位 Node.js 可执行文件,请打开嵌入式 终端Alt+F12 )并输入:

    vagrant ssh whereis node exit
    在 Vagrant 环境中定位 Node.js 可执行文件
  7. 单击 确定 返回到 Node.js 解释器 对话框,新配置的解释器会添加到列表中。

  8. 要将新配置的解释器设置为项目默认值,请在列表中选择它,然后单击 确定 返回到 Node.js 对话框。

    远程解释器对话框:新建的 Vagrant Node.js 解释器已添加至列表

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

  9. 指定要使用的包管理器路径。

    配置远程 Node.js 解释器:已指定包管理器

    要定位包管理器,请打开嵌入式 终端Alt+F12 )并输入:

    vagrant ssh whereis <package manager> exit
    在 Vagrant 环境中定位包管理器

在 Node.js 运行/调试配置中配置 Node.js 解释器

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,单击工具栏上的 新建配置按钮 ,然后从上下文菜单中选择 Node.js运行/调试配置:Node.js 对话框将打开。

  2. 单击 浏览按钮 ,该按钮位于 Node 解释器(I) 字段旁边。 Node.js Interpreters对话框将打开。

  3. 单击工具栏上的 添加按钮 ,然后从上下文菜单中选择 添加远程

    远程解释器对话框
  4. 如上所述在 Vagrant 环境中配置远程 Node.js 解释器。

最后修改日期: 2025年 9月 26日