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

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

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

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

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