Node.js
Node.js 是一个轻量级的运行环境,用于在浏览器外部执行 JavaScript,例如在服务器上或命令行中。 WebStorm 与 Node.js 集成,提供配置、编辑、运行、调试、测试、性能分析和维护您的应用程序的帮助。
如果您只需要 Node.js 作为应用程序的本地运行时或用于管理 npm 包、运行 JavaScript 检查工具、构建工具、测试框架等,只需安装 Node.js。 如果您遵循标准安装程序,大多数情况下 WebStorm 会自行检测 Node.js。
即使您的计算机上没有 Node.js,您也可以在 新建项目对话框 创建新的 Node.js 应用程序时安装它,请参阅下文中的 创建新的 Node.js 应用程序。
如果您希望在多个 Node.js 安装之间切换,则必须将它们配置为 本地 Node.js 运行时。 在大多数情况下, WebStorm 会检测到 Node.js 安装,自动将其配置为运行时,并将其添加到列表中,您可以在其中选择相关项。
要远程运行 Node.js 应用,请将其配置为远程运行时。 有关更多信息,请参考 使用 Docker 的 Node.js、 通过 SSH 的 Node.js和 使用 Vagrant 的 Node.js。
在开始之前
在多个 Node.js 安装之间切换
通过 WebStorm,您可以安装多个 Node.js,并在同一个项目中切换使用不同版本。

按下 Ctrl+Alt+S 打开设置,然后选择 。
请确保在 Node.js 字段中选择了 首选运行时。
从 Node.js 运行时 列表中选择所需的 Node.js 安装。
如果您按照标准安装程序进行操作,在大多数情况下,所需的 Node.js 安装会在列表中。 如果缺少该安装,请点击
,然后 手动将其配置为本地运行时。
使用系统 Node.js 版本
借助 WebStorm,您可以将系统默认的 node 别名设置为项目的 Node.js 版本。 之后,该版本将自动用于所有需要 Node.js 的工具,以及所有新的运行/调试配置。 这意味着, 如果您安装了新的 Node.js 版本并将其设置为系统中的默认节点别名, 您将无需更新每个工具的设置。
按下 Ctrl+Alt+S 打开设置,然后选择 。
请确保在 Node.js 字段中选择了 首选运行时。
请从 Node.js 运行时 列表中选择 node。
在适用的位置指定此新的 Node.js 运行时,例如,在运行/调试配置或特定工具的设置中。
配置本地 Node.js 运行时
您可能需要将 Node.js 安装手动配置为运行时。例如,如果 Node.js 安装在非默认位置, WebStorm 将无法自动检测到它。
按下 Ctrl+Alt+S 打开设置,然后选择 。
请确保在 Node.js 字段中选择了 首选运行时。
在 Node.js 运行时 列表旁边点击
。
在包含所有当前已配置运行时列表的 Node.js 运行时 对话框中,点击工具栏上的
,在上下文菜单中选择 添加本地 ,并选择 Node.js 的安装,然后点击 OK。 您将返回到 Node.js 运行时 对话框,其中的 Node.js 运行时 只读字段显示新运行时的路径。
在 包管理器 字段中,为当前项目选择包管理器( npm、Yarn、pnpm、bun )。
如需更多信息,请参阅 为项目配置软件包管理器。
点击 确定 后,您将返回到 JavaScript 运行时 页面,其中的 Node.js 运行时 字段显示新运行时。
在 Windows Subsystem for Linux 上使用 Node.js
WebStorm 允许您使用 Node.js on Windows Subsystem for Linux 运行和调试 Node.js 应用程序。 您可以将 WSL 上的 Node.js 选择为 当前项目的默认运行时 ,也可以在 Node.js 运行/调试配置 中配置并使用该 Node.js 版本。
将 WSL 上的 Node.js 配置为项目的默认 Node.js 运行时
在 设置 对话框(Ctrl+Alt+S ),转到 。
点击
,该控件位于 Node.js 运行时 字段旁;在打开的 Node.js 运行时 对话框中,点击
,然后从列表中选择 添加 WSL。

在打开的 添加 WSL Node.js 运行时 对话框中,选择您正在使用的 Linux 发行版并指定 Node.js 的路径。

