Repository files navigation

npm install semver

As a node module:

constsemver=require('semver')semver.valid('1.2.3')// '1.2.3'semver.valid('a.b.c')// nullsemver.clean('  =v1.2.3   ')// '1.2.3'semver.satisfies('1.2.3','1.x || >=2.5.0 || 5.0.0 - 7.2.3')// truesemver.gt('1.2.3','9.8.7')// falsesemver.lt('1.2.3','9.8.7')// truesemver.minVersion('>=1.0.0')// '1.0.0'semver.valid(semver.coerce('v2'))// '2.0.0'semver.valid(semver.coerce('42.6.7.9.3-alpha'))// '42.6.7'

You can also just load the module for the function that you care about ifyou'd like to minimize your footprint.

// load the whole API at once in a single objectconstsemver=require('semver')// or just load the bits you need// all of them listed here, just pick and choose what you want// classesconstSemVer=require('semver/classes/semver')constComparator=require('semver/classes/comparator')constRange=require('semver/classes/range')// functions for working with versionsconstsemverParse=require('semver/functions/parse')constsemverValid=require('semver/functions/valid')constsemverClean=require('semver/functions/clean')constsemverInc=require('semver/functions/inc')constsemverDiff=require('semver/functions/diff')constsemverMajor=require('semver/functions/major')constsemverMinor=require('semver/functions/minor')constsemverPatch=require('semver/functions/patch')constsemverPrerelease=require('semver/functions/prerelease')constsemverCompare=require('semver/functions/compare')constsemverRcompare=require('semver/functions/rcompare')constsemverCompareLoose=require('semver/functions/compare-loose')constsemverCompareBuild=require('semver/functions/compare-build')constsemverSort=require('semver/functions/sort')constsemverRsort=require('semver/functions/rsort')// low-level comparators between versionsconstsemverGt=require('semver/functions/gt')constsemverLt=require('semver/functions/lt')constsemverEq=require('semver/functions/eq')constsemverNeq=require('semver/functions/neq')constsemverGte=require('semver/functions/gte')constsemverLte=require('semver/functions/lte')constsemverCmp=require('semver/functions/cmp')constsemverCoerce=require('semver/functions/coerce')// working with rangesconstsemverSatisfies=require('semver/functions/satisfies')constsemverMaxSatisfying=require('semver/ranges/max-satisfying')constsemverMinSatisfying=require('semver/ranges/min-satisfying')constsemverToComparators=require('semver/ranges/to-comparators')constsemverMinVersion=require('semver/ranges/min-version')constsemverValidRange=require('semver/ranges/valid')constsemverOutside=require('semver/ranges/outside')constsemverGtr=require('semver/ranges/gtr')constsemverLtr=require('semver/ranges/ltr')constsemverIntersects=require('semver/ranges/intersects')constsemverSimplifyRange=require('semver/ranges/simplify')constsemverRangeSubset=require('semver/ranges/subset')

As a command-line utility:

$ semver -hA JavaScript implementation of the https://semver.org/ specificationCopyright Isaac Z. SchlueterUsage: semver [options] <version> [<version> [...]]Prints valid versions sorted by SemVer precedenceOptions:-r --range <range>        Print versions that match the specified range.-i --increment [<level>]        Increment a version by the specified level.  Level can        be one of: major, minor, patch, premajor, preminor,        prepatch, prerelease, or release.  Default level is 'patch'.        Only one version may be specified.--preid <identifier>        Identifier to be used to prefix premajor, preminor,        prepatch or prerelease version increments.-l --loose        Interpret versions and ranges loosely-n <0|1>        This is the base to be used for the prerelease identifier.-p --include-prerelease        Always include prerelease versions in range matching-c --coerce        Coerce a string into SemVer if possible        (does not imply --loose)--rtl        Coerce version strings right to left--ltr        Coerce version strings left to right (default)Program exits successfully if any valid version satisfiesall supplied ranges, and prints all satisfying versions.If no satisfying versions are found, then exits failure.Versions are printed in ascending order, so supplyingmultiple versions to the utility will just sort them.

A "version" is described by thev2.0.0 specification found athttps://semver.org/.

A leading"=" or"v" character is stripped off and ignored.Support for stripping a leading "v" is kept for compatibility withv1.0.0 of the SemVerspecification but should not be used anymore.

Aversion range is a set ofcomparators that specify versionsthat satisfy the range.

Acomparator is composed of anoperator and aversion. The setof primitiveoperators is:

