Front End

Appearance

概要 ​

bash
npm exec -- <pkg>[@<version>] [args...]
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
npm exec -c '<cmd> [args...]'
npm exec --package=foo -c '<cmd> [args...]'
npm exec [--ws] [-w <workspace-name] [args...]

npx <pkg>[@<specifier>] [args...]
npx -p <pkg>[@<specifier>] <cmd> [args...]
npx -c '<cmd> [args...]'
npx -p <pkg>[@<specifier>] -c '<cmd> [args...]'
Run without --call or positional args to open interactive subshell

alias: npm x, npx

common options:
--package=<pkg> (may be specified multiple times)
-p is a shorthand for --package only when using npx executable
-c <cmd> --call=<cmd> (may not be mixed with positional arguments)
npm exec -- <pkg>[@<version>] [args...]
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
npm exec -c '<cmd> [args...]'
npm exec --package=foo -c '<cmd> [args...]'
npm exec [--ws] [-w <workspace-name] [args...]

npx <pkg>[@<specifier>] [args...]
npx -p <pkg>[@<specifier>] <cmd> [args...]
npx -c '<cmd> [args...]'
npx -p <pkg>[@<specifier>] -c '<cmd> [args...]'
Run without --call or positional args to open interactive subshell

alias: npm x, npx

common options:
--package=<pkg> (may be specified multiple times)
-p is a shorthand for --package only when using npx executable
-c <cmd> --call=<cmd> (may not be mixed with positional arguments)

描述 ​

此命令允许您从 npm 包（本地安装或远程获取）运行任意命令，其上下文与通过npm run.

在不使用位置参数或 的情况下运行，这允许您在运行脚本--call的相同 shell 环境中以交互方式运行命令。package.json当标准输入为 TTY 时，CI 环境中不支持交互模式，以防止挂起。

该选项指定的任何包都--package将在执行的命令中提供PATH，以及任何本地安装的包可执行文件。--package可以多次指定该选项，以便在所有指定的包都可用的环境中执行提供的命令。

如果本地项目依赖项中不存在任何请求的包，则它们将安装到 npm 缓存中的文件夹中，该文件夹将添加到PATH执行过程中的环境变量中。打印提示（可以通过提供 或 来抑制--yes）--no。

不带说明符提供的包名称将与本地项目中存在的任何版本相匹配。仅当带有说明符的包名称与本地依赖项具有完全相同的名称和版本时，才会被视为匹配。

如果未提供-c或--call选项，则使用位置参数来生成命令字符串。如果未--package提供选项，则 npm 将尝试根据以下启发式从作为第一个位置参数提供的包说明符确定可执行文件名称：

  • bin如果包的字段中有单个条目package.json，或者所有条目都是同一命令的别名，则将使用该命令。
  • 如果包有多个bin条目，并且其中之一与name字段的无范围部分匹配，则将使用该命令。
  • 如果这没有导致恰好一个选项（或者因为没有 bin 条目，或者没有一个name与包的条目匹配），则npm exec退出并出现错误。

要运行指定二进制文件以外的二进制文件，请指定一个或多个--package选项，这将阻止 npm 从第一个命令参数推断包。

npx-vs-npm-exec ​

当通过npx二进制文件运行时，所有标志和选项必须在任何位置参数之前设置。当通过 运行时npm exec，双连字符--标志可用于抑制 npm 对应发送到执行命令的开关和选项的解析。

例如：

$ npx foo@latest bar --package=@npmcli/foo
$ npx foo@latest bar --package=@npmcli/foo

在这种情况下，npm 将解析foo包名称，并运行以下命令：

$ foo bar --package=@npmcli/foo
$ foo bar --package=@npmcli/foo

由于--package选项位于位置参数之后，因此它被视为执行命令的参数。

相反，由于 npm 的参数解析逻辑，运行此命令是不同的：

$ npm exec foo@latest bar --package=@npmcli/foo
$ npm exec foo@latest bar --package=@npmcli/foo

--package在这种情况下，npm 将首先解析选项，解析@npmcli/foo包。然后，它将在该上下文中执行以下命令：

$ foo@latest bar
$ foo@latest bar

建议使用双连字符来明确告诉 npm 停止解析命令行选项和开关。因此，以下命令与上面的命令等效npx：

$ npm exec -- foo@latest bar --package=@npmcli/foo
$ npm exec -- foo@latest bar --package=@npmcli/foo

configuration ​

package ​

  • 默认：
  • 类型：String（可设置多次）

要安装的包npm exec

call ​

  • 默认： ””
  • 类型：字符串

的可选配套选项npm exec，npx允许指定与已安装的软件包一起运行的自定义命令。

bash
npm exec --package yo --package generator-node --call "yo node"
npm exec --package yo --package generator-node --call "yo node"

workspace ​

  • 默认：
  • 类型：String（可设置多次）

允许在当前项目的已配置工作区上下文中运行命令，同时通过仅运行此配置选项定义的工作区进行过滤。

配置的有效值为workspace：

  • 工作区名称
  • 工作区目录的路径
  • 父工作区目录的路径（将导致选择所有嵌套工作区）

