@cryptotaxi247 / documentation
Code Commits Issues Pulls Sessions CI/CD
dependabot/npm_and_yarn/main/proc-log-7.0.0
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 297 lines 15.4 KB
Raw
1 ---
2 title: semver
3 section: 7
4 description: The semantic versioner for npm
5 github_repo: npm/cli
6 github_branch: release/v6
7 github_path: docs/content/using-npm/semver.md
8 redirect_from:
9 - /cli-documentation/v6/misc/semver
10 - /cli-documentation/v6/using-npm/semver
11 - /cli/v6/misc/semver
12 ---
13
14 ## Install
15
16 ```bash
17 npm install --save semver
18 ```
19
20 ## Usage
21
22 As a node module:
23
24 ```js
25 const semver = require("semver");
26
27 semver.valid("1.2.3"); // '1.2.3'
28 semver.valid("a.b.c"); // null
29 semver.clean(" =v1.2.3 "); // '1.2.3'
30 semver.satisfies("1.2.3", "1.x || >=2.5.0 || 5.0.0 - 7.2.3"); // true
31 semver.gt("1.2.3", "9.8.7"); // false
32 semver.lt("1.2.3", "9.8.7"); // true
33 semver.minVersion(">=1.0.0"); // '1.0.0'
34 semver.valid(semver.coerce("v2")); // '2.0.0'
35 semver.valid(semver.coerce("42.6.7.9.3-alpha")); // '42.6.7'
36 ```
37
38 As a command-line utility:
39
40 ```
41 $ semver -h
42
43 A JavaScript implementation of the https://semver.org/ specification
44 Copyright Isaac Z. Schlueter
45
46 Usage: semver [options] <version> [<version> [...]]
47 Prints valid versions sorted by SemVer precedence
48
49 Options:
50 -r --range <range>
51 Print versions that match the specified range.
52
53 -i --increment [<level>]
54 Increment a version by the specified level. Level can
55 be one of: major, minor, patch, premajor, preminor,
56 prepatch, or prerelease. Default level is 'patch'.
57 Only one version may be specified.
58
59 --preid <identifier>
60 Identifier to be used to prefix premajor, preminor,
61 prepatch or prerelease version increments.
62
63 -l --loose
64 Interpret versions and ranges loosely
65
66 -p --include-prerelease
67 Always include prerelease versions in range matching
68
69 -c --coerce
70 Coerce a string into SemVer if possible
71 (does not imply --loose)
72
73 Program exits successfully if any valid version satisfies
74 all supplied ranges, and prints all satisfying versions.
75
76 If no satisfying versions are found, then exits failure.
77
78 Versions are printed in ascending order, so supplying
79 multiple versions to the utility will just sort them.
80 ```
81
82 ## Versions
83
84 A "version" is described by the `v2.0.0` specification found at [https://semver.org/](https://semver.org/).
85
86 A leading `"="` or `"v"` character is stripped off and ignored.
87
88 ## Ranges
89
90 A `version range` is a set of `comparators` which specify versions that satisfy the range.
91
92 A `comparator` is composed of an `operator` and a `version`. The set of primitive `operators` is:
93
94 - `<` Less than
95 - `<=` Less than or equal to
96 - `>` Greater than
97 - `>=` Greater than or equal to
98 - `=` Equal. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included.
99
100 For example, the comparator `>=1.2.7` would match the versions `1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6` or `1.1.0`.
101
102 Comparators can be joined by whitespace to form a `comparator set`, which is satisfied by the **intersection** of all of the comparators it includes.
103
104 A range is composed of one or more comparator sets, joined by `||`. A version matches a range if and only if every comparator in at least one of the `||`-separated comparator sets is satisfied by the version.
105
106 For example, the range `>=1.2.7 <1.3.0` would match the versions `1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`, or `1.1.0`.
107
108 The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`, `1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.
109
110 ### Prerelease Tags
111
112 If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then it will only be allowed to satisfy comparator sets if at least one comparator with the same `[major, minor, patch]` tuple also has a prerelease tag.
113
114 For example, the range `>1.2.3-alpha.3` would be allowed to match the version `1.2.3-alpha.7`, but it would _not_ be satisfied by `3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically "greater than" `1.2.3-alpha.3` according to the SemVer sort rules. The version range only accepts prerelease tags on the `1.2.3` version. The version `3.4.5` _would_ satisfy the range, because it does not have a prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.
115
116 The purpose for this behavior is twofold. First, prerelease versions frequently are updated very quickly, and contain many breaking changes that are (by the author's design) not yet fit for public consumption. Therefore, by default, they are excluded from range matching semantics.
117
118 Second, a user who has opted into using a prerelease version has clearly indicated the intent to use _that specific_ set of alpha/beta/rc versions. By including a prerelease tag in the range, the user is indicating that they are aware of the risk. However, it is still not appropriate to assume that they have opted into taking a similar risk on the _next_ set of prerelease versions.
119
120 Note that this behavior can be suppressed (treating all prerelease versions as if they were normal versions, for the purpose of range matching) by setting the `includePrerelease` flag on the options object to any [functions](https://github.com/npm/node-semver#functions) that do range matching.
121
122 #### Prerelease Identifiers
123
124 The method `.inc` takes an additional `identifier` string argument that will append the value of the string as a prerelease identifier:
125
126 ```javascript
127 semver.inc("1.2.3", "prerelease", "beta");
128 // '1.2.4-beta.0'
129 ```
130
131 command-line example:
132
133 ```bash
134 $ semver 1.2.3 -i prerelease --preid beta
135 1.2.4-beta.0
136 ```
137
138 Which then can be used to increment further:
139
140 ```bash
141 $ semver 1.2.4-beta.0 -i prerelease
142 1.2.4-beta.1
143 ```
144
145 ### Advanced Range Syntax
146
147 Advanced range syntax desugars to primitive comparators in deterministic ways.
148
149 Advanced ranges may be combined in the same way as primitive comparators using white space or `||`.
150
151 #### Hyphen Ranges `X.Y.Z - A.B.C`
152
153 Specifies an inclusive set.
154
155 - `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`
156
157 If a partial version is provided as the first version in the inclusive range, then the missing pieces are replaced with zeroes.
158
159 - `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`
160
161 If a partial version is provided as the second version in the inclusive range, then all versions that start with the supplied parts of the tuple are accepted, but nothing that would be greater than the provided tuple parts.
162
163 - `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`
164 - `1.2.3 - 2` := `>=1.2.3 <3.0.0`
165
166 #### X-Ranges `1.2.x` `1.X` `1.2.*` `*`
167
168 Any of `X`, `x`, or `*` may be used to "stand in" for one of the numeric values in the `[major, minor, patch]` tuple.
169
170 - `*` := `>=0.0.0` (Any version satisfies)
171 - `1.x` := `>=1.0.0 <2.0.0` (Matching major version)
172 - `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)
173
174 A partial version range is treated as an X-Range, so the special character is in fact optional.
175
176 - `""` (empty string) := `*` := `>=0.0.0`
177 - `1` := `1.x.x` := `>=1.0.0 <2.0.0`
178 - `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`
179
180 #### Tilde Ranges `~1.2.3` `~1.2` `~1`
181
182 Allows patch-level changes if a minor version is specified on the comparator. Allows minor-level changes if not.
183
184 - `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`
185 - `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)
186 - `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)
187 - `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`
188 - `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)
189 - `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)
190 - `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in the `1.2.3` version will be allowed, if they are greater than or equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not, because it is a prerelease of a different `[major, minor, patch]` tuple.
191
192 #### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`
193
194 Allows changes that do not modify the left-most non-zero digit in the `[major, minor, patch]` tuple. In other words, this allows patch and minor updates for versions `1.0.0` and above, patch updates for versions `0.X >=0.1.0`, and _no_ updates for versions `0.0.X`.
195
196 Many authors treat a `0.x` version as if the `x` were the major "breaking-change" indicator.
197
198 Caret ranges are ideal when an author may make breaking changes between `0.2.4` and `0.3.0` releases, which is a common practice. However, it presumes that there will _not_ be breaking changes between `0.2.4` and `0.2.5`. It allows for changes that are presumed to be additive (but non-breaking), according to commonly observed practices.
199
200 - `^1.2.3` := `>=1.2.3 <2.0.0`
201 - `^0.2.3` := `>=0.2.3 <0.3.0`
202 - `^0.0.3` := `>=0.0.3 <0.0.4`
203 - `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in the `1.2.3` version will be allowed, if they are greater than or equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not, because it is a prerelease of a different `[major, minor, patch]` tuple.
204 - `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the `0.0.3` version _only_ will be allowed, if they are greater than or equal to `beta`. So, `0.0.3-pr.2` would be allowed.
205
206 When parsing caret ranges, a missing `patch` value desugars to the number `0`, but will allow flexibility within that value, even if the major and minor versions are both `0`.
207
208 - `^1.2.x` := `>=1.2.0 <2.0.0`
209 - `^0.0.x` := `>=0.0.0 <0.1.0`
210 - `^0.0` := `>=0.0.0 <0.1.0`
211
212 A missing `minor` and `patch` values will desugar to zero, but also allow flexibility within those values, even if the major version is zero.
213
214 - `^1.x` := `>=1.0.0 <2.0.0`
215 - `^0.x` := `>=0.0.0 <1.0.0`
216
217 ### Range Grammar
218
219 Putting all this together, here is a Backus-Naur grammar for ranges, for the benefit of parser authors:
220
221 ```bnf
222 range-set ::= range ( logical-or range ) *
223 logical-or ::= ( ' ' ) * '||' ( ' ' ) *
224 range ::= hyphen | simple ( ' ' simple ) * | ''
225 hyphen ::= partial ' - ' partial
226 simple ::= primitive | partial | tilde | caret
227 primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial
228 partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?
229 xr ::= 'x' | 'X' | '*' | nr
230 nr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *
231 tilde ::= '~' partial
232 caret ::= '^' partial
233 qualifier ::= ( '-' pre )? ( '+' build )?
234 pre ::= parts
235 build ::= parts
236 parts ::= part ( '.' part ) *
237 part ::= nr | [-0-9A-Za-z]+
238 ```
239
240 ## Functions
241
242 All methods and classes take a final `options` object argument. All options in this object are `false` by default. The options supported are:
243
244 - `loose` Be more forgiving about not-quite-valid semver strings. (Any resulting output will always be 100% strict compliant, of course.) For backwards compatibility reasons, if the `options` argument is a boolean value instead of an object, it is interpreted to be the `loose` param.
245 - `includePrerelease` Set to suppress the [default behavior](https://github.com/npm/node-semver#prerelease-tags) of excluding prerelease tagged versions from ranges unless they are explicitly opted into.
246
247 Strict-mode Comparators and Ranges will be strict about the SemVer strings that they parse.
248
249 - `valid(v)`: Return the parsed version, or null if it's not valid.
250 - `inc(v, release)`: Return the version incremented by the release type (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), or null if it's not valid
251 - `premajor` in one call will bump the version up to the next major version and down to a prerelease of that major version. `preminor`, and `prepatch` work the same way.
252 - If called from a non-prerelease version, the `prerelease` will work the same as `prepatch`. It increments the patch version, then makes a prerelease. If the input version is already a prerelease it simply increments it.
253 - `prerelease(v)`: Returns an array of prerelease components, or null if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`
254 - `major(v)`: Return the major version number.
255 - `minor(v)`: Return the minor version number.
256 - `patch(v)`: Return the patch version number.
257 - `intersects(r1, r2, loose)`: Return true if the two supplied ranges or comparators intersect.
258 - `parse(v)`: Attempt to parse a string as a semantic version, returning either a `SemVer` object or `null`.
259
260 ### Comparison
261
262 - `gt(v1, v2)`: `v1 > v2`
263 - `gte(v1, v2)`: `v1 >= v2`
264 - `lt(v1, v2)`: `v1 < v2`
265 - `lte(v1, v2)`: `v1 <= v2`
266 - `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent, even if they're not the exact same string. You already know how to compare strings.
267 - `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.
268 - `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call the corresponding function above. `"==="` and `"!=="` do simple string comparison, but are included for completeness. Throws if an invalid comparison string is provided.
269 - `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.
270 - `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions in descending order when passed to `Array.sort()`.
271 - `diff(v1, v2)`: Returns difference between two versions by the release type (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), or null if the versions are the same.
272
273 ### Comparators
274
275 - `intersects(comparator)`: Return true if the comparators intersect
276
277 ### Ranges
278
279 - `validRange(range)`: Return the valid range or null if it's not valid
280 - `satisfies(version, range)`: Return true if the version satisfies the range.
281 - `maxSatisfying(versions, range)`: Return the highest version in the list that satisfies the range, or `null` if none of them do.
282 - `minSatisfying(versions, range)`: Return the lowest version in the list that satisfies the range, or `null` if none of them do.
283 - `minVersion(range)`: Return the lowest version that can possibly match the given range.
284 - `gtr(version, range)`: Return `true` if version is greater than all the versions possible in the range.
285 - `ltr(version, range)`: Return `true` if version is less than all the versions possible in the range.
286 - `outside(version, range, hilo)`: Return true if the version is outside the bounds of the range in either the high or low direction. The `hilo` argument must be either the string `'>'` or `'<'`. (This is the function called by `gtr` and `ltr`.)
287 - `intersects(range)`: Return true if any of the ranges comparators intersect
288
289 Note that, since ranges may be non-contiguous, a version might not be greater than a range, less than a range, _or_ satisfy a range! For example, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9` until `2.0.0`, so the version `1.2.10` would not be greater than the range (because `2.0.1` satisfies, which is higher), nor less than the range (since `1.2.8` satisfies, which is lower), and it also does not satisfy the range.
290
291 If you want to know if a version satisfies or does not satisfy a range, use the `satisfies(version, range)` function.
292
293 ### Coercion
294
295 - `coerce(version)`: Coerces a string to semver if possible
296
297 This aims to provide a very forgiving translation of a non-semver string to semver. It looks for the first digit in a string, and consumes all remaining characters which satisfy at least a partial semver (e.g., `1`, `1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer versions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All surrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes `3.4.0`). Only text which lacks digits will fail coercion (`version one` is not valid). The maximum length for any semver component considered for coercion is 16 characters; longer components will be ignored (`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any semver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value components are invalid (`9999999999999999.4.7.4` is likely invalid).