BDCS.NPM.SemVer

Documentation

data SemVer

A Semantic version, as defined by http://semver.org/

Constructors

SemVer

Fields

• major :: Integer
• minor :: Integer
• patch :: Integer
• preRelease :: [SemVerIdentifier]
• buildMeta :: [SemVerIdentifier]

Instances

Eq SemVer

Methods

(==) :: SemVer -> SemVer -> Bool

(/=) :: SemVer -> SemVer -> Bool

Ord SemVer

Methods

compare :: SemVer -> SemVer -> Ordering

(<) :: SemVer -> SemVer -> Bool

(<=) :: SemVer -> SemVer -> Bool

(>) :: SemVer -> SemVer -> Bool

(>=) :: SemVer -> SemVer -> Bool

max :: SemVer -> SemVer -> SemVer

min :: SemVer -> SemVer -> SemVer

Show SemVer

Methods

showsPrec :: Int -> SemVer -> ShowS

show :: SemVer -> String

showList :: [SemVer] -> ShowS

data SemVerIdentifier

a component of a pre-release or buildmeta identifier list

Constructors

NumericIdentifier Integer

TextIdentifier Text

Instances

Eq SemVerIdentifier

Methods

(==) :: SemVerIdentifier -> SemVerIdentifier -> Bool

(/=) :: SemVerIdentifier -> SemVerIdentifier -> Bool

Ord SemVerIdentifier

Methods

compare :: SemVerIdentifier -> SemVerIdentifier -> Ordering

(<) :: SemVerIdentifier -> SemVerIdentifier -> Bool

(<=) :: SemVerIdentifier -> SemVerIdentifier -> Bool

(>) :: SemVerIdentifier -> SemVerIdentifier -> Bool

(>=) :: SemVerIdentifier -> SemVerIdentifier -> Bool

max :: SemVerIdentifier -> SemVerIdentifier -> SemVerIdentifier

min :: SemVerIdentifier -> SemVerIdentifier -> SemVerIdentifier

Show SemVerIdentifier

Methods

showsPrec :: Int -> SemVerIdentifier -> ShowS

show :: SemVerIdentifier -> String

showList :: [SemVerIdentifier] -> ShowS

type SemVerRangePart = [(Ordering, SemVer)]

A single version condition, e.g. >= 1.0.0. To satisfy the condition, a SemVer must match at least one of the Orderings.

type SemVerRange = [SemVerRangePart]

A range of semantic versions. To satisfy the range, a SemVer must satisfy every element of the list.

type SemVerRangeSet = [SemVerRange]

A set of semantic version ranges. To satisfy the set, a SemVer must satisfy at least one of the ranges in the list.

parseSemVer :: Text -> Either ParseError SemVer

Parse a semantic version

parseSemVerRangeSet :: Text -> Either ParseError SemVerRangeSet

Parse a SemVer range set according to the npm syntax.

satisfies :: SemVer -> SemVerRangeSet -> Bool

Whether a given version satisfies a given range.

When the version contains pre-release tags, it only satisifes a SemVerRange if at least one version in the range has a matching major.minor.patch version number and also contains pre-release tags.

toText :: SemVer -> Text