WebStorm 2021.1 Help

运行/调试配置:Node.js

运行 | 编辑配置 | 添加新配置 | 节点.js

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

  • 节点.js 10

  • 节点.js 12

  • 节点.js 14

  • 节点.js 15

从支持的 Node.js 版本了解更多信息。

此页面描述了特定于配置的项目以及所有运行/调试配置通用的选项。要了解如何使用此配置,请参阅运行和调试 Node.js。

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

在你开始前

下载并安装Node.js。

配置选项卡

物品

描述

节点解释器

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

节点参数

在此字段中,键入要传递给 Node.js 可执行文件的特定于 Node.js 的命令行选项。最常见的选项是:

  • 用于在运行期间--require coffeescript/registerCoffeeScript文件动态编译成 JavaScript。

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

  • 当您使用 Node.js v7 获得Chrome 调试协议支持时使用--inspect或参数。否则,默认情况下调试过程将使用V8 调试协议--inspect-brk

有关完整列表,请参阅Node.js 命令行选项

工作目录

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

JavaScript 文件

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

如果要调试 CoffeeScript,请使用源映射指定生成的 JavaScript 文件的路径。该文件可以在外部生成,也可以通过使用 File Watchers 进行编译来生成。有关更多详细信息,请参阅调试 CoffeeScript

应用参数

在此字段中,键入要在启动时通过process.argv数组传递给应用程序的特定于 Node.js 的参数。

环境变量

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

  • 要定义新变量,请单击添加按钮并指定变量名称和值。

  • 要放弃变量定义,请在列表中选择它并单击删除按钮

  • 点击OK,准备就绪

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

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

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

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

Docker 容器设置

手动键入设置或单击图标一般打开磁盘并在打开的“编辑 Docker 容器设置”对话框中指定设置。基本上,您需要将运行应用程序的端口与容器的端口绑定。

绑定端口:

  1. 展开端口绑定区域并单击添加按钮工具栏上的 。打开的端口绑定对话框,映射端口如下:

  2. 单击修改选项并选择要指定的选项:

    配置 Docker 容器设置:选择要指定的端口绑定选项
    • 容器端口字段中,输入您的应用程序中指定的端口。

    • 主机端口字段中,键入您希望从您的计算机访问应用程序的任意端口。

    • 主机 IP字段中,输入 Docker 主机的 IP 地址。如果您正在使用localhost,请键入127.0.0.1

      Docker:指定端口绑定
    • 单击OK返回到Edit Docker Container Settings对话框,在该对话框中新的端口绑定被添加到列表中。

    Docker:添加了端口绑定
  3. 单击确定返回到运行/调试配置:Node.js对话框,其中端口绑定显示到Docker 容器设置字段。

选项

  • 禁用网络:选中此复选框可禁用网络。这对应于--net="none",这意味着在容器内部,外部网络资源不可用。

  • 网络模式:对应选项的其他值--net

    • bridge是默认值。将为网桥网络上的容器分配一个 IP 地址,并且流量将通过此网桥路由到容器。

      默认情况下,容器可以通过其 IP 地址进行通信。要通过名称进行通信,它们必须被链接。

    • host:在容器内使用主机的网络堆栈。

    • container:<name|id>:使用另一个容器的网络堆栈,通过其名称id指定。

    有关详细信息,请参阅网络设置文档。

  • 链接:使用此部分将要创建的容器与其他容器链接。这适用于Network mode = bridge并对应于--link选项。

  • 发布所有端口:将所有容器端口公开给主机。这对应于选项--publish-all

  • 端口绑定:指定端口绑定列表。类似于使用-p带有 的选项docker run

  • 额外主机:这对应于--add-host选项。有关详细信息,请参阅管理 /etc/hosts页面。

  • 卷绑定:使用此字段指定特殊文件夹与运行 Docker 守护程序的计算机文件夹之间的绑定。这对应于-v选项。有关详细信息,请参阅管理容器中的数据。

  • 环境变量:使用此字段指定环境变量列表及其值。这对应于-e选项。有关详细信息,请参阅页面ENV(环境变量)

单击图标动作向下移动以展开表格。单击图标一般添加图标一般删除图标动作编辑组成列表。

自动配置

