Data.SemVer

An implementation of the Semantic Versioning specification located at http://semver.org.

A canonical Version type and functions representing behaviour as outlined in the specification are defined alongside additional lenses, traversals, common manipulations, and serialisation primitives.

Version

data Version

An opaque type representing a successfully decoded or constructed semantic version. See the related functions and lenses for modification and update.

• The Eq instance represents exhaustive equality with all components considered.
• The Ord instance implements the precedence rules from the semantic version specification with metadata being ignored.

Instances

Eq Version

Ord Version

Show Version

NFData Version

Constructors

version

Arguments

:: Int

Major version component.

-> Int

Minor version component.

-> Int

Patch version component.

-> [Identifier]

Release identifiers.

-> [Identifier]

Metadata identifiers.

-> Version

Smart constructor fully specifying all available version components.

initial :: Version

A default Version which can be used to signify initial development.

Note: Equivalent to 0.0.0

Lenses

versionMajor :: Functor f => (Int -> f Int) -> Version -> f Version

Lens for the major version component.

versionMinor :: Functor f => (Int -> f Int) -> Version -> f Version

Lens for minor version component.

versionPatch :: Functor f => (Int -> f Int) -> Version -> f Version

Lens for the patch version component.

versionRelease :: Functor f => ([Identifier] -> f [Identifier]) -> Version -> f Version

Lens for the list of release identifiers.

versionMeta :: Functor f => ([Identifier] -> f [Identifier]) -> Version -> f Version

Lens for the list of metadata identifiers.

Incrementing

incrementMajor :: Version -> Version

Increment the major component of a Version by 1, resetting the minor and patch components.

• Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.
• It MAY include minor and patch level changes.
• Patch and minor version MUST be reset to 0 when major version is incremented.

incrementMinor :: Version -> Version

Increment the minor component of a Version by 1, resetting the patch component.

• Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API.
• It MUST be incremented if any public API functionality is marked as deprecated.
• It MAY be incremented if substantial new functionality or improvements are introduced within the private code.
• It MAY include patch level changes.
• Patch version MUST be reset to 0 when minor version is incremented.

incrementPatch :: Version -> Version

Increment the patch component of a Version by 1.

• Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced.
• A bug fix is defined as an internal change that fixes incorrect behavior.

Predicates

isDevelopment :: Version -> Bool

Check if the Version is considered unstable.

• Major version zero (0.y.z) is for initial development.
• Anything may change at any time.
• The public API should not be considered stable.

isPublic :: Version -> Bool

Check if the Version is considered stable.

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

Encoding

toString :: Version -> String

Convert a Version to it's readable String representation.

Note: This is optimised for cases where you wish to use a String and as such is faster than the semantically equivalent unpack . toLazyText.

toText :: Version -> Text

Convert a Version to a strict Text representation.

Note: Equivalent to toStrict . toLazyText

toLazyText :: Version -> Text

Convert a Version to a Text representation.

Note: This uses a lower Builder buffer size optimised for commonly found version formats. If you have particuarly long version numbers using toBuilder and toLazyTextWith to control the buffer size is recommended.

toBuilder :: Version -> Builder

Convert a Version to a Builder.

Decoding

fromText :: Text -> Either String Version

Parse a Version from Text, returning an attoparsec error message in the Left case on failure.

fromLazyText :: Text -> Either String Version

Parse a Version from Text, returning an attoparsec error message in the Left case on failure.

Note: The underlying attoparsec Parser is based on Text and this is equivalent to fromText . toStrict

parser :: Parser Version

A greedy attoparsec Parser which requires the entire Text input to match.

Identifiers

data Identifier

A type representing an individual identifier from the release or metadata components of a Version.

• The Ord instance implements precedence according to the semantic version specification, with numeric identifiers being of lower precedence than textual identifiers, otherwise lexicographic ordering is used.

The functions numeric and textual can be used to construct an Identifier.

Instances

Eq Identifier

Ord Identifier

Show Identifier

NFData Identifier

Constructors

numeric :: Int -> Identifier

Safely construct a numeric identifier.

textual :: Text -> Maybe Identifier

Construct an identifier from the given Text, returning Nothing if neither a numeric or valid textual input is supplied.

Prisms

_Numeric :: Applicative f => (Int -> f Int) -> Identifier -> f Identifier

_Textual :: Applicative f => (Text -> f Text) -> Identifier -> f Identifier

Delimiters

A set of delimiters is used to encode/decode a Version and specify alternative serialisation strategies.

Lenses can be used to modify the default delimiter set, as in the following example - using alpha characters to encode the version as a valid DNS CNAME:

 let Right v = fromText 1.2.3+40
 let alpha = delimiters & delimMajor .= 'm' & delimPatch .= 'p' & delimRelease .= 'r' & delimMeta .= 'd' & delimIdent .= 'i'

Data.Text.Lazy.Builder.toLazyText ("app01-"  toDelimitedBuilder alpha v  ".dmz.internal")

Would result in the following Text:

 app01-1m2p3d40.dmz.internal

Using the same Delimiters set with delimitedParser would ensure correct decoding behaviour.

data Delimiters

An opaque set representing the seperators used to delimit semantic version components.

Instances

Eq Delimiters

Ord Delimiters

Show Delimiters

NFData Delimiters

Constructor

delimiters :: Delimiters

The default set of delimiters used in the semantic version specification.

Example: Given exhaustive version components would result in the following hypothetical version:

 1.2.3-alpha.1+sha.exp.12ab3d9

Lenses

delimMinor :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters

Lens for the minor version delimiter. Default: .

delimPatch :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters

Lens for the patch version delimiter. Default: .

delimRelease :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters

Lens for the release component delimiter. Default: -

delimMeta :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters

Lens for the metadata component delimiter. Default: +

delimIdent :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters

Lens for the individual identifier delimiter. Default: .

Encoding

toDelimitedBuilder :: Delimiters -> Version -> Builder

Convert a Version to a Builder using the specified Delimiters set.

Decoding

delimitedParser :: Delimiters -> Parser Version

A greedy attoparsec Parser using the specified Delimiters set which requires the entire Text input to match.