PyCharm 2025.2 Help

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 安装之间切换,则它们必须配置为 local Node.js interpreters。 在大多数情况下,PyCharm 会检测 Node.js 安装,自动将其配置为解释器,并将其添加到您可以选择相关解释器的列表中。

要远程运行 Node.js 应用程序,请将其配置为远程解释器。 有关更多信息,请参考 使用 Docker 的 Node.js通过 SSH 的 Node.js使用 Vagrant 的 Node.js

开始之前

  1. 请确保您的计算机上安装了 Node.js

  2. 确保在 JavaScript and TypeScriptNode.js必需插件在 设置 | 插件 页面的 已安装 标签页上启用。 如需了解更多信息,请参阅 管理插件

在 Node.js 版本之间切换

通过 PyCharm,您可以安装多个 Node.js,并在同一个项目中切换使用不同版本。

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 语言与框架 | Node.js

  2. Node Interpreter 列表中选择所需的 Node.js 安装。

    如果您按照标准安装程序进行操作,在大多数情况下,所需的 Node.js 安装会在列表中。 如果缺少安装,请点击 “浏览”按钮手动将其配置为本地解释器

使用系统 Node.js 版本

使用 PyCharm,您可以将默认系统节点别名设置为您的项目的 Node.js 版本。 之后,该版本将自动用于所有需要 Node.js 的工具,以及所有新的运行/调试配置。 这意味着, 如果您安装了新的 Node.js 版本并将其设置为系统中的默认节点别名, 您将无需更新每个工具的设置。

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 语言与框架 | Node.js

  2. Node 解释器 列表中选择 node

    默认系统节点
  3. 请在适用的地方指定这个新的 Node.js 解释器,例如在您的运行/调试配置或特定工具的设置中。

配置本地 Node.js 解释器

如果 Node.js 安装在非默认位置并且 PyCharm 无法自动检测到,您可能需要手动配置 Node.js 安装作为解释器。

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 语言与框架 | Node.js

  2. 点击 “浏览”按钮 列表旁的 Node Interpreter

  3. 在包含所有当前配置解释器列表的 Node.js 解释器 对话框中,点击工具栏上的 添加按钮 ,并从上下文菜单中选择 添加本地 ,选择 Node.js 的安装,然后点击 确定。 您返回到 Node.js Interpreters 对话框,此时 Node 解释器 只读字段显示新解释器的路径。

  4. 包管理器 字段中,为当前项目选择包管理器(npm、Yarn 或 pnpm)。

    如需更多信息,请参阅 为项目配置软件包管理器

当您点击 确定 时,您将返回 Node.js 页面, Node 解释器 字段将显示新的解释器。

在 Windows Subsystem for Linux 上使用 Node.js

PyCharm 允许您使用 Node.js on Windows Subsystem for Linux 运行和调试 Node.js 应用程序。 您可以在 WSL 上选择 Node.js 作为 当前项目的默认解释器 ,或者您可以在 Node.js 运行/调试配置中配置并使用此 Node.js 版本。

在 WSL 上配置 Node.js 作为默认项目节点解释器

  1. 设置 对话框(Ctrl+Alt+S )中,转到 语言和框架 | Node.js

  2. 点击 “浏览”按钮 旁边的 Node Interpreter 字段,在打开的 Node.js 解释器 对话框中,点击 添加按钮 ,然后从列表中选择 添加 WSL

    配置 WSL Node.js 解释器:添加 WSL
  3. 在打开的 添加 WSL Node 解释器 对话框中,选择您正在使用的 Linux 发行版并指定 Node.js 的路径。

    在 WSL 上将 Node.js 配置为默认项目节点解释器

创建 Node.js 应用程序

如果 您 还没有应用程序,您可以从模板生成带有 Node.js 特定结构的 一个 PyCharm 项目或创建一个空的 PyCharm 项目,并按照下面 从现有 Node.js 应用程序开始 的描述配置 Node.js。

