WebStorm 2021.1 Help

npm、pnpm 和 Yarn

WebStorm 与npmYarnYarn 2pnpm集成,因此您可以在 IDE 的内置终端中安装、定位、更新和删除可重用代码包。

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

WebStorm 检测带有Yarn 工作空间的项目,并索引工作空间的package.json文件中列出但位于根node_modules文件夹中的所有依赖项。

WebStorm 索引不同 package.json 文件中列出但存储在根 node_modules 文件夹中的所有依赖项

在你开始前

  • 下载并安装Node.js。请注意,npm 也已安装,因此如果您要使用它,您已经完成了初步步骤。

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

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

    npm install --g pnpm

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

选择项目包管理器

使用 WebStorm,您可以选择在项目中使用 npm、Yarn、Yarn 2 还是 pnpm。

默认情况下,WebStorm 建议使用 npm。但是,如果您打开一个带有yarn.lock文件的项目并且您的计算机上安装了 Yarn,WebStorm 会自动将此项目的包管理器更改为 Yarn。

因此,如果您打开一个带有pnpm-lock文件的项目并且 pnpm 安装在您的计算机上,WebStorm 会自动将该项目的包管理器更改为 pnpm。

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

  1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到Languages and Frameworks | 节点.jsNode.js页面打开。

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

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

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

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

    当您从Run/Debug Configuration: NPM对话框中的Package manager列表中选择Project别名时,WebStorm 会自动使用所选的包管理器。每次调用Run 'npm install' / Run 'yarn install' / Run 'pnpm install'命令或运行 npm/Yarn/pnpm 脚本时, WebStorm 也会使用所选包管理器的路径,有关详细信息,请参阅运行和调试脚本.

在您的项目中设置 Yarn 2

  1. 确保您已全局安装 Yarn 1 并按照Yarn 官方网站上的说明在您的项目中启用 Yarn 2 。使用嵌入式终端 Alt+F12键入命令。

  2. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到Languages and Frameworks | Node.js并从包管理器列表中选择项目中 Yarn 2 包的路径。

将 Yarn 1 或 pnpm 设置为默认的 WebStorm 包管理器

  1. 打开新项目设置对话框(文件|新项目设置|新项目的设置/首选项)并转到语言和框架| 节点.js

  2. 在打开的Node.js 和 NPM页面上,从包管理器列表中选择yarn或。pnpm

之后,每次创建新项目时,WebStorm 都会建议默认选择的包管理器(Yarn 或 pnpm)。

编辑 package.json

WebStorm 帮助您处理package.json文件中的项目依赖关系,提供广泛的编码帮助。

  • 包名称的代码完成。

    包名称的代码完成
  • 有关最新可用软件包版本的信息。

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

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

    显示可用包版本的范围
  • 以前的包版本的代码完成。当您按下Ctrl+Space或开始输入与最新版本不同的版本时,WebStorm 会显示一个建议列表,其中包含该软件包的所有先前版本。

    以前的包版本的代码完成
  • 包的快速文档查找。

    包的快速文档查找

安装和更新软件包

您可能知道,npm 可以全局安装包,也可以作为项目依赖开发依赖安装,更多信息请访问 npm 官网

pnpm 还全局安装包或作为项目依赖项或开发依赖项,从pnpm 官方网站了解更多信息。

使用 Yarn,您可以全局安装包或作为项目依赖项安装包,详情请参阅Yarn 官网

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

来自 package.json

安装您的项目依赖项

  • 单击弹出窗口中的Run 'npm install'Run 'yarn install'Run 'pnpm install'链接:

    安装依赖项弹出窗口

    当依赖项尚未安装或已更改时,WebStorm 会显示此弹出窗口。如果您关闭弹出窗口或通过选择Don't ask again将其关闭,您仍然可以使用Run '<package_manager> install'操作或在内置终端中安装依赖项。

    如果您不小心忽略了此通知,现在想要取回它,请按Ctrl+Shift+A,开始输入,然后从列表中Enable notifications选择Enable Notifications about Installation Dependencies from package.json 。

  • 或者,在编辑器中打开相关的package.json文件或在Project工具窗口中选择它,然后从上下文菜单中选择Run 'npm install' 。

更新您的项目依赖项

  • 在弹出窗口中单击运行“<package manager> install”

    更新依赖:弹出

    每次打开项目、从版本控制更新项目或编辑package.json时,WebStorm 都会显示此弹出窗口。

  • WebStorm 还会运行检查,检查来自dependenciesdevDependencies已安装的软件包及其版本是否与指定范围匹配。如果检查发现任何不匹配,则建议快速修复。要应用它,请单击Run '<package manager> install'链接。

    安装的软件包版本不是最新的
  • WebStorm 还检测有更高版本可用的包,并在您将鼠标悬停在包版本上时提供快速修复。

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

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

    更新包到最新版本:快速修复

在内置终端中

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

  • 对于全局安装:

    • npm install --global <package_name>

    • yarn global add <package_name>

    • pnpm --global add <package_name>

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

    • npm install --save <package_name>要么npm install --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了解更多信息。

运行和调试脚本

