npm-dist-tag

修改包分发标签

选择命令行版本:

概要

🌐 Synopsis

npm dist-tag add <package-spec (with version)> [<tag>]
npm dist-tag rm <package-spec> <tag>
npm dist-tag ls [<package-spec>]
alias: dist-tags

描述

🌐 Description

在包上添加、删除和枚举分发标签:

🌐 Add, remove, and enumerate distribution tags on a package:

  • add:用指定的标签标记软件包的指定版本,如果未指定,则使用 --tag 配置。如果你在 auth-and-writes 上启用了两步验证,那么你需要在命令行中使用 --otp <one-time password> 提供一次性密码,或者按照你的 authtype 进行第二因素认证流程。
  • rm:从包中清除不再使用的标签。如果你的认证和写入操作启用了双因素身份验证,那么你需要在命令行中使用 --otp <one-time password> 包含一次性密码,或者根据你的 authtype 通过第二因素流程。
  • ls:显示一个包的所有 dist-tags,默认显示当前前缀下的包。如果未指定任何操作,这是默认行为。

安装包时可以使用标记作为对版本的引用,而不是使用特定的版本号:

🌐 A tag can be used when installing packages as a reference to a version instead of using a specific version number:

npm install <name>@<tag>

安装依赖时,可以指定首选标记版本:

🌐 When installing dependencies, a preferred tagged version may be specified:

npm install --tag <tag>

(这也适用于任何其他解析并安装依赖的命令,例如 npm dedupenpm updatenpm audit fix。)

发布一个包会将 latest 标签设置为已发布的版本,除非使用了 --tag 选项。例如,npm publish --tag=beta

🌐 Publishing a package sets the latest tag to the published version unless the --tag option is used. For example, npm publish --tag=beta.

默认情况下,npm install <pkg>(没有任何 @<version>@<tag> 指定符)会安装 latest 标签。

🌐 By default, npm install <pkg> (without any @<version> or @<tag> specifier) installs the latest tag.

目的

🌐 Purpose

标签可用于提供别名而不是版本号。

🌐 Tags can be used to provide an alias instead of version numbers.

例如,一个项目可能会选择有多个开发分支,并为每个分支使用不同的标签,例如,stablebetadevcanary

🌐 For example, a project might choose to have multiple streams of development and use a different tag for each stream, e.g., stable, beta, dev, canary.

默认情况下,npm 使用 latest 标签来标识包的当前版本,而 npm install <pkg>(没有任何 @<version>@<tag> 指定符)会安装 latest 标签。通常,项目只会将 latest 标签用于稳定发布版本,而将其他标签用于不稳定版本,例如预发布版本。

🌐 By default, the latest tag is used by npm to identify the current version of a package, and npm install <pkg> (without any @<version> or @<tag> specifier) installs the latest tag. Typically, projects only use the latest tag for stable release versions, and use other tags for unstable versions such as prereleases.

某些项目使用 next 标签来标识即将发布的版本。

🌐 The next tag is used by some projects to identify the upcoming version.

除了 latest,没有其他标签对 npm 本身有任何特殊意义。

🌐 Other than latest, no tag has any special significance to npm itself.

注意事项

🌐 Caveats

这个命令以前被称为 npm tag,它只创建新标签,因此语法不同。

🌐 This command used to be known as npm tag, which only created new tags, and so had a different syntax.

标签必须与版本号共享命名空间,因为它们在同一个位置中指定:npm install <pkg>@<version>npm install <pkg>@<tag>

可以被解释为有效 semver 范围的标签将被拒绝。例如,v1.4 不能用作标签,因为 semver 会将其解释为 >=1.4.0 <1.5.0。详情请参见 https://github.com/npm/npm/issues/6082

🌐 Tags that can be interpreted as valid semver ranges will be rejected. For example, v1.4 cannot be used as a tag, because it is interpreted by semver as >=1.4.0 <1.5.0. See https://github.com/npm/npm/issues/6082.

避免标签出现语义化版本问题的最简单方法是使用不以数字或字母 v 开头的标签。

🌐 The simplest way to avoid semver problems with tags is to use tags that do not begin with a number or the letter v.

配置

🌐 Configuration

workspace

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

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

🌐 Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

workspace 配置的有效值为以下之一:

🌐 Valid values for the workspace config are either:

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

对于 npm init 命令设置时,可以将其设置为一个尚不存在的工作区文件夹,以创建该文件夹并将其作为项目内全新的工作区进行设置。

🌐 When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.

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

🌐 This value is not exported to the environment for child processes.

workspaces

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

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

🌐 Set to true to run the command in the context of all configured workspaces.

将此显式设置为 false 会导致像 install 这样的命令完全忽略工作区。如果不显式设置:

🌐 Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly:

  • node_modules 树操作的命令(安装、更新等)会将工作区链接到 node_modules 文件夹。- 执行其他操作的命令(测试、执行、发布等)会在根项目上运行,除非workspace 配置中指定了一个或多个工作区。

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

🌐 This value is not exported to the environment for child processes.

include-workspace-root

  • 默认:否
  • 类型:布尔

为命令启用工作区时包括工作区根。

🌐 Include the workspace root when workspaces are enabled for a command.

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

🌐 When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.

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

🌐 This value is not exported to the environment for child processes.

也可以看看

🌐 See Also