GoLand 2025.2 Help

npm、pnpm 和 Yarn

GoLand 集成了 npmpnpmYarnYarn 2 、Yarn 3 和 Bun。 因此,您可以在 IDE 的内置 终端 中安装、定位、更新和移除可复用代码包。

GoLand 还允许您运行和调试 npm、Yarn 和 pnpm 脚本。 GoLand 会解析 package.json 文件,识别脚本定义,以树状视图显示脚本,并允许您在树中脚本与其在 package.json 文件中的定义之间导航。 有关更多信息,请参阅 npmYarnpnpm 官方网站。

GoLand 可检测包含 Yarn workspaces 的项目,并索引列在 workspace 的 package.json 文件中但位于根 node_modules 文件夹中的所有依赖项。

开始之前

  • 下载并安装 Node.js。 请注意,npm 也已安装,因此如果您打算使用它,则前期准备步骤已经完成。

  • 要使用 Yarn,请按照 Yarn 官方网站 上的说明进行安装。

  • 要使用 pnpm,请打开嵌入式 终端Alt+F12 )并输入:

    npm install --g pnpm

    请访问 pnpm 官方网站 了解更多信息。

  • 要使用 Bun,请按照 Bun 官方网站 上的说明进行安装。

选择项目包管理器

使用 GoLand,您可以在项目中选择使用 npm、Yarn、Yarn 2、Bun 或 pnpm。

默认情况下,GoLand 建议使用 npm。 但是,如果您打开的项目包含 yarn.lock 文件,且计算机上已安装 Yarn,GoLand 会自动将该项目的包管理器切换为 Yarn。

同样地,如果您打开的项目包含 pnpm-lock 文件,且计算机上已安装 pnpm,GoLand 会自动将该项目的包管理器切换为 pnpm。

如果项目包含 bun.lock bun.lockb 文件,且计算机上已安装 Bun,GoLand 会建议您在当前项目中使用 Bun,而不是 npm。

您还可以 将 Yarn 1 或 pnpm 设置为默认 GoLand 包管理器

  1. 设置 对话框(Ctrl+Alt+S )中,转到 Languages & Frameworks | Node.jsNode.js 页面将打开。

  2. 包管理器 字段中,为您的项目指定包管理器。

    选择项目包管理器:选择系统默认安装
    • 选择 npmyarnpnpmbun 以使用系统默认安装。

    • 要使用自定义安装的包管理器,请单击 选择 ,并选择相关包管理器的安装文件夹。

      选择项目包管理器:选择自定义安装

    当您在 Run/Debug Configuration: NPM 对话框的 包管理器 列表中选择 项目 别名时,GoLand 会自动使用所选包管理器。 GoLand 还会在每次调用 运行 'npm install'运行 'yarn install'运行 'pnpm install' 命令或运行 npm/Yarn/pnpm 脚本时使用所选包管理器的路径。 如需了解详情,请参阅 运行和调试脚本

为新项目设置默认 GoLand 包管理器

  1. 打开 新建项目的设置 对话框(文件 | 新建项目设置 | 新建项目的 设置 ),然后转到 语言与框架 | Node.js

  2. 在打开的 Node.js 与 NPM 页面中,从列表中选择所需的包管理器。

之后,GoLand 会在每次创建新项目时建议将所选包管理器作为默认选项。

在项目中设置 Yarn 2

  1. 请确保 Yarn 1 已全局安装,并根据 Yarn 官方网站中的说明在项目中启用 Yarn 2。 使用嵌套的 终端 Alt+F12 输入命令。

  2. 设置 对话框(Ctrl+Alt+S )中,转到 语言与框架 | Node.js ,并从 包管理器 列表中选择项目中 Yarn 2 包的路径。

编辑 package.json

GoLand 可帮助您在 package.json 文件中处理项目依赖项,提供全面的编码支持。

  • 包名称的代码补全。

    包名称的代码补全
  • 有关可用最新包版本的信息。

    显示最新可用包版本
  • 有关可通过 npm install <package>@<version>yarn add <package>@<version> 安装的版本范围的信息。 请注意,运行 npm installyarn install 将安装该范围内的最新可用版本。

    按下 Ctrl 并将鼠标悬停在版本上,即可在工具提示中查看相关信息。 有关语义版本控制的详情,请参阅 npm 官方文档

    显示可用包版本范围
  • 指出指定版本的包是否已安装,以及最新可用版本的信息

    显示是否已安装该包版本的信息
  • 旧包版本的代码补全。 当您按下 Ctrl+Space 或开始输入不同于最新版本的版本号时,GoLand 会显示包含所有旧版本的建议列表。

    先前包版本的代码补全
  • 组件包的快速文档查阅。

    快速查阅包文档

