mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
172 lines
4.9 KiB
172 lines
4.9 KiB
.\" Generated with Ronnjs 0.3.8
|
|
.\" http://github.com/kapouer/ronnjs/
|
|
.
|
|
.TH "SEMVER" "7" "July 2013" "" ""
|
|
.
|
|
.SH "NAME"
|
|
\fBsemver\fR \-\- The semantic versioner for npm
|
|
.
|
|
.SH "Usage"
|
|
.
|
|
.nf
|
|
$ npm install semver
|
|
semver\.valid(\'1\.2\.3\') // \'1\.2\.3\'
|
|
semver\.valid(\'a\.b\.c\') // null
|
|
semver\.clean(\' =v1\.2\.3 \') // \'1\.2\.3\'
|
|
semver\.satisfies(\'1\.2\.3\', \'1\.x || >=2\.5\.0 || 5\.0\.0 \- 7\.2\.3\') // true
|
|
semver\.gt(\'1\.2\.3\', \'9\.8\.7\') // false
|
|
semver\.lt(\'1\.2\.3\', \'9\.8\.7\') // true
|
|
.
|
|
.fi
|
|
.
|
|
.P
|
|
As a command\-line utility:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
$ semver \-h
|
|
Usage: semver <version> [<version> [\.\.\.]] [\-r <range> | \-i <inc> | \-d <dec>]
|
|
Test if version(s) satisfy the supplied range(s), and sort them\.
|
|
Multiple versions or ranges may be supplied, unless increment
|
|
or decrement options are specified\. In that case, only a single
|
|
version may be used, and it is incremented by the specified level
|
|
Program exits successfully if any valid version satisfies
|
|
all supplied ranges, and prints all satisfying versions\.
|
|
If no versions are valid, or ranges are not satisfied,
|
|
then exits failure\.
|
|
Versions are printed in ascending order, so supplying
|
|
multiple versions to the utility will just sort them\.
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "Versions"
|
|
A "version" is described by the v2\.0\.0 specification found at \fIhttp://semver\.org/\fR\|\.
|
|
.
|
|
.P
|
|
A leading \fB"="\fR or \fB"v"\fR character is stripped off and ignored\.
|
|
.
|
|
.SH "Ranges"
|
|
The following range styles are supported:
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB1\.2\.3\fR A specific version\. When nothing else will do\. Note that
|
|
build metadata is still ignored, so \fB1\.2\.3+build2012\fR will satisfy
|
|
this range\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB>1\.2\.3\fR Greater than a specific version\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB<1\.2\.3\fR Less than a specific version\. If there is no prerelease
|
|
tag on the version range, then no prerelease version will be allowed
|
|
either, even though these are technically "less than"\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB>=1\.2\.3\fR Greater than or equal to\. Note that prerelease versions
|
|
are NOT equal to their "normal" equivalents, so \fB1\.2\.3\-beta\fR will
|
|
not satisfy this range, but \fB2\.3\.0\-beta\fR will\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB<=1\.2\.3\fR Less than or equal to\. In this case, prerelease versions
|
|
ARE allowed, so \fB1\.2\.3\-beta\fR would satisfy\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB1\.2\.3 \- 2\.3\.4\fR := \fB>=1\.2\.3 <=2\.3\.4\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB~1\.2\.3\fR := \fB>=1\.2\.3\-0 <1\.3\.0\-0\fR "Reasonably close to 1\.2\.3"\. When
|
|
using tilde operators, prerelease versions are supported as well,
|
|
but a prerelease of the next significant digit will NOT be
|
|
satisfactory, so \fB1\.3\.0\-beta\fR will not satisfy \fB~1\.2\.3\fR\|\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB~1\.2\fR := \fB>=1\.2\.0\-0 <1\.3\.0\-0\fR "Any version starting with 1\.2"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB1\.2\.x\fR := \fB>=1\.2\.0\-0 <1\.3\.0\-0\fR "Any version starting with 1\.2"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB~1\fR := \fB>=1\.0\.0\-0 <2\.0\.0\-0\fR "Any version starting with 1"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB1\.x\fR := \fB>=1\.0\.0\-0 <2\.0\.0\-0\fR "Any version starting with 1"
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Ranges can be joined with either a space (which implies "and") or a \fB||\fR (which implies "or")\.
|
|
.
|
|
.SH "Functions"
|
|
All methods and classes take a final \fBloose\fR boolean argument that, if
|
|
true, will be more forgiving about not\-quite\-valid semver strings\.
|
|
The resulting output will always be 100% strict, of course\.
|
|
.
|
|
.P
|
|
Strict\-mode Comparators and Ranges will be strict about the SemVer
|
|
strings that they parse\.
|
|
.
|
|
.IP "\(bu" 4
|
|
valid(v): Return the parsed version, or null if it\'s not valid\.
|
|
.
|
|
.IP "\(bu" 4
|
|
inc(v, release): Return the version incremented by the release type
|
|
(major, minor, patch, or prerelease), or null if it\'s not valid\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SS "Comparison"
|
|
.
|
|
.IP "\(bu" 4
|
|
gt(v1, v2): \fBv1 > v2\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
gte(v1, v2): \fBv1 >= v2\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
lt(v1, v2): \fBv1 < v2\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
lte(v1, v2): \fBv1 <= v2\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
eq(v1, v2): \fBv1 == v2\fR This is true if they\'re logically equivalent,
|
|
even if they\'re not the exact same string\. You already know how to
|
|
compare strings\.
|
|
.
|
|
.IP "\(bu" 4
|
|
neq(v1, v2): \fBv1 != v2\fR The opposite of eq\.
|
|
.
|
|
.IP "\(bu" 4
|
|
cmp(v1, comparator, v2): Pass in a comparison string, and it\'ll call
|
|
the corresponding function above\. \fB"==="\fR and \fB"!=="\fR do simple
|
|
string comparison, but are included for completeness\. Throws if an
|
|
invalid comparison string is provided\.
|
|
.
|
|
.IP "\(bu" 4
|
|
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()\.
|
|
.
|
|
.IP "\(bu" 4
|
|
rcompare(v1, v2): The reverse of compare\. Sorts an array of versions
|
|
in descending order when passed to Array\.sort()\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SS "Ranges"
|
|
.
|
|
.IP "\(bu" 4
|
|
validRange(range): Return the valid range or null if it\'s not valid
|
|
.
|
|
.IP "\(bu" 4
|
|
satisfies(version, range): Return true if the version satisfies the
|
|
range\.
|
|
.
|
|
.IP "\(bu" 4
|
|
maxSatisfying(versions, range): Return the highest version in the list
|
|
that satisfies the range, or null if none of them do\.
|
|
.
|
|
.IP "" 0
|
|
|
|
|