创建 Node.js 应用程序
如果 您 还没有应用程序,您可以从模板生成带有 Node.js 特定结构的 一个 WebStorm 项目或创建一个空的 WebStorm 项目,并按照下面 从现有 Node.js 应用程序开始 的描述配置 Node.js。
创建一个新的 Node.js 应用程序
点击 新建项目 屏幕上的 欢迎 或从主菜单中选择 。 将打开 新建 项目 对话框。
在左侧窗格中,选择 Node.js 以创建一个基本的 Node.js 应用程序,或选择 Express 以创建一个 Express 应用程序。
在右侧窗格中,指定项目文件夹和要使用的 Node.js 运行时。 有关更多信息,请参阅 配置本地 Node.js 运行时。
如果您的计算机上只有一个 Node.js,并且您遵循了标准安装程序,WebStorm 会自动检测到您的 Node.js。 否则,从列表中选择相关的运行时,参见上文 配置本地 Node.js 运行时。
如果您没有安装 Node.js,请选择 下载 Node.js。

对于 Express 应用程序,请在 express-generator 字段中指定 express -generator。
建议您使用 npx ,它会下载并运行生成器。 为此,请从 npx --package express-generator express 列表中选择 express -generator。
或者,打开嵌入的 终端 (Alt+F12 ),输入
npm install --g express-generator,然后从 express-generator 列表中选择下载的生成器。
选择要使用的模板语言和样式表语言。
当您点击 创建 时,WebStorm 会下载必要的依赖项,并为它们以及 Node.js 核心 API 启用代码补全。 有关更多信息,请参阅 Configuring node_modules library和 Configuring Node.js Core library。
对于 Express ,WebStorm 会创建一个类型为 Node.js的运行/调试配置,使用默认设置,并生成 基本的 Express 特定目录结构。
对于 Node.js ,WebStorm 仅运行
npm init命令以生成 package.json 文件。
创建一个空的 WebStorm 项目
点击 新建项目 屏幕上的 欢迎 或从主菜单中选择 。 将打开 新建 项目 对话框。
在左侧窗格中,选择 空 项目。 在右侧窗格中,指定应用程序文件夹并点击 创建。
从现有的 Node.js 应用程序开始
如果您将继续开发现有的 Node.js 应用程序,请在 WebStorm 中打开它,配置 Node.js,并下载所需的依赖项。
打开您计算机上已有的应用程序源代码
点击 打开 屏幕上的 欢迎 或从主菜单中选择 。 在打开的对话框中,选择存储源文件的文件夹。
从您的版本控制系统检出应用程序源代码
在 欢迎 屏幕上点击 克隆存储库。
或者,从主菜单中选择 、 或 。
在主菜单中,您可能会看到与您的项目关联的其他任何版本控制系统,而不是 Git。 例如, Mercurial 或 Perforce。
在打开的对话框中,从列表中选择您的版本控制系统,并指定要从中检出应用程序源代码的存储库。 有关更多信息,请参阅 检出项目(克隆)。
在项目中配置 Node.js
在 设置 对话框(Ctrl+Alt+S ),转到 。
在 Node.js 运行时 字段中,指定当前项目的默认 Node.js 运行时。 每当您从 Node.js 运行时 列表中选择
Project别名时,例如创建运行/调试配置时,WebStorm会自动使用它。从列表中选择已配置的运行时,或点击
并在打开的对话框中按照 配置本地 Node.js 运行时 中的说明配置一个新的运行时。 如果您选择 node ,将使用 系统 Node.js 版本。
选中 为 Node.js 提供编码辅助 复选框,以将 Node.js Core模块源配置为 JavaScript 库 ,并将其与您的项目关联。 因此,WebStorm 提供了代码补全、引用解析、验证以及调试功能用于
fs、path、http以及编译成 Node.js 二进制文件的 Node.js 其他部分。配置完成后,WebStorm 会显示当前配置版本的信息。
如果您只需要在项目的某些部分为 Node.js API 提供代码补全,可以使用 管理范围 链接进行配置。 在打开的 用法对话框 中,点击相关目录,并为每个目录在列表中选择已配置的 Node.js Core 库。 请从 配置库的作用域 了解更多信息。
下载项目依赖项
在内置的 终端 (Alt+F12 )中,输入:
npm install或者,从项目根目录下 package.json 文件的上下文菜单中选择 运行 'npm install'。
项目安全性
当您打开一个在 WebStorm 外部创建并导入到其中的项目时,WebStorm 会显示一个对话框,您可以在其中决定如何处理包含不熟悉的源代码的项目。

请选择以下选项之一:
安全模式中预览 :在这种情况下,WebStorm 以预览模式打开项目。 这意味着您可以浏览项目的源代码,但无法运行任务和脚本,也无法运行或调试您的项目。
WebStorm 会在编辑器区域顶部显示一条通知,您可以点击 信任项目… 链接,随时加载您的项目。
信任项目 :在这种情况下,WebStorm 会打开并加载一个项目。 这意味着项目已经初始化,项目的插件已解析,依赖项已添加,并且所有 WebStorm 功能都可用。
不打开 :在这种情况下,WebStorm 不会打开项目。
有关更多信息,请参阅 项目安全。