安装和更新包

如您所知,npm 可将包安装为 全局项目依赖项开发依赖项 ,更多信息请参阅 npm 官方网站

pnpm 也可以将包安装为 全局项目依赖项开发依赖项 ,更多信息请参阅 pnpm 官方网站

使用 Yarn,您可以将包安装为 全局项目依赖项。 如需了解详情,请参阅 Yarn 官方网站

在 GoLand 中,包可以在编辑器中、从 package.json 文件、在内置的 终端 Alt+F12 中,或在 Node.js 页面中安装。

从 package.json

安装项目依赖项

  • 单击弹窗中的 运行 'npm install'运行 'yarn install'运行 'pnpm install' 链接:

    安装依赖项弹窗

    当依赖项尚未安装或已发生更改时,GoLand 会显示此弹窗。 如果您关闭弹窗或通过选择 不再询问 将其关闭,仍然可以使用 运行 '<package_manager> install' 操作或 在内置终端中安装依赖项。

    如果 GoLand 无法检测到 Node.js 解释器,将在弹窗中报告错误,并提供一个链接,指向 Node.js 页面,您可以在该页面 配置 Node.js 解释器

    找不到 Node.js

    如果您不小心关闭了此通知,现在希望恢复,请按 Ctrl+Shift+A ,开始输入 启用通知 ,并从列表中选择 启用有关从package.json 安装依赖项的通知

  • 或者,打开编辑器中的相关 package.json 文件,或在 项目 工具窗口中选择该文件,并从上下文菜单中选择 运行 'npm install'

更新项目依赖项

  • 单击弹窗中的 运行 '<package manager> install'

    更新依赖项:弹窗

    每当您打开项目、从版本控制中更新项目或编辑 package.json 时,GoLand 都会显示此弹窗。

  • GoLand 还会运行一次检查,确认来自 dependenciesdevDependencies 的包是否已安装,并且其版本是否符合指定范围。 如果检查检测到不匹配内容,会建议使用快速修复方式。 要应用此修复,请单击 运行 '<package manager> install' 链接。

    已安装的包版本不是最新的
  • GoLand 还会检测当前包是否存在更新版本,在您将鼠标悬停在包版本上时提供快速修复。

    将包更新为最新版本:工具提示

    或者,按下 Alt+Enter 并从列表中选择 将 <package> 更新为最新版本

    将包更新为最新版本:快速修复

在内置终端中

在嵌套的 终端Alt+F12 )中,输入以下命令之一:

  • 用于全局安装:

    • npm install&#xa0;--global <package_name>

    • yarn global add <package_name>

    • pnpm --global add <package_name>

  • 将组件包安装为项目依赖或开发依赖:

    • npm install&#xa0;--save <package_name>npm install&#xa0;--save-dev <package_name>

    • yarn add <package_name> --dev

    • pnpm add --save-dev <package_name>

安装 package.json 文件中列出的所有依赖项

在嵌入的 终端Alt+F12 )中,键入以下命令之一:

  • npm install

  • yarn install

  • pnpm install

结果,您将从当前文件夹获取在 package.json 中列出的所有依赖项。 详细了解 编辑 package.json

检测存在漏洞的包

GoLand 通过对比 Mend.io 漏洞数据库国家漏洞数据库 ,检测项目中所用包的漏洞。 在编写代码时,IDE 会突出显示被认为存在漏洞的包,提供相关描述并在可用时建议修复。 检测到的所有存在漏洞的包将在 问题 工具窗口中显示。

漏洞检查由依赖于 Package Checker 插件的 声明存在漏洞的依赖 代码检查执行。 该插件由 Mend.io 提供支持。 该插件随 GoLand 一同提供,并默认启用。 如果未提供相关功能,请确保未禁用该插件。 有关详细信息,请参阅 打开插件设置

检测存在漏洞的包并在编辑器中修复

在编辑器中解决包漏洞问题

  • 将鼠标悬停在 package.json 文件中高亮显示的包上。 弹出工具窗口显示检测到的漏洞的描述。

  • 要应用快速修复,请点击 更多操作 Alt+Enter 并选择相关建议。

