WebStorm 2025.2 Help

运行/调试配置:Node.js

创建: 运行(U) | 编辑配置(E) | 添加新配置| Node.js

WebStorm 2023.3 及更高版本支持以下 Node.js 版本:

  • Node.js 20 - 当前长期支持 (LTS) 版本

  • Node.js 21 - 当前版本

详细信息请参见 支持的 Node.js 版本

本页面介绍了此配置特有的项目以及适用于所有运行/调试配置的 选项。 有关使用该配置的更多信息,请参见 运行与调试 Node.js

在此对话框中,创建用于在计算机上同时启动调试器和 Node.js 应用程序的配置。

开始之前

下载并安装 Node.js

配置选项卡

项目

说明

Node 解释器

在该字段中,指定要使用的 Node.js 解释器。 这可以是 本地远程的 Node.js 解释器,也可以是 Windows 子系统上的 Node.js。 从列表中选择一个解释器,或单击 浏览按钮 ,在打开的对话框中配置新解释器。

Node 参数

在该字段中输入要传递给 Node.js 可执行文件的特定命令行选项。 最常见的选项有:

  • 使用 --require coffeescript/register 可让 CoffeeScript 文件在运行时即时编译为 JavaScript。

    此模式要求 register.js 文件(为 coffeescript 包的一部分)位于项目中。 因此,请确保已按 安装 CoffeeScript 编译器 中的说明在本地安装了 coffeescript 包。

  • 使用 --inspect--inspect-brk 参数以支持 Chrome 调试协议

完整列表请参见 Node.js 命令行选项

工作目录

在此字段中,指定应用程序的 工作目录。 默认情况下,该字段显示 项目根文件夹

JavaScript 文件

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

如果要调试 CoffeeScript,请指定带有 source map 的生成 JavaScript 文件的路径。 该文件可以通过外部方式生成,也可以使用 File Watchers 编译生成。 有关详细信息,请参阅 调试 CoffeeScript

应用参数

在该字段中,输入通过 process.argv 数组在启动时传递给应用的 Node.js 特定参数。

环境变量

在该字段中,指定 Node.js 可执行文件所使用的 环境变量 (如适用)。 单击 浏览 浏览按钮 可在打开的 环境变量 对话框中配置变量列表:

  • 要定义新变量,请单击 添加按钮 ,然后输入变量名称和值。

  • 要删除变量定义,请在列表中选择该变量后单击 移除按钮

  • 准备就绪后,单击 确定

变量定义显示在 环境变量 只读字段中,使用分号作为分隔符,例如:

  • NODE_PATH :以 : 为分隔符的目录列表,作为模块搜索路径的前缀。

  • NODE_MODULE_CONTEXTS :设置为 1 以在其各自的全局上下文中加载模块。

  • NODE_DISABLE_COLORS :设置为 1 以在 REPL 中禁用颜色。

Docker 容器设置

此只读字段显示端口和卷绑定。 单击 展开按钮 以打开命令预览。

Node.js 与 Docker:运行/调试配置,Docker 容器设置

Docker Compose

在此区域中,指定要传递给 Docker Compose 的命令和选项。 可接受默认设置,或者单击 展开按钮 并指定自定义设置,例如自定义 Docker Compose 标志,如 --rm--service-ports。 有关详细信息,请参阅 Docker 官方网站

请查看 命令预览

浏览器 / 实时编辑选项卡

在该标签页中,配置浏览器行为并启用调试应用的客户端代码。 该功能通过 JavaScript Debug 运行配置提供,因此 WebStorm 技术上为服务端代码和客户端代码分别创建运行配置,但您可在一个专用 Node.js 运行配置中指定所有设置。

描述

打开浏览器

在此区域的字段中,指定一个项目 HTML 文件,以根据项目根创建指向该文件的正确 URL,并在内置 Web 服务器上启动。 例如,如果选择 project_root/inner_folder/index.html ,生成的 URL 将为 http://localhost:63342/project_root/inner_folder/index.html 。 如果选中 启动后 复选框,应用启动后浏览器将自动打开该页面。 或者,您也可以手动在所选的浏览器中打开该 URL 地址页面以查看相同结果。

启动后

选中该复选框可自动打开浏览器。 从列表中选择要使用的浏览器:

  • 要使用系统默认浏览器,请选择 默认值

  • 要使用自定义浏览器,请从列表中选择它。 请注意,仅支持在 Google Chrome 和其他 基于 Chromium 的浏览器 中调试 JavaScript 客户端代码。

  • 要配置浏览器,请单击 浏览按钮 ,并在打开的 Web 浏览器及预览 对话框中进行相应设置。 有关详细信息,请参阅 配置浏览器

使用 JavaScript 调试器

选中该复选框可在所选浏览器中启用客户端代码调试。

V8 性能分析选项卡

在该标签页中启用 V8 CPU 和内存分析

描述

记录 CPU 分析信息

选中此复选框以在应用启动时开始记录 CPU 分析数据。 下方区域中的控件将被启用。 请指定以下内容:

  • 日志文件夹: 在此字段中,指定用于存储记录日志的文件夹。 性能分析数据存储在日志文件 isolate-<session number> 中。

  • 所有 isolate(V8 实例)共用一个日志文件: 选中此复选框,可为所有 V8 实例创建一个日志文件(并相应地创建一个性能分析结果视图)。 清除此复选框可为每个实例创建一个单独的文件。 Node.js 可以创建额外的 V8 实例,例如用于调试过程。

允许获取堆快照

如果准备进行内存分析,请选中此复选框。

日志选项卡