• < Less than
• <= Less than or equal to
• > Greater than
• >= Greater than or equal to
• = Equal. If no operator is specified, then equality is assumed,so this operator is optional but MAY be included.

For example, the comparator>=1.2.7 would match the versions1.2.7,1.2.8,2.5.3, and1.3.9, but not the versions1.2.6or1.1.0. The comparator>1 is equivalent to>=2.0.0 andwould match the versions2.0.0 and3.1.0, but not the versions1.0.1 or1.1.0.

Comparators can be joined by whitespace to form acomparator set,which is satisfied by theintersection of all of the comparatorsit includes.

A range is composed of one or more comparator sets, joined by||. Aversion matches a range if and only if every comparator in at leastone of the||-separated comparator sets is satisfied by the version.

For example, the range>=1.2.7 <1.3.0 would match the versions1.2.7,1.2.8, and1.2.99, but not the versions1.2.6,1.3.0,or1.1.0.

The range1.2.7 || >=1.2.9 <2.0.0 would match the versions1.2.7,1.2.9, and1.4.6, but not the versions1.2.8 or2.0.0.

If a version has a prerelease tag (for example,1.2.3-alpha.3) thenit will only be allowed to satisfy comparator sets if at least onecomparator with the same[major, minor, patch] tuple also has aprerelease tag.

For example, the range>1.2.3-alpha.3 would be allowed to match theversion1.2.3-alpha.7, but it wouldnot be satisfied by3.4.5-alpha.9, even though3.4.5-alpha.9 is technically "greaterthan"1.2.3-alpha.3 according to the SemVer sort rules. The versionrange only accepts prerelease tags on the1.2.3 version.Version3.4.5would satisfy the range because it does not have aprerelease flag, and3.4.5 is greater than1.2.3-alpha.7.