在“问题”工具窗口中查看存在漏洞的包

  1. 在检查工具栏中点击 “问题”图标

  2. 文件 选项卡中的 问题 工具窗口列出了当前活动编辑器标签中打开的 package.json 中的所有存在漏洞的包。 每个条目都附有描述。

    要解决问题,请在列表中选择存在漏洞的包,点击工具栏上的 黄色灯泡图标 或按下 Alt+Enter ,然后选择相关建议。

  3. 存在漏洞的依赖项 选项卡列出了项目中检测到的所有存在漏洞的包。

    “问题”工具窗口:漏洞依赖项选项卡

    要修复问题,请在列表中选择存在漏洞的包,点击右侧窗格中的 复制安全版本到剪贴板 链接,然后将复制的版本粘贴到您的 package.json 中。

    详细了解 查看结果并修复问题

禁用包漏洞检查

默认情况下,会启用包漏洞检查。

  • 要将其关闭,请打开 设置 对话框(Ctrl+Alt+S ),转到 编辑器 | 检查 ,然后在 安全性 节点下清除 存在漏洞的声明依赖 检查项旁的复选框。

  • 或者,打开 设置 对话框(Ctrl+Alt+S ),转到 插件 ,找到 包检查器 插件,然后点击 禁用

运行和调试脚本

您可以从编辑器中的 package.json 文件、专用 npm 工具窗口中的脚本树、通过专用运行配置或自动以 启动启动前 任务方式来运行 npm、Yarn 或 pnpm 脚本。

脚本执行结果显示在 运行工具窗口 中。 该工具窗口显示 npm 或 Yarn 脚本输出、报告发生的错误、列出未找到的包或插件等。 上次执行的脚本名称显示在工具窗口的标题栏中。

如果启动了脚本调试会话,GoLand 会打开 调试工具窗口 ,在此窗口中,您可以 逐步执行脚本暂停并恢复脚本执行、 在挂起状态下检查脚本、在调试器控制台中 运行 JavaScript 代码片段等。

从 package.json 运行和调试脚本

GoLand 允许您从 package.json 文件快速启动单个脚本。 要运行或调试多个脚本,请使用运行配置或 npm 工具窗口。

  • 在编辑器中打开相关的 package.json 文件,点击脚本旁边标记栏中的 运行按钮 ,然后从上下文菜单中选择 运行 <script_name>调试 <script_name>

    从 package.json 运行/调试脚本
  • 您也可以按下 Ctrl+Shift+F10 来运行脚本。

脚本输出显示在 运行 工具窗口中。

如果在调试模式下启动脚本,GoLand 会打开 调试工具窗口 ,在其中,您可以 单步执行脚本中止与恢复脚本执行、 在暂停状态下检查脚本在调试器控制台中运行 JavaScript 代码片段等操作。

从 npm 工具窗口运行和调试脚本

当您在 项目 工具窗口中选择 package.json 文件 Alt+1 或在编辑器中打开该文件并从上下文菜单中选择 显示 npm 脚本 时,将打开 npm 工具窗口。

一旦调用 npm、pnpm 或 Yarn,该工具将开始构建在 scripts 属性中定义的脚本树,基于所调用的 package.json 文件。

如果您的项目中包含多个 package.json 文件,您可以分别为每个文件构建独立的脚本树,并在不删除先前构建树的情况下运行脚本。 每个脚本树都会显示在单独的节点下。

打开 npm 工具窗口(如尚未打开)

  • 项目 工具窗口中选择所需的 文件 Alt+1 ,或在编辑器中打开该文件并从上下文菜单中选择 显示 npm 脚本

    打开 nmp 工具窗口

    将打开 npm 工具窗口,显示根据所选择或所打开的 package.json 文件构建的脚本树。

在已打开的 npm 工具窗口中构建脚本树

  1. npm 工具窗口中,点击工具栏上的 添加按钮 ,然后从列表中选择所需的 package.json 文件。 默认情况下,GoLand 会在项目根目录中显示 package.json 文件。

  2. 如果您还有另一个 package.json 文件,请点击 选择 package.json ,然后在打开的对话框中选择所需的 package.json 文件。 GoLand 会添加一个新节点,在其标题中显示所选 package.json 文件的路径,并在该节点下构建一个脚本树。

构建另一个脚本树

重新构建树

  • 切换到所需节点并点击工具栏上的 重新加载脚本

按名称对树中的脚本进行排序

  • 点击工具栏上的 设置 ,从菜单中选择 排序方式 ,然后选择 名称

    默认情况下,脚本树以它们在 package.json 中定义的顺序显示(选项 定义顺序)。

运行单个脚本

  • 双击脚本。

  • 在脚本树中选择脚本,按下 Enter ,或从上下文菜单中选择 运行 <script name>

调试单个脚本

运行或调试多个脚本

  • 使用多选模式:按住 Shift (用于相邻项)或 Ctrl (用于不相邻项)键并选择所需脚本,然后从所选内容的上下文菜单中选择 运行调试

    运行多个脚本

