npm-pack

从包创建 tarball

选择 CLI 版本

概要

npm pack <package-spec>

配置

dry-run

  • 默认:false
  • 类型:布尔值

表示您不希望 npm 进行任何更改,并且它应该只报告它将要执行的操作。这可以传递给任何修改本地安装的命令,例如 installupdatededupeuninstall,以及 packpublish

注意:这不受其他网络相关命令(例如 dist-tagsowner 等)的约束。

json

  • 默认:false
  • 类型:布尔值

是否输出 JSON 数据,而不是正常输出。

  • npm pkg set 中,它允许在将设置值保存到您的 package.json 之前使用 JSON.parse() 解析设置值。

并非所有 npm 命令都支持。

pack-destination

  • 默认:“.”
  • 类型:字符串

npm pack 将保存 tarball 的目录。

workspace

  • 默认
  • 类型:字符串(可以设置多次)

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

workspace 配置的有效值为

  • 工作区名称
  • 工作区目录的路径
  • 父工作区目录的路径(将导致选择该文件夹中的所有工作区)

当为 npm init 命令设置时,这可以设置为尚未存在的工作区的文件夹,以创建文件夹并将其设置为项目中的一个全新工作区。

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

workspaces

  • 默认:null
  • 类型:null 或布尔值

设置为 true 以在**所有**已配置工作区的上下文中运行命令。

显式将此设置为 false 将导致 install 等命令完全忽略工作区。未显式设置时

  • node_modules 树上运行的命令(install、update 等)将链接工作区到 node_modules 文件夹中。- 执行其他操作的命令(test、exec、publish 等)将对根项目进行操作,除非 workspace 配置中指定了一个或多个工作区。

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

include-workspace-root

  • 默认:false
  • 类型:布尔值

在为命令启用工作区时,包括工作区根目录。

当设置为 false 时,通过 workspace 配置指定单个工作区,或通过 workspaces 标志指定所有工作区,将导致 npm 仅对指定的工作区进行操作,而不对根项目进行操作。

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

描述

对于任何可安装的东西(即包文件夹、tarball、tarball url、git url、name@tag、name@version、name 或 scoped name),此命令将将其提取到缓存中,将 tarball 复制到当前工作目录作为 <name>-<version>.tgz,然后将文件名写入标准输出。

如果多次指定同一个包,那么该文件将在第二次被覆盖。

如果没有提供任何参数,那么 npm 将打包当前的包文件夹。

另请参阅