选中此复选框以让 WebStorm 配置容器设置。在自动配置模式下:

  • WebStorm 创建一个新图像并在其中安装npm模块。

  • WebStorm 使用新镜像运行容器,将您的项目文件夹绑定到容器中的/opt/project文件夹以确保更新同步,并将/opt/project/node_modules 映射到 OS 临时目录。

浏览器/实时编辑选项卡

在此选项卡中,配置浏览器的行为并启用调试应用程序的客户端代码。此功能是通过JavaScript Debug运行配置提供的,因此从技术上讲,WebStorm 为服务器端和客户端代码创建单独的运行配置,但您在一个专用的Node.js运行配置中指定所有设置。

打开浏览器

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

发射后

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

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

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

  • 要配置浏览器,请单击浏览按钮并调整打开的Web 浏览器和预览对话框中的设置。有关详细信息,请参阅配置浏览器

使用 JavaScript 调试器

选中此复选框以启用在选定浏览器中调试客户端代码。

V8 分析选项卡

在此选项卡中,启用V8 CPU 和内存分析

物品

描述

记录 CPU 分析信息

选中此复选框可在启动应用程序时开始记录 CPU 分析数据。下方区域中的控件变为启用状态。指定以下内容:

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

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

允许拍摄堆快照

如果您要运行内存分析,请选中此复选框。

日志选项卡

在此选项卡中,启用在运行工具窗口的控制台选项卡中显示由morgan等日志记录工具生成的信息。有关详细信息,请参阅运行 Node.js 应用程序时管理日志

常用设置

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

姓名

为运行/调试配置指定一个名称,以便在编辑或运行配置时快速识别它,例如,从运行弹出窗口Alt+Shift+F10中。

允许并行运行

选择以允许并行运行此运行配置的多个实例。

默认情况下,它是禁用的,当您在另一个实例仍在运行时启动此配置时,WebStorm 建议停止正在运行的实例并启动另一个实例。当运行/调试配置消耗大量资源并且没有充分理由运行多个实例时,这很有帮助。

存储为项目文件

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

默认情况下,它被禁用,WebStorm 将运行配置设置存储在.idea/workspace.xml中。

工具栏

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

物品

捷径

描述

添加按钮

Alt+Insert

创建运行/调试配置。

删除按钮

Alt+Delete

删除选定的运行/调试配置。请注意,您不能删除默认配置。

复制

Ctrl+D

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

保存配置

仅当您选择临时配置时才会显示该按钮。单击此按钮可将临时配置保存为永久配置。

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

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

要创建文件夹,请选择类别中的配置,单击文件夹,然后指定文件夹名称。如果仅关注一个类别,则会创建一个空文件夹。

然后,要将配置移入文件夹、文件夹之间或移出文件夹,请使用拖动或提升下移按钮。

要删除分组,请选择一个文件夹并单击删除配置

排序配置

单击此按钮可按字母顺序对配置进行排序。

发射前

在此区域中,您可以指定在开始选定的运行/调试配置之前要执行的任务。任务按照它们在列表中出现的顺序执行。

物品

捷径

描述

添加按钮

Alt+Insert

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

  • 启动 Web 浏览器:选择此选项以启动浏览器。在打开的对话框中,选择浏览器类型并提供起始 URL。此外,指定是否希望使用 JavaScript 调试器启动浏览器。

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

  • 运行另一个配置:选择执行另一个运行/调试配置。在打开的对话框中,选择要运行的配置。

  • 运行文件观察器:选择此选项让 WebStorm 应用所有当前活动的文件观察器。

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

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

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

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

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

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

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

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

    在打开的NPM 脚本对话框中,指定npm 运行/调试配置设置

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

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

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

  • 生成 CoffeeScript Source Maps:选择此选项可为您的CoffeeScript源生成源映射。在打开的对话框中,指定 CoffeeScript 源文件的位置。

删除按钮

Alt+Delete

单击此图标可从列表中删除选定的任务。

编辑

Enter

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

方法向上/方法向下

Alt+Up/Alt+Down

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

显示此页面

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

激活工具窗口

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

否则,如果清除该复选框,则隐藏工具窗口。但是,在配置运行时,您可以通过按Alt+4或自行为其打开相应的工具窗口Alt+5

最后修改:2021 年 12 月 20 日