通过运行配置运行和调试脚本

从编辑器或 npm 工具窗口运行或调试脚本时,GoLand 会自动创建 临时运行配置。 除了使用这些配置,您还可以创建并启动自己的 npm 运行配置。

创建 NPM 运行/调试配置

  1. 转到 运行 | 编辑配置。 或者,您也可以从工具栏上的 运行 小部件中选择 编辑配置

    打开“编辑配置”对话框
  2. 在打开的 编辑配置 对话框中,点击工具栏上的 添加 按钮(添加按钮 ),然后从列表中选择 npm。 将打开 运行/调试配置:npm 对话框

  3. 指定要执行的 CLI 命令、要运行的脚本(用空格分隔)以及定义这些脚本的 package.json 文件的位置。 可选地,输入执行脚本所需的 命令行参数

  4. 有关包管理器命令行界面的更多信息,请参阅 npm 官方网站Yarn 官方网站

  5. 指定要使用的 Node.js 解释器。

    如果选择 项目 别名,GoLand 将自动使用 Node 解释器 字段中定义的项目默认解释器。 在大多数情况下,GoLand 会检测到项目默认解释器并自动填写该字段。

    您也可以选择另一个已配置的本地解释器,或点击 浏览按钮 配置新解释器。

    您还可以选择性地指定要传递给 Node.js 的 Node.js 专属选项参数环境变量

  6. 指定要使用的包管理器。 如果选择 项目 别名,GoLand 将使用 Node.js页面中设置的项目默认包管理器。 您还可以选择相关的包别名(npmyarn ),或指定包管理器的自定义安装路径。

  7. 如果您在 Docker 容器中使用远程 Node.js 解释器,请检查自动生成的 Docker 容器设置。 单击 展开图标 ,在弹出窗口中打开设置。

    检查 Docker 容器设置

    请参阅 在 Docker 中使用 npm、pnpm 和 yarn配置远程 Node.js 解释器 了解更多信息。

运行和调试脚本

使用 Run Anything 运行脚本

Run Anything 是启动脚本的快捷方式。

  1. 按两次 Ctrl 键,或单击导航栏上的 Run Anything 按钮 图标。 将打开 运行任意内容 弹出窗口。

  2. 在搜索字段中输入包管理器名称。 输入时,GoLand 会显示匹配的命令。

    Run Anything:输入包管理器名称

    或者,输入脚本名称。

    Run Anything:输入脚本名称

    最后,您可以键入 ? ,以获取命令提示列表。

    Run Anything 中可用命令列表

    导航至相关提示项并按 Space 键,获取可用命令列表,从中选择所需命令并按 Enter

    要在 运行 工具窗口中查看命令输出,请按 Ctrl+Enter ,要在 调试 工具窗口中查看输出,请按 Shift+Enter

    从 Run Anything 弹窗在 Run 或 Debug 工具窗口中运行 npm 命令

启动时自动运行脚本

如果您有一些经常运行的脚本,可以将相应的运行配置添加到 启动任务 列表中。 这些任务将在项目启动时自动执行。

  1. 设置 对话框(Ctrl+Alt+S )中,转到 工具 | 启动任务

  2. 在打开的 启动任务页面 中,单击工具栏上的 添加按钮

  3. 从列表中选择所需的 npm 运行配置。 该配置将被添加到列表中。

    如果项目中没有可用的配置,请单击 添加按钮` 并选择 编辑配置。 然后在打开的 运行/调试配置 页面中设置所需的配置参数。 保存新配置后,它会自动添加到启动任务列表中。

作为启动前任务运行脚本

  1. 通过主菜单中的 运行 | 编辑配置 打开 运行/调试配置 对话框,并从列表中选择所需的配置或点击 添加新配置 新建一个所需类型的运行配置。

  2. 在打开的对话框中,单击 添加 ,在 启动前 区域中选择 运行 npm 脚本

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

Docker 中的 npm、pnpm 和 yarn

使用 GoLand,您可以像在本地一样在 Docker 容器中编辑 package.json 、安装、更新和删除项目依赖项。

  1. 设置 | 插件 页的 Marketplace 标签中安装 Node.jsNode.js Remote Interpreter 插件,具体操作请参阅 从 JetBrains Marketplace 安装插件

  2. 按照 Docker 中的说明下载、安装并配置 Docker

  3. 在 Docker 中配置 Node.js 远程解释器 或通过 Docker Compose 配置,并在项目中 将其设置为默认。 还请确保与该远程解释器关联的包管理器已 设置为项目默认值

  4. 与本地开发过程一致: 编辑 package.json管理项目依赖项 以及 运行或调试脚本

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