Ejdjdososs/fable-ai
0
1semver(1) -- The semantic versioner for npm2===========================================3 4## Install5 6```bash7npm install semver8````9 10## Usage11 12As a node module:13 14```js15const semver = require('semver')16 17semver.valid('1.2.3') // '1.2.3'18semver.valid('a.b.c') // null19semver.clean(' =v1.2.3 ') // '1.2.3'20semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true21semver.gt('1.2.3', '9.8.7') // false22semver.lt('1.2.3', '9.8.7') // true23semver.minVersion('>=1.0.0') // '1.0.0'24semver.valid(semver.coerce('v2')) // '2.0.0'25semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'26```27 28As a command-line utility:29 30```31$ semver -h32 33A JavaScript implementation of the https://semver.org/ specification34Copyright Isaac Z. Schlueter35 36Usage: semver [options] <version> [<version> [...]]37Prints valid versions sorted by SemVer precedence38 39Options:40-r --range <range>41 Print versions that match the specified range.42 43-i --increment [<level>]44 Increment a version by the specified level. Level can45 be one of: major, minor, patch, premajor, preminor,46 prepatch, or prerelease. Default level is 'patch'.47 Only one version may be specified.48 49--preid <identifier>50 Identifier to be used to prefix premajor, preminor,51 prepatch or prerelease version increments.52 53-l --loose54 Interpret versions and ranges loosely55 56-p --include-prerelease57 Always include prerelease versions in range matching58 59-c --coerce60 Coerce a string into SemVer if possible61 (does not imply --loose)62 63--rtl64 Coerce version strings right to left65 66--ltr67 Coerce version strings left to right (default)68 69Program exits successfully if any valid version satisfies70all supplied ranges, and prints all satisfying versions.71 72If no satisfying versions are found, then exits failure.73 74Versions are printed in ascending order, so supplying75multiple versions to the utility will just sort them.76```77 78## Versions79 80A "version" is described by the `v2.0.0` specification found at81<https://semver.org/>.82 83A leading `"="` or `"v"` character is stripped off and ignored.84 85## Ranges86 87A `version range` is a set of `comparators` which specify versions88that satisfy the range.89 90A `comparator` is composed of an `operator` and a `version`. The set91of primitive `operators` is:92 93* `<` Less than94* `<=` Less than or equal to95* `>` Greater than96* `>=` Greater than or equal to97* `=` Equal. If no operator is specified, then equality is assumed,98 so this operator is optional, but MAY be included.99 100For example, the comparator `>=1.2.7` would match the versions101`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6`102or `1.1.0`.103 104Comparators can be joined by whitespace to form a `comparator set`,105which is satisfied by the **intersection** of all of the comparators106it includes.107 108A range is composed of one or more comparator sets, joined by `||`. A109version matches a range if and only if every comparator in at least110one of the `||`-separated comparator sets is satisfied by the version.111 112For example, the range `>=1.2.7 <1.3.0` would match the versions113`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`,114or `1.1.0`.115 116The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`,117`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.118 119### Prerelease Tags120 121If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then122it will only be allowed to satisfy comparator sets if at least one123comparator with the same `[major, minor, patch]` tuple also has a124prerelease tag.125 126For example, the range `>1.2.3-alpha.3` would be allowed to match the127version `1.2.3-alpha.7`, but it would *not* be satisfied by128`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically "greater129than" `1.2.3-alpha.3` according to the SemVer sort rules. The version130range only accepts prerelease tags on the `1.2.3` version. The131version `3.4.5` *would* satisfy the range, because it does not have a132prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.133 134The purpose for this behavior is twofold. First, prerelease versions135frequently are updated very quickly, and contain many breaking changes136that are (by the author's design) not yet fit for public consumption.137Therefore, by default, they are excluded from range matching138semantics.139 140Second, a user who has opted into using a prerelease version has141clearly indicated the intent to use *that specific* set of142alpha/beta/rc versions. By including a prerelease tag in the range,143the user is indicating that they are aware of the risk. However, it144is still not appropriate to assume that they have opted into taking a145similar risk on the *next* set of prerelease versions.146 147Note that this behavior can be suppressed (treating all prerelease148versions as if they were normal versions, for the purpose of range149matching) by setting the `includePrerelease` flag on the options150object to any151[functions](https://github.com/npm/node-semver#functions) that do152range matching.153 154#### Prerelease Identifiers155 156The method `.inc` takes an additional `identifier` string argument that157will append the value of the string as a prerelease identifier:158 159```javascript160semver.inc('1.2.3', 'prerelease', 'beta')161// '1.2.4-beta.0'162```163 164command-line example:165 166```bash167$ semver 1.2.3 -i prerelease --preid beta1681.2.4-beta.0169```170 171Which then can be used to increment further:172 173```bash174$ semver 1.2.4-beta.0 -i prerelease1751.2.4-beta.1176```177 178### Advanced Range Syntax179 180Advanced range syntax desugars to primitive comparators in181deterministic ways.182 183Advanced ranges may be combined in the same way as primitive184comparators using white space or `||`.185 186#### Hyphen Ranges `X.Y.Z - A.B.C`187 188Specifies an inclusive set.189 190* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`191 192If a partial version is provided as the first version in the inclusive193range, then the missing pieces are replaced with zeroes.194 195* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`196 197If a partial version is provided as the second version in the198inclusive range, then all versions that start with the supplied parts199of the tuple are accepted, but nothing that would be greater than the200provided tuple parts.201 202* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`203* `1.2.3 - 2` := `>=1.2.3 <3.0.0`204 205#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`206 207Any of `X`, `x`, or `*` may be used to "stand in" for one of the208numeric values in the `[major, minor, patch]` tuple.209 210* `*` := `>=0.0.0` (Any version satisfies)211* `1.x` := `>=1.0.0 <2.0.0` (Matching major version)212* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)213 214A partial version range is treated as an X-Range, so the special215character is in fact optional.216 217* `""` (empty string) := `*` := `>=0.0.0`218* `1` := `1.x.x` := `>=1.0.0 <2.0.0`219* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`220 221#### Tilde Ranges `~1.2.3` `~1.2` `~1`222 223Allows patch-level changes if a minor version is specified on the224comparator. Allows minor-level changes if not.225 226* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`227* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)228* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)229* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`230* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)231* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)232* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in233 the `1.2.3` version will be allowed, if they are greater than or234 equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but235 `1.2.4-beta.2` would not, because it is a prerelease of a236 different `[major, minor, patch]` tuple.237 238#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`239 240Allows changes that do not modify the left-most non-zero element in the241`[major, minor, patch]` tuple. In other words, this allows patch and242minor updates for versions `1.0.0` and above, patch updates for243versions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`.244 245Many authors treat a `0.x` version as if the `x` were the major246"breaking-change" indicator.247 248Caret ranges are ideal when an author may make breaking changes249between `0.2.4` and `0.3.0` releases, which is a common practice.250However, it presumes that there will *not* be breaking changes between251`0.2.4` and `0.2.5`. It allows for changes that are presumed to be252additive (but non-breaking), according to commonly observed practices.253 254* `^1.2.3` := `>=1.2.3 <2.0.0`255* `^0.2.3` := `>=0.2.3 <0.3.0`256* `^0.0.3` := `>=0.0.3 <0.0.4`257* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in258 the `1.2.3` version will be allowed, if they are greater than or259 equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but260 `1.2.4-beta.2` would not, because it is a prerelease of a261 different `[major, minor, patch]` tuple.262* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the263 `0.0.3` version *only* will be allowed, if they are greater than or264 equal to `beta`. So, `0.0.3-pr.2` would be allowed.265 266When parsing caret ranges, a missing `patch` value desugars to the267number `0`, but will allow flexibility within that value, even if the268major and minor versions are both `0`.269 270* `^1.2.x` := `>=1.2.0 <2.0.0`271* `^0.0.x` := `>=0.0.0 <0.1.0`272* `^0.0` := `>=0.0.0 <0.1.0`273 274A missing `minor` and `patch` values will desugar to zero, but also275allow flexibility within those values, even if the major version is276zero.277 278* `^1.x` := `>=1.0.0 <2.0.0`279* `^0.x` := `>=0.0.0 <1.0.0`280 281### Range Grammar282 283Putting all this together, here is a Backus-Naur grammar for ranges,284for the benefit of parser authors:285 286```bnf287range-set ::= range ( logical-or range ) *288logical-or ::= ( ' ' ) * '||' ( ' ' ) *289range ::= hyphen | simple ( ' ' simple ) * | ''290hyphen ::= partial ' - ' partial291simple ::= primitive | partial | tilde | caret292primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial293partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?294xr ::= 'x' | 'X' | '*' | nr295nr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *296tilde ::= '~' partial297caret ::= '^' partial298qualifier ::= ( '-' pre )? ( '+' build )?299pre ::= parts300build ::= parts301parts ::= part ( '.' part ) *302part ::= nr | [-0-9A-Za-z]+303```304 305## Functions306 307All methods and classes take a final `options` object argument. All308options in this object are `false` by default. The options supported309are:310 311- `loose` Be more forgiving about not-quite-valid semver strings.312 (Any resulting output will always be 100% strict compliant, of313 course.) For backwards compatibility reasons, if the `options`314 argument is a boolean value instead of an object, it is interpreted315 to be the `loose` param.316- `includePrerelease` Set to suppress the [default317 behavior](https://github.com/npm/node-semver#prerelease-tags) of318 excluding prerelease tagged versions from ranges unless they are319 explicitly opted into.320 321Strict-mode Comparators and Ranges will be strict about the SemVer322strings that they parse.323 324* `valid(v)`: Return the parsed version, or null if it's not valid.325* `inc(v, release)`: Return the version incremented by the release326 type (`major`, `premajor`, `minor`, `preminor`, `patch`,327 `prepatch`, or `prerelease`), or null if it's not valid328 * `premajor` in one call will bump the version up to the next major329 version and down to a prerelease of that major version.330 `preminor`, and `prepatch` work the same way.331 * If called from a non-prerelease version, the `prerelease` will work the332 same as `prepatch`. It increments the patch version, then makes a333 prerelease. If the input version is already a prerelease it simply334 increments it.335* `prerelease(v)`: Returns an array of prerelease components, or null336 if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`337* `major(v)`: Return the major version number.338* `minor(v)`: Return the minor version number.339* `patch(v)`: Return the patch version number.340* `intersects(r1, r2, loose)`: Return true if the two supplied ranges341 or comparators intersect.342* `parse(v)`: Attempt to parse a string as a semantic version, returning either343 a `SemVer` object or `null`.344 345### Comparison346 347* `gt(v1, v2)`: `v1 > v2`348* `gte(v1, v2)`: `v1 >= v2`349* `lt(v1, v2)`: `v1 < v2`350* `lte(v1, v2)`: `v1 <= v2`351* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent,352 even if they're not the exact same string. You already know how to353 compare strings.354* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.355* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call356 the corresponding function above. `"==="` and `"!=="` do simple357 string comparison, but are included for completeness. Throws if an358 invalid comparison string is provided.359* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if360 `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.361* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions362 in descending order when passed to `Array.sort()`.363* `compareBuild(v1, v2)`: The same as `compare` but considers `build` when two versions364 are equal. Sorts in ascending order if passed to `Array.sort()`.365 `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.366* `diff(v1, v2)`: Returns difference between two versions by the release type367 (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),368 or null if the versions are the same.369 370### Comparators371 372* `intersects(comparator)`: Return true if the comparators intersect373 374### Ranges375 376* `validRange(range)`: Return the valid range or null if it's not valid377* `satisfies(version, range)`: Return true if the version satisfies the378 range.379* `maxSatisfying(versions, range)`: Return the highest version in the list380 that satisfies the range, or `null` if none of them do.381* `minSatisfying(versions, range)`: Return the lowest version in the list382 that satisfies the range, or `null` if none of them do.383* `minVersion(range)`: Return the lowest version that can possibly match384 the given range.385* `gtr(version, range)`: Return `true` if version is greater than all the386 versions possible in the range.387* `ltr(version, range)`: Return `true` if version is less than all the388 versions possible in the range.389* `outside(version, range, hilo)`: Return true if the version is outside390 the bounds of the range in either the high or low direction. The391 `hilo` argument must be either the string `'>'` or `'<'`. (This is392 the function called by `gtr` and `ltr`.)393* `intersects(range)`: Return true if any of the ranges comparators intersect394 395Note that, since ranges may be non-contiguous, a version might not be396greater than a range, less than a range, *or* satisfy a range! For397example, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9`398until `2.0.0`, so the version `1.2.10` would not be greater than the399range (because `2.0.1` satisfies, which is higher), nor less than the400range (since `1.2.8` satisfies, which is lower), and it also does not401satisfy the range.402 403If you want to know if a version satisfies or does not satisfy a404range, use the `satisfies(version, range)` function.405 406### Coercion407 408* `coerce(version, options)`: Coerces a string to semver if possible409 410This aims to provide a very forgiving translation of a non-semver string to411semver. It looks for the first digit in a string, and consumes all412remaining characters which satisfy at least a partial semver (e.g., `1`,413`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer414versions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All415surrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes416`3.4.0`). Only text which lacks digits will fail coercion (`version one`417is not valid). The maximum length for any semver component considered for418coercion is 16 characters; longer components will be ignored419(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any420semver component is `Integer.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value421components are invalid (`9999999999999999.4.7.4` is likely invalid).422 423If the `options.rtl` flag is set, then `coerce` will return the right-most424coercible tuple that does not share an ending index with a longer coercible425tuple. For example, `1.2.3.4` will return `2.3.4` in rtl mode, not426`4.0.0`. `1.2.3/4` will return `4.0.0`, because the `4` is not a part of427any other overlapping SemVer tuple.428 429### Clean430 431* `clean(version)`: Clean a string to be a valid semver if possible432 433This will return a cleaned and trimmed semver version. If the provided version is not valid a null will be returned. This does not work for ranges. 434 435ex.436* `s.clean(' = v 2.1.5foo')`: `null`437* `s.clean(' = v 2.1.5foo', { loose: true })`: `'2.1.5-foo'`438* `s.clean(' = v 2.1.5-foo')`: `null`439* `s.clean(' = v 2.1.5-foo', { loose: true })`: `'2.1.5-foo'`440* `s.clean('=v2.1.5')`: `'2.1.5'`441* `s.clean(' =v2.1.5')`: `2.1.5`442* `s.clean(' 2.1.5 ')`: `'2.1.5'`443* `s.clean('~1.0.0')`: `null`444