在此选项卡中启用显示由类似 morgan 等日志记录工具生成的信息,这些信息将显示在 控制台 选项卡中的 运行 工具窗口中。 如需了解详情,请参阅 Managing logs when running a Node.js app

通用设置

编辑运行配置(但不是运行配置模板)时,您可以指定以下选项:

描述

名称(N)

为运行配置指定名称,以便在编辑或运行时能快速识别。

允许多个实例(U)

允许并行运行该运行配置的多个实例。

默认情况下处于禁用状态,当您启动此配置时,若另一个实例仍在运行,WebStorm 会建议停止正在运行的实例,然后启动另一个实例。 当运行配置占用大量资源且没有充分理由同时运行多个实例时,此功能非常有用。

存储为项目文件(S)

将运行配置设置保存为文件,以便与其他团队成员共享。 默认位置是 .idea/runConfigurations 。 但是,如果您不想共享 .idea 目录,可以将配置保存到项目中的其他任何目录。

默认情况下处于禁用状态,WebStorm 会将运行配置设置存储在 .idea/workspace.xml 中。

工具栏

运行/调试配置的树状视图具有工具栏,可帮助您管理 项目 中可用的配置,并调整默认配置模板。

项目

快捷键

描述

添加按钮

Alt+Insert

创建运行/调试配置。

移除按钮

Alt+Delete

删除所选的运行/调试配置。请注意,无法删除默认配置。 请注意,无法删除默认配置。

复制

Ctrl+D

创建所选运行/调试配置的副本。请注意,可以创建默认配置的副本。 请注意,您可以创建默认配置的副本。

保存配置

仅在选择 临时配置 时显示此按钮。 单击此按钮以将临时配置保存为永久配置。

移动至新文件夹 / 创建新文件夹

移动至新文件夹 / 创建新文件夹。 您可以通过 将配置放入文件夹中来对运行/调试配置进行分组。

要创建文件夹,请选择某个类别中的配置,单击 文件夹 ,并指定文件夹名称。 如果仅选中一个类别,将创建一个空文件夹。

然后,若要将配置移动到某个文件夹、在文件夹之间移动或将其移出某个文件夹,请使用拖动操作或 上移下移 按钮。

要取消分组,请选择文件夹并单击 移除配置

配置排序

单击此按钮以按字母顺序排序配置。

启动前

在此区域,您可以指定在启动所选运行/调试配置之前要执行的任务。 任务将按照列表中的顺序依次执行。

项目

快捷键

描述

添加按钮

Alt+Insert

单击此图标以添加以下可用任务之一:

  • 启动Web 浏览器 :选择此选项以启动浏览器。 在打开的对话框中,选择浏览器类型并提供启动 URL。 还可以指定是否要通过 JavaScript 调试器启动浏览器。

  • 运行外部工具 :选择此选项以运行外部应用程序。 在打开的对话框中,选择要运行的一个或多个应用程序。 如果尚未在 WebStorm 中定义该应用程序,请添加其定义。 有关详细信息,请参阅 外部工具外部工具

  • 运行另一个配置 :选择此选项以执行另一个运行/调试配置,并在开始当前配置前等待其完成。 如果希望并行运行多个配置,请使用 复合运行/调试配置

  • 运行File Watcher :选择此选项,以便 WebStorm 应用所有当前活动的 File Watchers

  • 运行远程外部工具 :添加 remote SSH external tool

  • 运行Grunt 任务 :选择此选项以运行 Grunt 任务。

    在打开的 Grunt 任务 对话框中,指定定义所需任务的 Gruntfile.js ,选择要执行的任务,并指定要传递给 Grunt 工具的参数。

    指定 Node.js 解释器的位置、传递给它的参数以及 grunt-cli 包的路径。

  • 运行 Gulp 任务 :选择此选项以运行 Gulp 任务。

    在打开的 Gulp 任务 对话框中,指定定义所需任务的 Gulpfile.js ,选择要执行的任务,并指定传递给 Gulp 工具的参数。

    指定 Node.js 解释器的位置、传递给它的参数以及 gulp 包的路径。

  • 运行 npm 脚本 :选择此选项以执行 npm script。

    在打开的 NPM 脚本 对话框中,指定 npm run/debug configuration settings

  • 编译TypeScript :选择此选项以运行内置的 TypeScript 编译器,从而确保您对 TypeScript 代码所做的所有更改都反映在生成的 JavaScript 文件中。 在打开的 TypeScript 编译设置 对话框中,选中或取消选中 检查错误 复选框,以配置在检测到错误时编译器的行为:

    • 如果选中了 检查错误 复选框,编译器将显示所有错误,并且运行配置不会启动。

    • 如果取消选中 检查错误 复选框,编译器将显示所有检测到的错误,但仍会启动运行配置。

  • 生成CoffeeScript 源映射 :选择此选项以为 CoffeeScript 源代码生成 source map。 在打开的对话框中,指定您的 CoffeeScript 源文件的位置。

移除按钮

Alt+Delete

单击此图标以从列表中删除所选任务。

编辑

Enter

单击此图标以编辑所选任务。 在打开的对话框中进行必要的更改。

方法上移

方法下移

Alt+Up

Alt+Down

单击这些图标可将所选任务在列表中上移或下移一行。 任务将按其在列表中出现的顺序执行。

显示此页面

选中此复选框以在实际启动运行/调试配置之前显示运行/调试配置设置。

激活工具窗口

默认情况下,此复选框为选中状态,并且当您启动运行/调试配置时,将打开 RunDebug 工具窗口。

否则,如果未选中复选框,工具窗口将被隐藏。 但是,在配置运行期间,您可以按 Alt+4Alt+5 自行打开相应的工具窗口。

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