使用 Docker Compose 的 Node.js
Docker Compose 用于运行多容器应用程序。 例如,您可以将 Web 服务器、后端数据库和应用程序代码作为单独的服务运行。 如有必要,可以通过添加更多容器来扩展每个服务。 这使您能够在类似生产的动态环境中高效地进行开发和测试。
开始之前
请确保在 设置 | 插件 页面、 已安装 选项卡上启用了所需插件: JavaScript 和 TypeScript、 JavaScript 调试器、 Node.js、 Node.js 远程解释器 和 Docker。 有关更多信息,请参阅 管理插件。
在 设置 | 插件 页面、 Marketplace 选项卡上安装 Node.js 和 Node.js 远程解释器 插件,具体请参见 从 JetBrains Marketplace 安装插件。
按照 Docker 中的说明下载、安装并配置 Docker
通过 Docker Compose 配置 Node.js 运行时
Docker 中的 Node.js 运行时在 配置Node.js 远程解释器 对话框中进行配置。 您可以从 设置 对话框的 JavaScript 运行时 页面打开此对话框,或者在稍后为运行或调试应用程序而 创建或编辑 Node.js 运行/调试配置 时打开。
建议的方式是在 设置 对话框中配置远程 Node.js 运行时。 在这种情况下,您可以将该运行时及其关联的包管理器设置为项目默认。 因此,您不仅可以使用 Docker 中已配置的 Node.js 运行时运行和调试应用,还可以管理项目依赖、运行测试并进行代码检查。 请参见下文的 在 Docker 中使用 npm、pnpm 和 yarn、 测试应用程序 和 在 Docker 中使用 ESLint。
如果您在 Node.js 运行/调试配置中直接配置远程 Node.js 运行时,则该运行时只能与此运行/调试配置一起使用。
打开 设置 对话框(Ctrl+Alt+S ),然后转到 。
在 Node.js 运行时 字段旁点击
。

在列出所有当前已配置运行时的 Node.js 运行时 对话框中,点击工具栏上的
,然后在上下文菜单中选择 添加远程。

在打开的 配置 Node.js 远程运行时对话框 中,选择 Docker Compose。
在 服务器 列表中,选择要使用的 Docker 配置。

或者,点击该字段旁的 新建 ,并按照 启用 Docker 支持 中的说明配置 Docker 服务器。
在 配置文件 字段中,指定要使用的 docker-compose 配置文件。 点击 浏览 ,在打开的 Docker Compose 配置文件 对话框中创建配置文件列表。

在 服务 列表中,选择要使用的服务:

点击 确定 返回到 Node.js 解释器 对话框,新运行时已添加到列表中。 要将新配置的运行时设置为项目默认,在列表中选择它并点击 确定 返回到 JavaScript 运行时 对话框。

PyCharm 会在您每次从 Node.js 运行时 列表中选择 Project 别名时自动使用此解释器,例如在创建运行/调试配置时。
要使用与新运行时关联的包管理器来管理您的项目依赖,请将该包管理器设置为项目默认。 为此,请在 软件包管理器(M) 字段中指定该包管理器的位置。 详细了解,请参阅 在项目中指定默认的 Node.js 运行时和包管理器。
在项目中指定默认的 Node.js 运行时和包管理器
PyCharm 会在您每次从 Node.js 运行时 列表中选择 Project 别名时自动使用默认项目解释器,例如在创建运行/调试配置时。
默认项目包管理器会自动用于管理依赖,例如,当您从 package.json 文件运行 <package manager> install 或安装第三方工具(例如 ESLint、Prettier 等)时。
打开 设置 对话框(Ctrl+Alt+S ),然后转到 。
在 Node.js 运行时 列表中,选择要在当前项目中默认使用的配置。
在 包管理器 列表中,选择与要使用的包管理器关联的别名。 PyCharm 会自动检测其位置。

或者,手动指定所需包管理器的位置。
npm 可执行文件的默认位置为
/usr/local/lib/node_modules/npm。pnpm 的默认位置取决于安装方法:
通过 npm 安装时为 /usr/local/lib/node_modules/pnpm 。
通过 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 运行/调试配置
转到 。 在打开的 编辑配置 对话框中,点击工具栏上的
,然后在上下文菜单中选择 Node.js。 将打开 运行/调试配置: Node.js 对话框。
在 文件 字段中,指定用于启动应用程序的主文件路径(例如, Express 应用为 bin/www )。

如有必要,请按照 运行和调试 Node.js 应用程序 中的说明指定一些可选设置。
在 Node.js 运行时 列表中,选择通过 Docker Compose 的相应远程 Node.js 运行时。

或者,在 Node.js 运行时 字段旁点击
,并按照 如上所述 配置远程 Node.js 运行时。

在 Docker Compose 区域中,指定要传递给 Docker Compose 的命令和选项。 接受默认设置,或点击
并指定自定义设置,例如自定义 Docker Compose 标志,如
--rm或--service-ports。 详细了解,请参阅 Docker 官方网站。查看 命令预览。
