npm 包遵循语义化版本控制(semantic versioning)

1,069 阅读1分钟

npm 包遵循语义化版本控制(semantic versioning)

为了保持Javascript 生态系统的健康、可靠和安全,npm建议使用语义化版本控制规范。语义化版本控制可以使开发者通过一个给定的版本号了解npm包的变化。

版本格式:主版本号.次版本号.修订号

npm 建议初始版本为1.0.0,版本号递增规则如下:

修订号(patch):当做了向下兼容的bug修正,1.0.1 次版本号(minor):当做了向下兼容的功能性新增1.1.0 主版本号(major):当你做了不兼容的 API 修改,2.0.0 通过语义化版本控制指定依赖包的可更新范围:

"dependencies": {
  "my_dep": "^1.0.0",
  "another_dep": "~2.2.0"
}

使用^符号:主版本号相同,包含比一个特定版本大的所有版本,比如^2.2.1 使用~符号:主版本号、次版本号相同,包含比一个特定版本大的所有版本,比如~2.2.1 使用>,<,=,>=,<=符号,比如>2.0.1 使用-符号:制定一个包含范围,比如1.0.0-1.2.0


pakage.json 中对引入依赖包版本进行管理时,dependencies中常常可以看到类似 ^1.2.0 或 ~1.2.0 这样的版本范围指示。那么,这里的 ^ 和 ~ 具体表示什么含义呢。

详细内容可以查看npm的官方文档: docs.npmjs.com/misc/semver…

上面的链接中高级范围语法一节,表示版本范围可以用的符号有 - x ~ ^

这里简单把 ^ 和 ~ 的区别摘抄一下,备忘。 一个完整的版本号组表示为: [主要版本号,次要版本号,补丁版本号]

  1. 用 ~ 指示范围

如果指定了次要版本,允许补丁版本升级。如果没有指定次要版本,允许次要版本升级。

~1.2.3 >= 1.2.3 < 1.3.0 ~1.2 >= 1.2.0 < 1.3.0 ~1 >= 1.0.0 < 2.0.0 ~0.2.3 >= 0.2.3 < 0.3.0 ~0.2 >= 0.2.0 < 0.3.0 ~0 >= 0.0.0 < 1.0.0 ~1.2.3-beta.2 >=1.2.3-beta.2 < 1.3.0 (注:1.2.3版允许高于beta.2的beta版,但1.2.4-beta.2不被允许,因为是属于另一个版本号组的beta版本。)

  1. 用 ^ 指定范围

允许不会改变最左边的不为零的版本号的版本提升,也就是说,^1.0.0允许次要、补丁版本升级,^0.1.0允许补丁版本升级,^0.0.x 不允许升级。

有许多开发者把 '0.x' 中的 'x' 改变作为重大改变的指示。

一个普遍的做法是,^ 适合使用在当开发者从 0.2.4 升级到 0.3.0 可能会做出不兼容的改变时。一般情况下,假定了在0.2.4 到 0.2.5 不会有不兼容改变,可以有一些新增(但不改变兼容)的改变。

^1.2.3 >=1.2.3 < 2.0.0 ^0.2.3 >=0.2.3 < 0.3.0 ^0.0.3 >=0.0.3 < 0.0.4 ^1.2.3-beta.2 >=1.2.3-beta.2 < 2.0.0 允许1.2.3 版的高于beta-2 的beta版本。 ^0.0.3-beta.2 >=0.0.3-beta.2 < 0.0.4 只允许0.0.3 版的高于beta-2 的版本

当解析带有^的版本范围时,补丁版本号缺少会补 0,但是会灵活的处理,即时主要、次要版本号都为 0 也可以。

^1.2.x >= 1.2.0 < 2.0.0 ^0.0.x >= 0.0.0 < 0.1.0 ^0.0 >= 0.0.0 < 0.1.0

当次要、补丁版本号缺少时会当作 0,但也会灵活处理,即时主版本号为 0 也可以 。

^1.x >= 1.0.0 < 2.0.0 ^0.x >= 0.0.0 < 1.0.0


Reference:

  1. semver.org/lang/zh-CN/
  2. docs.npmjs.com/about-seman…