Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. 参考
  2. 运行/调试配置对话框
  3. NPM

专业的
运行/调试配置：NPM

最后修改时间：2023 年 9 月 1 日

所需插件：

JavaScript 和 TypeScript - 该插件仅在 PyCharm Professional 中可用，默认情况下启用。

Node.js - 该插件仅在 PyCharm Professional 中可用，默认情况下启用。

创建：运行| 编辑配置| 添加新配置 | NPM

在此对话框中，创建用于在本地运行npm和Yarn脚本的配置。当前上下文中的“本地”意味着 PyCharm 本身启动安装在您计算机上的Node.js，从而启动脚本执行。

从npm、pnpm 和 Yarn了解更多信息。

在你开始之前

配置选项卡

物品

描述

包.json

在此字段中，指定要从中运行脚本的package.json文件。从显示当前项目中检测到的所有package.json文件的下拉列表中选择文件，或者单击 并在打开的对话框中浏览按钮选择所需的package.json 。

命令

从此列表中，选择要执行的npm CLI 命令run-script，默认情况下处于选中状态。要了解更多信息，请参阅npm 文档的CLI 命令部分。

脚本

从此下拉列表中，选择将应用所选命令的脚本。该列表包含package.jsonscripts文件的属性中定义的所有脚本。

论点

在此字段中，指定用于执行脚本的命令行参数。从npm 官方网站了解更多信息。

节点解释器

在此字段中，指定要使用的 Node.js 解释器。

如果您选择项目别名，PyCharm 将自动使用Node.js页面上的节点解释器字段中的项目默认解释器。在大多数情况下，PyCharm 会检测项目默认解释器并填写字段本身。

您还可以选择另一个已配置的本地或远程解释器，或者单击浏览按钮并配置一个新解释器。

节点选项

在此字段中，键入要传递到 Node.js 可执行文件的 Node.js 特定命令行选项。可接受的选项是：

  • 用于在运行期间--require coffeescript/register将CoffeeScript文件即时编译为 JavaScript。

    此模式要求register.js文件（包的一部分）coffeescript位于您的项目内。因此，请确保您已按照安装 CoffeeScript 编译器coffeescript中所述在本地安装了该软件包。

  • 当您使用 Node.js v7 来支持Chrome 调试协议时，请使用--inspect或参数。否则，默认情况下调试过程将使用V8 调试协议。--inspect-brk

包管理器

在这个领域里。指定要使用的包管理器。如果您选择别名，PyCharm 将使用Node.jsProject页面中的默认项目包管理器。您还可以选择相关的包别名（npm或yarn）或指定包管理器的自定义安装的显式路径。

环境变量

在此字段中，指定Node.js 可执行文件的环境变量（如果适用）。单击字段右侧的“浏览” ，然后在打开的“环境变量”对话框中配置变量列表：浏览按钮

  • 要定义新变量，请单击添加按钮并指定变量名称和值。

  • 要放弃变量定义，请在列表中选择它并单击删除按钮。

  • 准备好后单击“确定”

变量的定义显示在环境变量只读字段中，以分号作为分隔符，例如：

  • NODE_PATH：:模块搜索路径前缀的分隔目录列表。

  • NODE_MODULE_CONTEXTS：设置为 1 以在其自己的全局上下文中加载模块。

  • NODE_DISABLE_COLORS：设置为 1 以禁用 REPL 中的颜色。

Docker 容器设置

此只读字段显示端口和卷绑定。单击展开按钮可打开命令预览。

警告

仅当选择基于 Docker 的远程解释器时，才会出现此字段。

检查 Docker 容器设置

Docker 组合

在此区域中，指定要传递到 Docker Compose 的命令和选项。接受默认设置或单击展开按钮并指定自定义设置，例如自定义 Docker Compose 标志，如--rm或--service-ports。从Docker 官方网站了解更多信息。

检查命令预览。

警告

仅当选择通过 Docker Compose 的远程解释器时，才会出现此字段。

常用设置

当您编辑运行配置（但不是运行配置模板）时，您可以指定以下选项：

物品

描述

姓名

指定运行配置的名称，以便在编辑或运行时快速识别它。

允许多个实例

允许并行运行此运行配置的多个实例。

默认情况下，它是禁用的，当您在另一个实例仍在运行时启动此配置时，PyCharm 建议停止正在运行的实例并启动另一个实例。当运行配置消耗大量资源并且没有充分理由运行多个实例时，这非常有用。

存储为项目文件

保存带有运行配置设置的文件，以便与其他团队成员共享。默认位置是.idea/runConfigurations。但是，如果您不想共享.idea目录，则可以将配置保存到项目内的任何其他目录。

