PyCharm 2025.3 Help

配置远程 Node.js 运行时

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

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

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

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

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

开始之前

  1. 设置 | 插件 页的 Marketplace 选项卡上安装 Node.jsNode.js Remote Interpreter 插件,具体请参见 从 JetBrains Marketplace 安装插件

  2. 请确保在设置中启用了 FTP/SFTP/WebDAV Connectivity 插件。 按 Ctrl+Alt+S 打开设置,然后选择 插件。 点击 已安装 选项卡。 在搜索字段中,输入 FTP/SFTP/WebDAV Connectivity。 有关插件的更多信息,请参见 管理插件

  3. 按照 创建 SSH 配置 中的说明,在目标远程主机上配置对 SSH 服务器的访问,并确保该服务器正在运行。

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

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

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

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

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

  2. 点击 浏览按钮 ,位于 Node 运行时 字段旁边。

    添加运行时 - 浏览按钮
  3. 在包含所有当前已配置运行时列表的 Node.js Runtimes 对话框中,点击工具栏上的 添加按钮 ,并从上下文菜单中选择 添加远程

    通过 SSH 配置 Node.js 运行时:添加远程
  4. 在打开的 配置 Node.js 远程运行时对话框 中,选择 SSH

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

    通过 SSH 配置远程 Node.js 运行时:选择 SSH 配置

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

  6. 点击 确定 以返回 Node.js 解释器 对话框,此时新运行时已添加到列表中。

    远程运行时对话框:通过 SSH 的新 Node.js 运行时已添加到列表
  7. 要将新配置的运行时设置为项目默认,请在列表中选择它并点击 确定 返回 JavaScript 运行时 对话框。

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

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

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

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

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

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

  2. 点击 浏览按钮 ,位于 Node 运行时 字段旁边。

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

    将打开 Node.js Runtimes 对话框。

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

    通过 SSH 的 Node.js:运行/调试配置、配置运行时、选择 添加远程
  4. 按照 上述说明 通过 SSH 配置远程 Node.js 运行时。

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

开始之前

  1. 设置 | 插件 页的 Marketplace 选项卡上安装 Node.jsNode.js Remote Interpreter 插件,具体请参见 从 JetBrains Marketplace 安装插件

  2. 请确保在设置中启用了 Docker 插件。 按 Ctrl+Alt+S 打开设置,然后选择 插件。 点击 已安装 选项卡。 在搜索字段中,输入 Docker。 有关插件的更多信息,请参见 管理插件

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

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

建议在 设置 对话框中配置远程 Node.js 运行时。 在这种情况下,您可以将该运行时及其关联的包管理器设置为项目默认。 因此,您不仅可以在 Docker 中使用已配置的 Node.js 运行时运行并调试应用程序,还可以管理项目依赖项、运行测试,并进行代码检查。

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

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

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

    在打开的 Run/Debug Configuration: Node.js 对话框中,点击 浏览按钮 ,位于 Node 运行时 字段旁边。

  2. 在包含所有当前已配置运行时列表的 Node.js Runtimes 对话框中,点击工具栏上的 添加按钮 ,并从上下文菜单中选择 添加远程

  3. 在打开的 配置 Node.js 远程运行时对话框 中,选择 Docker 选项。

    1. 服务器 字段中,指定要使用的 Docker 配置。 有关详细信息,请参见 使用 Docker:流程概述。 从列表中选择一个配置,或者点击 浏览按钮 ,并在打开的 Docker 页面 上创建新配置。

    2. 镜像名称 字段中,指定要使用的基础 Docker 镜像。 从列表中选择先前下载的镜像之一或您的自定义镜像,或者手动输入镜像名称,例如 node:argonmhart/alpine-node。 稍后启动运行配置时,Docker 将在您的计算机上搜索指定的镜像。 如果搜索失败,将从 Docker 注册表页面 上的 Docker 官方镜像 仓库下载该镜像。

    3. Node.js 运行时路径 字段显示指定镜像中默认 Node.js 运行时的位置。

    4. 当您点击 确定 时,PyCharm 将关闭 配置 Node.js 远程解释器 对话框,并将您带到 Node.js Runtimes 对话框,在那里新的运行时配置会添加到列表中。 点击 确定 以返回到运行配置。

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

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

  2. 点击 浏览按钮 ,位于 Node 运行时 字段旁边。 将打开 Node.js Runtimes 对话框。

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

    Node.js 与 Docker:运行/调试配置、配置运行时、选择 添加远程
  4. 按照 上述说明 配置远程 Node.js 运行时。

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

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

开始之前

  1. 设置 | 插件 页的 Marketplace 选项卡上安装 Node.jsNode.js Remote Interpreter 插件,具体请参见 从 JetBrains Marketplace 安装插件

  2. 请确保在设置中启用了 Docker 插件。 按 Ctrl+Alt+S 打开设置,然后选择 插件。 点击 已安装 选项卡。 在搜索字段中,输入 Docker。 有关插件的更多信息,请参见 管理插件

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

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

建议在 设置 对话框中配置远程 Node.js 运行时。 在这种情况下,您可以将该运行时及其关联的包管理器设置为项目默认。 因此,您不仅可以在 Docker 中使用已配置的 Node.js 运行时运行并调试应用程序,还可以管理项目依赖项、运行测试,并进行代码检查。 参见下文的 在 Docker 中使用 npm、pnpm 和 yarn测试应用程序在 Docker 中使用 ESLint

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

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

  2. 点击 浏览按钮 ,位于 Node 运行时 字段旁边。

    添加运行时 - 浏览按钮
  3. 在包含所有当前已配置运行时列表的 Node.js Runtimes 对话框中,点击工具栏上的 添加按钮 ,并从上下文菜单中选择 添加远程

    在 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 解释器 对话框,此时新运行时已添加到列表中。 要将新配置的运行时设置为项目默认,请在列表中选择它并点击 确定 返回 JavaScript 运行时 对话框。

    远程运行时对话框:在 Docker 中的新 Node.js 运行时已添加到列表

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

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

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

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

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

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

  2. 确保在 首选运行时 列表中选择了 Node.js

    选择首选运行时
  3. Node 运行时 列表中,选择要在当前项目中默认使用的配置。

    选择默认的 Node.js 配置
  4. 包管理器 列表中,选择与要使用的包管理器关联的别名。 PyCharm 会自动检测其位置。

    设置:已将新配置的远程 Node.js 运行时选为默认

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

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

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

      1. 通过 npm 安装时为 /usr/local/lib/node_modules/pnpm

      2. 通过 curl(curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm )安装时为 /usr/local/pnpm-global/<version>/node_modules/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 运行时 列表中,选择相应的通过 Docker Compose 的远程 Node.js 运行时。

    Node.js 与 Docker Compose:运行/调试配置、选择解释器

    或者,点击 浏览按钮 ,位于 Node 运行时 字段旁边。 并配置远程 Node.js 运行时, 如上所述

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

    选中 命令预览

    Docker Compose 区域预览
最后修改日期: 2025年 12月 2日