Types and parsers for software version numbers.
|Version on this page:||3.0.2|
|LTS Haskell 20.23:||5.0.5|
|Stackage Nightly 2023-05-28:||6.0.1|
|Latest on Hackage:||6.0.1|
Module documentation for 3.0.2
A Haskell library for parsing and comparing software version numbers.
We like to give version numbers to our software in a myriad of ways. Some ways follow strict guidelines for incrementing and comparison. Some follow conventional wisdom and are generally self-consistent. Some are just plain asinine. This library provides a means of parsing and comparing any style of versioning, be it a nice Semantic Version like this:
…or a monstrosity like this:
Please switch to Semantic Versioning if you aren’t currently using it. It provides consistency in version incrementing and has the best constraints on comparisons.
parseV is the function you want. It attempts to parse a given
Text using the three individual parsers,
one fails, it tries the next. If you know you only want to parse one
specific version type, use that parser directly (e.g.
Lenses and Traversals
The parse result types have Lenses/Traversals for accessing their data fields. For instance, to increment the patch number of a parsed SemVer, you could:
incPatch :: SemVer -> SemVer incPatch s = s & svPatch %~ (+ 1)
Or, something more involved:
-- | Get all major versions of legally parsed SemVers. majors :: [Text] -> [Int] majors vs = vs ^.. each . to semver . _Right . svMajor
to semver . _Right is clunky, so we provide some direct
Traverals inspired by
-- | Get all major versions of legally parsed SemVers. majors :: [Text] -> [Int] majors vs = vs ^.. each . _SemVer . svMajor
_SemVer only attempts to parse as true Semantic Versioning. If
the package versions you’re parsing don’t agree to a standard, you can
achieve a similar result via:
-- | Get all major versions of potentially parsed SemVers. majors :: [Text] -> [Int] majors vs = vs ^.. each . _Versioning . _Ideal . svMajor
We can also use these
Text Traversals to increment versions, as above:
incPatch :: Text -> Text incPatch s = s & _SemVer . svPatch %~ (+ 1) > incPatch "1.2.3" "1.2.4"
- Expose internal parsers so that they could be used in other parser programs that parse version numbers in larger files.
- Updated for
- Switched to
megaparsecto perform all parsing as
- Support for legacy
- Added more Traversals and INLINE’d all Lenses/Traversals
- Added Lenses and Traversals (no