默认情况下，它是禁用的，PyCharm 将运行配置设置存储在.idea/workspace.xml中。

工具栏

运行/调试配置的树视图有一个工具栏，可帮助您管理项目中可用的配置以及调整默认配置模板。

物品

捷径

描述

添加按钮

AltInsert

创建运行/调试配置。

删除按钮

AltDelete

删除选定的运行/调试配置。请注意，您无法删除默认配置。

复制

Ctrl0D

创建所选运行/调试配置的副本。请注意，您创建默认配置的副本。

保存配置

仅当您选择临时配置时才会显示该按钮。单击此按钮可将临时配置保存为永久配置。

移入新文件夹/创建新文件夹

移入新文件夹/创建新文件夹。您可以通过将运行/调试配置放入文件夹中来对它们进行分组。

要创建文件夹，请选择类别中的配置，单击文件夹，然后指定文件夹名称。如果仅关注某个类别，则会创建一个空文件夹。

然后，要将配置移入文件夹、文件夹之间或移出文件夹，请使用拖动 或提升和下移按钮。

要删除分组，请选择一个文件夹并单击删除配置。

对配置进行排序

单击此按钮可按字母顺序对配置进行排序。

发布前

在此区域中，您可以指定在启动所选运行/调试配置之前要执行的任务。任务按照它们在列表中出现的顺序执行。

物品

捷径

描述

添加按钮

AltInsert

单击此图标可添加以下可用任务之一：

  • 启动 Web 浏览器：选择此选项可启动浏览器。在打开的对话框中，选择浏览器类型并提供起始 URL。另外，指定是否希望使用 JavaScript 调试器启动浏览器。

  • 运行外部工具：选择运行外部应用程序。在打开的对话框中，选择一个或多个要运行的应用程序。如果 PyCharm 中尚未定义，请添加其定义。有关详细信息，请参阅外部工具和外部工具。

  • 运行另一个配置：选择执行另一个运行/调试配置并等待其完成后再开始当前配置。如果要并行运行多个配置，请使用复合运行/调试配置。

  • 运行文件观察程序：选择此选项可以让 PyC​​harm 应用所有当前活动的文件观察程序。

  • 运行远程外部工具：添加远程 SSH 外部工具。

  • 运行 Grunt 任务：选择此选项可运行 Grunt 任务。

    在打开的Grunt 任务对话框中，指定定义所需任务的Gruntfile.js，选择要执行的任务，并指定要传递给 Grunt 工具的参数。

    指定 Node.js 解释器的位置、要传递给它的参数以及grunt-cli包的路径。

  • 运行 Gulp 任务：选择此选项可运行 Gulp 任务。

    在打开的Gulp 任务对话框中，指定定义所需任务的Gulpfile.js，选择要执行的任务，并指定要传递给 Gulp 工具的参数。

    指定 Node.js 解释器的位置、要传递给它的参数以及gulp包的路径。

  • 运行 npm 脚本：选择此选项来执行 npm 脚本。

    在打开的NPM 脚本对话框中，指定npm run/debug 配置设置。

  • 编译 TypeScript：选择运行内置 TypeScript 编译器，从而确保您对 TypeScript 代码所做的所有更改都反映在生成的 JavaScript 文件中。在打开的TypeScript 编译设置对话框中，选中或清除检查错误复选框以配置编译器在检测到任何错误时的行为：

    • 如果选中“检查错误”复选框，编译器将显示所有错误，并且运行配置将不会启动。

    • 如果清除“检查错误”复选框，编译器将显示所有检测到的错误，但仍会启动运行配置。

  • 生成 CoffeeScript 源映射：选择此选项可为您的CoffeeScript源生成源映射。在打开的对话框中，指定 CoffeeScript 源文件的位置。

删除按钮

AltDelete

单击此图标可从列表中删除选定的任务。

编辑

Enter

单击此图标可编辑选定的任务。在打开的对话框中进行必要的更改。

方法向上

方法向下

Alt0↑

Alt0↓

单击这些图标可将所选任务在列表中上移或下移一行。任务按照它们在列表中出现的顺序执行。

显示此页

选择此复选框可在实际启动运行/调试配置之前显示运行/调试配置设置。

激活工具窗口

默认情况下，此复选框处于选中状态，并且当您启动运行/调试配置时，将打开“运行”或“调试”工具窗口。

否则，如果清除该复选框，工具窗口将被隐藏。但在配置运行时，您可以通过按或自行打开相应的工具窗口。Alt04Alt05

也可以看看

程序

参考