创建一个新的 Node.js 应用程序

  1. 点击 创建新项目 屏幕上的 欢迎 或从主菜单中选择 文件 | 新建 | 项目新建 项目 对话框 打开。

  2. 在左侧窗格中,选择 Node.js 以创建一个基本的 Node.js 应用程序,或选择 Express 以创建一个 Express 应用程序。

  3. 在右侧窗格中,指定项目文件夹和要使用的 Node.js 解释器。 欲了解更多信息,请参阅 配置本地 Node.js 解释器

    如果您的计算机上只有一个 Node.js,并且您遵循了标准安装程序,PyCharm 会自动检测到您的 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 列表中选择下载的生成器。

    选择 express generator

    选择要使用的模板语言和样式表语言。

  4. 当您点击 创建 时,PyCharm 会下载必要的依赖项,并为它们以及 Node.js 核心 API 启用代码补全。 有关更多信息,请参阅 Configuring node_modules libraryConfiguring Node.js Core library

    对于 Express ,PyCharm 会创建一个类型为 Node.js的运行/调试配置,使用默认设置,并生成 基本的 Express 特定目录结构

    对于 Node.js ,PyCharm 仅运行 npm init 命令以生成 package.json 文件。

创建一个空的 PyCharm 项目

  1. 点击 创建新项目 屏幕上的 欢迎 或从主菜单中选择 文件 | 新建 | 项目新建 项目 对话框 打开。

  2. 在左侧窗格中,选择 空的 项目。 在右侧窗格中,指定应用程序文件夹并点击 创建

从现有的 Node.js 应用程序开始

如果您将继续开发现有的 Node.js 应用程序,请在 PyCharm 中打开它,配置 Node.js,并下载所需的依赖项。

打开您机器上已有的应用程序源代码

  • 点击 打开 屏幕上的 欢迎 或从主菜单中选择 文件 | 打开。 在打开的对话框中,选择存储源文件的文件夹。

从您的版本控制中检出应用程序源代码

  1. 欢迎 屏幕上点击 克隆仓库克隆

    或者,从主菜单中选择 文件|新建| 来自版本控制的项目…Git | 克隆…VCS | 从版本控制系统获取

    您可能会看到与您的项目相关联的其他版本控制系统,而不是在主菜单中的 Git。 例如, MercurialPerforce

  2. 在打开的对话框中,从列表中选择您的版本控制系统,并指定要从中检出的应用程序源代码的存储库。 如需了解更多信息,请参见 Check out a project (clone)

在项目中配置 Node.js

  1. 设置 对话框(Ctrl+Alt+S )中,转到 语言和框架 | Node.js

  2. Node Interpreter 字段中,指定当前项目的默认 Node.js 解释器。 每当您从 Node Interpreter 列表中选择 Project 别名时,例如创建运行/调试配置时,PyCharm会自动使用它。

    从列表中选择一个已配置的解释器或点击 “浏览”按钮 ,并按照 配置本地 Node.js 解释器中所述在打开的对话框中配置一个新的解释器。 如果您选择 node ,则使用 系统 Node.js 版本

  3. 选择 Node.js 的编码辅助功能 复选框,将 Node.js 核心 模块源配置为 JavaScript 库 ,并将其与您的项目关联。 因此,PyCharm 提供了代码补全、引用解析、验证以及调试功能用于 fspathhttp 以及编译成 Node.js 二进制文件的 Node.js 其他部分。

    配置完成后,PyCharm 会显示有关当前配置版本的信息。

  4. 如果您只需要在项目的某些部分为 Node.js API 提供代码补全,可以使用 管理范围 链接进行配置。 在打开的 使用对话框中,点击相关目录,并为每个目录从列表中选择配置的 Node.js Core 库。 从 配置库的范围中了解更多。

下载项目依赖项

  • 在嵌入的 终端 (Alt+F12 )中,输入:

    npm install

  • 或者,从项目根目录中的 运行 'npm install' 文件上下文菜单中选择 package.json

项目安全性

当您打开一个在 PyCharm 之外创建并导入到 PyCharm 的项目时,PyCharm 会显示一个对话框,您可以在其中决定如何处理这个具有不熟悉源代码的项目。

不受信任的项目警告

请选择以下选项之一:

  • 在安全模式下预览 :在这种情况下,PyCharm 以预览模式打开项目。 这意味着您可以浏览项目的源代码,但不能运行任务和脚本或运行/调试您的项目。

    PyCharm 会在编辑器区域顶部显示一条通知,您可以随时点击 信任项目… 链接并加载您的项目。

  • 信任项目 :在这种情况下,PyCharm 会打开并加载一个项目。 这意味着项目已经初始化,项目的插件已解析,依赖项已添加,并且所有 PyCharm 功能都可用。

  • 请勿打开 :在这种情况下,PyCharm 不会打开项目。

请从 项目安全 了解更多。

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