您可以根据专用运行配置,从编辑器中的package.json文件、专用npm工具窗口中的脚本树启动 npm、Yarn 或 pnpm 脚本,或者作为启动之前自动启动- 启动任务。

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

运行脚本:运行工具窗口

如果您启动脚本调试会话,WebStorm 会打开调试工具窗口

调试脚本:调试工具窗口

在脚本调试会话期间,您可以 单步执行脚本停止和恢复脚本执行、暂停时检查它在调试器控制台中运行 JavaScript 代码片段,等等。

从 package.json 运行和调试脚本

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

  • 在编辑器中打开package.json文件,单击运行按钮脚本旁边的装订线,然后从上下文菜单中选择Run <script_name>Debug <script_name> 。

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

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

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

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

当您在Project工具窗口中选择package.json文件或在编辑器中打开它并从上下文菜单中选择Show npm Scripts时, npm工具窗口将打开。

一旦您调用 npm、pnpm 或 Yarn,该工具就会开始构建在调用它的package.jsonscripts文件的属性中定义的脚本树。

如果您的项目中有多个package.json文件,您可以为每个文件构建一个单独的脚本树并运行脚本,而不会删除之前构建的树。每棵树都显示在一个单独的节点下。

如果 npm 工具窗口尚未打开,请打开它

  • 选择需要的Project工具窗口中打开文件或在编辑器中打开它,然后从上下文菜单中选择Show npm Scripts 。

    打开 npm 工具窗口

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

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

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

  2. 如果您有另一个package.json文件,请单击选择 package.json并在打开的对话框中选择您需要的package.json文件。WebStorm 在其标题上添加一个带有所选package.json文件路径的新节点,并在新节点下构建一个脚本树。

构建另一个脚本树

重建一棵树

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

    重新加载脚本

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

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

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

    按名称对脚本进行排序

运行一个脚本

  • 双击脚本。

  • 在树中选择脚本,然后从上下文菜单中按Enter或选择运行 <脚本名称> 。

从 npm 工具窗口运行一个脚本

调试一个脚本

从 npm 工具窗口调试一个脚本

运行或调试多个脚本

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

    运行多个脚本

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

当您从编辑器或npm工具窗口运行或调试脚本时,WebStorm 会自动创建临时运行配置。除了使用它们之外,您还可以创建和启动自己的 npm 运行配置。

  1. 从主菜单中,选择运行 | 编辑配置。或者,从工具栏上的列表中选择编辑配置

  2. 单击工具栏上的 并从列表中添加按钮选择npm 。运行/调试配置:npm 对话框打开。

  3. 指定要执行的 CLI 命令、要运行的脚本(使用空格作为分隔符)以及定义这些脚本的package.json文件的位置。(可选)键入用于执行脚本的命令行参数。

  4. 指定要使用的 Node.js 解释器。这可以是本地 Node.js 解释器Windows Subsystem for Linux 上的 Node.js。

    (可选)指定特定于 Node.js 的选项参数和要传递给 Node.js的环境变量。

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

  6. 从工具栏上的列表中选择新创建的运行配置,然后单击列表旁边的跑步或。调试

    脚本执行的结果显示在运行工具窗口中。

    如果单击调试,WebStorm 将打开调试工具窗口,您可以在其中 单步执行脚本停止和恢复脚本执行、暂停时检查它在调试器控制台中运行 JavaScript 代码片段,等等。

使用 Run Anything 运行脚本

Run Anything是一种快速启动脚本的方法。

  1. Ctrl两次或单击运行任何东西按钮导航栏。运行任何东西弹出窗口打开。

  2. 在搜索字段中输入或npm runyarn run在您键入时,WebStorm 会显示匹配的脚本。从列表中选择所需的一项,然后按Enter

    运行任何东西:npm 脚本

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

    在“运行任何东西”弹出窗口中的“调试”工具窗口中运行脚本

启动时自动运行脚本

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

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

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

  3. 从列表中,选择所需的npm run 配置。配置将添加到列表中。

    如果项目中没有可用的配置,请单击添加按钮`并选择Edit Configurations然后在打开的Run/Debug Configuration: NPM页面上定义具有所需设置的配置。当您保存新配置时,它会自动添加到启动任务列表中。

将脚本作为启动前任务运行

  1. 通过选择Run |打开Run/debug 配置对话框对话框。从主菜单编辑配置添加新配置,然后从列表中选择所需的配置,或者通过单击并选择相关的运行配置类型来重新创建它。

  2. 在打开的对话框中,单击添加Before launch区域并从列表中选择Run npm script 。

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

Docker 中的 npm、pnpm 和 yarn

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

  1. 确保在Settings/Preferences |上启用了Node.jsNode.js Remote InterpreterDocker所需的插件。插件页面,选项卡Installed,有关详细信息,请参阅管理插件

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

  3. 在 Docker 中配置 Node.js 远程解释器并将其设置为项目中的默认值。还要确保与此远程解释器关联的包管理器设置为项目默认值

  4. 继续进行本地开发:编辑您的 package.json管理您的项目依赖项,并运行或调试脚本

最后修改:2021 年 11 月 15 日