The purpose of this behavior is twofold. First, prerelease versionsfrequently are updated very quickly, and contain many breaking changesthat are (by the author's design) not yet fit for public consumption.Therefore, by default, they are excluded from range-matchingsemantics.

Second, a user who has opted into using a prerelease version hasindicated the intent to usethat specific set ofalpha/beta/rc versions. By including a prerelease tag in the range,the user is indicating that they are aware of the risk. However, itis still not appropriate to assume that they have opted into taking asimilar risk on thenext set of prerelease versions.

Note that this behavior can be suppressed (treating all prereleaseversions as if they were normal versions, for range-matching)by setting theincludePrerelease flag on the optionsobject to anyfunctions that dorange matching.

The method.inc takes an additionalidentifier string argument thatwill append the value of the string as a prerelease identifier:

semver.inc('1.2.3','prerelease','beta')// '1.2.4-beta.0'

command-line example:

$ semver 1.2.3 -i prerelease --preid beta1.2.4-beta.0

Which then can be used to increment further:

$ semver 1.2.4-beta.0 -i prerelease1.2.4-beta.1

To get out of the prerelease phase, use therelease option:

$ semver 1.2.4-beta.1 -i release1.2.4

The method.inc takes an optional parameter 'identifierBase' stringthat will let you let your prerelease number as zero-based or one-based.Set tofalse to omit the prerelease number altogether.If you do not specify this parameter, it will default to zero-based.

semver.inc('1.2.3','prerelease','beta','1')// '1.2.4-beta.1'

semver.inc('1.2.3','prerelease','beta',false)// '1.2.4-beta'

command-line example:

$ semver 1.2.3 -i prerelease --preid beta -n 11.2.4-beta.1

$ semver 1.2.3 -i prerelease --preid beta -nfalse1.2.4-beta

Advanced range syntax desugars to primitive comparators indeterministic ways.

Advanced ranges may be combined in the same way as primitivecomparators using white space or||.

Specifies an inclusive set.

• 1.2.3 - 2.3.4 :=>=1.2.3 <=2.3.4

If a partial version is provided as the first version in the inclusiverange, then the missing pieces are replaced with zeroes.

• 1.2 - 2.3.4 :=>=1.2.0 <=2.3.4

If a partial version is provided as the second version in theinclusive range, then all versions that start with the supplied partsof the tuple are accepted, but nothing that would be greater than theprovided tuple parts.

• 1.2.3 - 2.3 :=>=1.2.3 <2.4.0-0
• 1.2.3 - 2 :=>=1.2.3 <3.0.0-0

Any ofX,x, or* may be used to "stand in" for one of thenumeric values in the[major, minor, patch] tuple.

• * :=>=0.0.0 (Any non-prerelease version satisfies, unlessincludePrerelease is specified, in which case any version at allsatisfies)
• 1.x :=>=1.0.0 <2.0.0-0 (Matching major version)
• 1.2.x :=>=1.2.0 <1.3.0-0 (Matching major and minor versions)

A partial version range is treated as an X-Range, so the specialcharacter is in fact optional.

• "" (empty string) :=* :=>=0.0.0
• 1 :=1.x.x :=>=1.0.0 <2.0.0-0
• 1.2 :=1.2.x :=>=1.2.0 <1.3.0-0

Allows patch-level changes if a minor version is specified on thecomparator. Allows minor-level changes if not.

• ~1.2.3 :=>=1.2.3 <1.(2+1).0 :=>=1.2.3 <1.3.0-0
• ~1.2 :=>=1.2.0 <1.(2+1).0 :=>=1.2.0 <1.3.0-0 (Same as1.2.x)
• ~1 :=>=1.0.0 <(1+1).0.0 :=>=1.0.0 <2.0.0-0 (Same as1.x)
• ~0.2.3 :=>=0.2.3 <0.(2+1).0 :=>=0.2.3 <0.3.0-0
• ~0.2 :=>=0.2.0 <0.(2+1).0 :=>=0.2.0 <0.3.0-0 (Same as0.2.x)
• ~0 :=>=0.0.0 <(0+1).0.0 :=>=0.0.0 <1.0.0-0 (Same as0.x)
• ~1.2.3-beta.2 :=>=1.2.3-beta.2 <1.3.0-0 Note that prereleases inthe1.2.3 version will be allowed, if they are greater than orequal tobeta.2. So,1.2.3-beta.4 would be allowed, but1.2.4-beta.2 would not, because it is a prerelease of adifferent[major, minor, patch] tuple.

Allows changes that do not modify the left-most non-zero element in the[major, minor, patch] tuple. In other words, this allows patch andminor updates for versions1.0.0 and above, patch updates forversions0.X >=0.1.0, andno updates for versions0.0.X.

Many authors treat a0.x version as if thex were the major"breaking-change" indicator.

Caret ranges are ideal when an author may make breaking changesbetween0.2.4 and0.3.0 releases, which is a common practice.However, it presumes that there willnot be breaking changes between0.2.4 and0.2.5. It allows for changes that are presumed to beadditive (but non-breaking), according to commonly observed practices.

• ^1.2.3 :=>=1.2.3 <2.0.0-0
• ^0.2.3 :=>=0.2.3 <0.3.0-0
• ^0.0.3 :=>=0.0.3 <0.0.4-0
• ^1.2.3-beta.2 :=>=1.2.3-beta.2 <2.0.0-0 Note that prereleases inthe1.2.3 version will be allowed, if they are greater than orequal tobeta.2. So,1.2.3-beta.4 would be allowed, but1.2.4-beta.2 would not, because it is a prerelease of adifferent[major, minor, patch] tuple.
• ^0.0.3-beta :=>=0.0.3-beta <0.0.4-0 Note that prereleases in the0.0.3 versiononly will be allowed, if they are greater than orequal tobeta. So,0.0.3-pr.2 would be allowed.

When parsing caret ranges, a missingpatch value desugars to thenumber0, but will allow flexibility within that value, even if themajor and minor versions are both0.

• ^1.2.x :=>=1.2.0 <2.0.0-0
• ^0.0.x :=>=0.0.0 <0.1.0-0
• ^0.0 :=>=0.0.0 <0.1.0-0

A missingminor andpatch values will desugar to zero, but alsoallow flexibility within those values, even if the major version iszero.

• ^1.x :=>=1.0.0 <2.0.0-0
• ^0.x :=>=0.0.0 <1.0.0-0

Putting all this together, here is a Backus-Naur grammar for ranges,for the benefit of parser authors:

range-set  ::= range ( logical-or range ) *logical-or ::= ( ' ' ) * '||' ( ' ' ) *range      ::= hyphen | simple ( ' ' simple ) * | ''hyphen     ::= partial ' - ' partialsimple     ::= primitive | partial | tilde | caretprimitive  ::= ( '<' | '>' | '>=' | '<=' | '=' ) partialpartial    ::= xr ( '.' xr ( '.' xr qualifier ? )? )?xr         ::= 'x' | 'X' | '*' | nrnr         ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *tilde      ::= '~' partialcaret      ::= '^' partialqualifier  ::= ( '-' pre )? ( '+' build )?pre        ::= partsbuild      ::= partsparts      ::= part ( '.' part ) *part       ::= nr | [-0-9A-Za-z]+

All methods and classes take a finaloptions object argument. Alloptions in this object arefalse by default. The options supportedare:

• loose: Be more forgiving about not-quite-valid semver strings.(Any resulting output will always be 100% strict compliant, ofcourse.) For backwards compatibility reasons, if theoptionsargument is a boolean value instead of an object, it is interpretedto be theloose param.
• includePrerelease: Set to suppress thedefaultbehavior ofexcluding prerelease tagged versions from ranges unless they areexplicitly opted into.

Strict-mode Comparators and Ranges will be strict about the SemVerstrings that they parse.

• valid(v): Return the parsed version, or null if it's not valid.
• inc(v, releaseType, options, identifier, identifierBase):Return the version incremented by the releasetype (major,premajor,minor,preminor,patch,prepatch,prerelease, orrelease), or null if it's not valid
  • premajor in one call will bump the version up to the next majorversion and down to a prerelease of that major version.preminor, andprepatch work the same way.
  • If called from a non-prerelease version,prerelease will work thesame asprepatch. It increments the patch version and then makes aprerelease. If the input version is already a prerelease it simplyincrements it.
  • release will remove any prerelease part of the version.
  • identifier can be used to prefixpremajor,preminor,prepatch, orprerelease version increments.identifierBaseis the base to be used for theprerelease identifier.
• prerelease(v): Returns an array of prerelease components, or nullif none exist. Example:prerelease('1.2.3-alpha.1') -> ['alpha', 1]
• major(v): Return the major version number.
• minor(v): Return the minor version number.
• patch(v): Return the patch version number.
• intersects(r1, r2, loose): Return true if the two supplied rangesor comparators intersect.
• parse(v): Attempt to parse a string as a semantic version, returning eitheraSemVer object ornull.

• gt(v1, v2):v1 > v2
• gte(v1, v2):v1 >= v2
• lt(v1, v2):v1 < v2
• lte(v1, v2):v1 <= v2
• eq(v1, v2):v1 == v2 This is true if they're logically equivalent,even if they're not the same string. You already know how tocompare strings.
• neq(v1, v2):v1 != v2 The opposite ofeq.
• cmp(v1, comparator, v2): Pass in a comparison string, and it'll callthe corresponding function above."===" and"!==" do simplestring comparison, but are included for completeness. Throws if aninvalid comparison string is provided.
• compare(v1, v2): Return0 ifv1 == v2, or1 ifv1 is greater, or-1 ifv2 is greater. Sorts in ascending order if passed toArray.sort().
• rcompare(v1, v2): The reverse ofcompare. Sorts an array of versionsin descending order when passed toArray.sort().
• compareBuild(v1, v2): The same ascompare but considersbuild when two versionsare equal. Sorts in ascending order if passed toArray.sort().
• compareLoose(v1, v2): Short forcompare(v1, v2, { loose: true }).
• diff(v1, v2): Returns the difference between two versions by the release type(major,premajor,minor,preminor,patch,prepatch, orprerelease),or null if the versions are the same.

• sort(versions): Returns a sorted array of versions based on thecompareBuildfunction.
• rsort(versions): The reverse ofsort. Returns an array of versions based onthecompareBuild function in descending order.

• intersects(comparator): Return true if the comparators intersect

• validRange(range): Return the valid range or null if it's not valid.
• satisfies(version, range): Return true if the version satisfies therange.
• maxSatisfying(versions, range): Return the highest version in the listthat satisfies the range, ornull if none of them do.
• minSatisfying(versions, range): Return the lowest version in the listthat satisfies the range, ornull if none of them do.
• minVersion(range): Return the lowest version that can matchthe given range.
• gtr(version, range): Returntrue if the version is greater than all theversions possible in the range.
• ltr(version, range): Returntrue if the version is less than all theversions possible in the range.
• outside(version, range, hilo): Return true if the version is outsidethe bounds of the range in either the high or low direction. Thehilo argument must be either the string'>' or'<'. (This isthe function called bygtr andltr.)
• intersects(range): Return true if any of the range comparators intersect.
• simplifyRange(versions, range): Return a "simplified" range thatmatches the same items in theversions list as the range specified. Notethat it doesnot guarantee that it would match the same versions in allcases, only for the set of versions provided. This is useful whengenerating ranges by joining together multiple versions with||programmatically, to provide the user with something a bit moreergonomic. If the provided range is shorter in string-length than thegenerated range, then that is returned.
• subset(subRange, superRange): Returntrue if thesubRange range isentirely contained by thesuperRange range.

Note that, since ranges may be non-contiguous, a version might not begreater than a range, less than a range,or satisfy a range! Forexample, the range1.2 <1.2.9 || >2.0.0 would have a hole from1.2.9until2.0.0, so version1.2.10 would not be greater than therange (because2.0.1 satisfies, which is higher), nor less than therange (since1.2.8 satisfies, which is lower), and it also does notsatisfy the range.

If you want to know if a version satisfies or does not satisfy arange, use thesatisfies(version, range) function.

• coerce(version, options): Coerces a string to semver if possible

This aims to provide a very forgiving translation of a non-semver string tosemver. It looks for the first digit in a string and consumes allremaining characters which satisfy at least a partial semver (e.g.,1,1.2,1.2.3) up to the max permitted length (256 characters). Longerversions are simply truncated (4.6.3.9.2-alpha2 becomes4.6.3). Allsurrounding text is simply ignored (v3.4 replaces v3.3.1 becomes3.4.0). Only text which lacks digits will fail coercion (version oneis not valid). The maximum length for any semver component considered forcoercion is 16 characters; longer components will be ignored(10000000000000000.4.7.4 becomes4.7.4). The maximum value for anysemver component isNumber.MAX_SAFE_INTEGER || (2**53 - 1); higher valuecomponents are invalid (9999999999999999.4.7.4 is likely invalid).

If theoptions.rtl flag is set, thencoerce will return the right-mostcoercible tuple that does not share an ending index with a longer coercibletuple. For example,1.2.3.4 will return2.3.4 in rtl mode, not4.0.0.1.2.3/4 will return4.0.0, because the4 is not a part ofany other overlapping SemVer tuple.

If theoptions.includePrerelease flag is set, then thecoerce result will containprerelease and build parts of a version. For example,1.2.3.4-rc.1+rev.2will preserve prereleaserc.1 and buildrev.2 in the result.

• clean(version): Clean a string to be a valid semver if possible

This will return a cleaned and trimmed semver version. If the providedversion is not valid a null will be returned. This does not work forranges.

ex.

• s.clean(' = v 2.1.5foo'):null
• s.clean(' = v 2.1.5foo', { loose: true }):'2.1.5-foo'
• s.clean(' = v 2.1.5-foo'):null
• s.clean(' = v 2.1.5-foo', { loose: true }):'2.1.5-foo'
• s.clean('=v2.1.5'):'2.1.5'
• s.clean(' =v2.1.5'):'2.1.5'
• s.clean(' 2.1.5 '):'2.1.5'
• s.clean('~1.0.0'):null

As a convenience, helper constants are exported to provide information about whatnode-semver supports:

• major
• premajor
• minor
• preminor
• patch
• prepatch
• prerelease

const semver = require('semver');if (semver.RELEASE_TYPES.includes(arbitraryUserInput)) {  console.log('This is a valid release type!');} else {  console.warn('This is NOT a valid release type!');}

2.0.0

const semver = require('semver');console.log('We are currently using the semver specification version:', semver.SEMVER_SPEC_VERSION);

You may pull in just the part of this semver utility that you need if youare sensitive to packing and tree-shaking concerns. The mainrequire('semver') export uses getter functions to lazily load the partsof the API that are used.

The following modules are available:

• require('semver')
• require('semver/classes')
• require('semver/classes/comparator')
• require('semver/classes/range')
• require('semver/classes/semver')
• require('semver/functions/clean')
• require('semver/functions/cmp')
• require('semver/functions/coerce')
• require('semver/functions/compare')
• require('semver/functions/compare-build')
• require('semver/functions/compare-loose')
• require('semver/functions/diff')
• require('semver/functions/eq')
• require('semver/functions/gt')
• require('semver/functions/gte')
• require('semver/functions/inc')
• require('semver/functions/lt')
• require('semver/functions/lte')
• require('semver/functions/major')
• require('semver/functions/minor')
• require('semver/functions/neq')
• require('semver/functions/parse')
• require('semver/functions/patch')
• require('semver/functions/prerelease')
• require('semver/functions/rcompare')
• require('semver/functions/rsort')
• require('semver/functions/satisfies')
• require('semver/functions/sort')
• require('semver/functions/valid')
• require('semver/ranges/gtr')
• require('semver/ranges/intersects')
• require('semver/ranges/ltr')
• require('semver/ranges/max-satisfying')
• require('semver/ranges/min-satisfying')
• require('semver/ranges/min-version')
• require('semver/ranges/outside')
• require('semver/ranges/simplify')
• require('semver/ranges/subset')
• require('semver/ranges/to-comparators')
• require('semver/ranges/valid')