当设置该npm init命令时，可以将其设置为尚不存在的工作空间的文件夹，以创建该文件夹并将其设置为项目中的全新工作空间。

该值不会导出到子进程的环境中。

workspaces ​

  • 默认值：假
  • 类型：布尔值

允许在所有已配置工作区的上下文中运行命令。

该值不会导出到子进程的环境中。

examples ​

tap使用提供的参数运行本地依赖项中的版本：

bash
$ npm exec --tap --bail test/foo.js 
$ npx tap --bail test/foo.js
$ npm exec --tap --bail test/foo.js 
$ npx tap --bail test/foo.js

通过指定选项来运行名称与包名称匹配的命令以外的命令--package：

bash
$ npm exec --package = foo -- bar --bar-argument  
# ~ 或 ~
$ npx --package = foo bar --bar-argument
$ npm exec --package = foo -- bar --bar-argument  
# ~ 或 ~
$ npx --package = foo bar --bar-argument

在当前项目的上下文中运行任意 shell 脚本：

bash
$ npm x -c 'eslint && say "hooray, lint passed"'
$ npx -c 'eslint && say "hooray, lint passed"'
$ npm x -c 'eslint && say "hooray, lint passed"'
$ npx -c 'eslint && say "hooray, lint passed"'

workspaces-support ​

您可以使用workspace或workspaces配置来在指定工作区的上下文中从 npm 包（本地安装或远程获取）运行任意命令。如果未--call提供位置参数或选项，它将在每个已配置工作区的上下文中一次打开一个交互式子 shell。

给定一个已配置工作区的项目，例如：

bash
.
+-- package.json
`-- packages
   +-- a
   |   `-- package.json
   +-- b
   |   `-- package.json
   `-- c
       `-- package.json
.
+-- package.json
`-- packages
   +-- a
   |   `-- package.json
   +-- b
   |   `-- package.json
   `-- c
       `-- package.json

假设工作区配置已在根级别文件中正确设置package.json。例如：

bash
{
    "workspaces": [ "./packages/*" ]
}
{
    "workspaces": [ "./packages/*" ]
}

使用配置选项时，您可以在每个已配置工作区的上下文中执行包中的任意命令workspaces，在本示例中，我们使用eslint来检查每个工作区文件夹中找到的任何 js 文件：

npm exec --ws -- eslint ./*.js
npm exec --ws -- eslint ./*.js

filtering-workspaces ​

还可以使用workspace配置以及名称或目录路径在单个工作区中执行命令：

npm exec --workspace=a -- eslint ./*.js
npm exec --workspace=a -- eslint ./*.js

还可以多次指定配置workspace，以便在多个工作区的上下文中运行特定脚本。在命令行中定义配置值时workspace，也可以使用-w简写，例如：

npm exec -w a -w b -- eslint ./*.js
npm exec -w a -w b -- eslint ./*.js

eslint最后一个命令将在./packages/a和文件夹中运行该命令./packages/b。

compatibility-with-older-npx-versions ​

该npx二进制文件在 npm v7.0.0 中被重写，并且独立npx包当时已被弃用。npx使用该npm exec命令而不是单独的参数解析器和安装过程，并提供一些功能来保持与其在先前版本中接受的参数的向后兼容性。

这导致其功能发生一些变化：

  • npm可以提供任何配置值。
  • 为了防止因错误输入软件包名称而导致安全和用户体验问题，npx请在安装任何内容之前进行提示。使用-y或--yes选项禁止出现此提示。
  • 该--no-install选项已弃用，并将转换为--no.
  • Shell 后备功能已被删除，因为这是不可取的。
  • 该-p参数是 in npm 的简写--parseable，但也是--packagein npx 的简写。这是被维护的，但仅限于npx可执行文件。
  • 该--ignore-existing选项已删除。本地安装的 bin 始终存在于执行的进程中PATH。
  • 该--npm选项已删除。npx将始终使用npm它附带的。
  • 和--node-arg选项-n被删除。
  • 该--always-spawn选项是多余的，因此被删除。
  • 该--shell选项被替换为--script-shell，但保留在npx可执行文件中以实现向后兼容性。

a-note-on-caching ​

当使用指定的包名称时，npm cli 利用其内部包缓存。您可以使用以下命令更改 cli 使用此缓存的方式和时间。请参阅npm cache参考资料 来了解有关缓存如何工作的更多信息。

prefer-online ​

强制对包进行过时检查，使 cli 立即查找更新，即使包已在缓存中也是如此。

prefer-offline ​

绕过包的陈旧性检查。仍然会向服务器请求丢失的数据。要强制完全离线模式，请使用offline.

offline ​

强制完全离线模式。任何未本地缓存的包都将导致错误。

workspace-1 ​

  • 默认：
  • 类型：String（可设置多次）

允许在当前项目的已配置工作区上下文中运行命令，同时通过仅运行此配置选项定义的工作区进行过滤。

配置的有效值为workspace：

  • 工作区名称
  • 工作区目录的路径
  • 父工作区目录的路径（将导致选择所有嵌套工作区）

该值不会导出到子进程的环境中。

workspaces-1 ​

  • 别名：--ws
  • 类型：布尔值
  • 默认：false

在当前项目的所有已配置工作区的上下文中运行脚本。