versions-2.0.0: README.md
versions
========
[](https://travis-ci.org/aurapm/haskell-versions)
[](https://coveralls.io/github/aurapm/haskell-versions?branch=master)
A Haskell library for parsing and comparing software version numbers.
About
-----
We like to give version numbers to our software in a myriad of different
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:
> 1.2.3-r1+git123
...or a monstrosity like this:
> 2:10.2+0.0093r3+1-1
Please switch to [Semantic Versioning](http://semver.org) if you aren't
currently using it. It provides consistency in version incrementing and has
the best constraints on comparisons.
Usage
-----
In general, `parseV` is the function you want. It attempts to parse a given
Text using the three individual parsers, `semver`, `version` and `mess`. If
one fails, it tries the next. If you know you only want to parse one
specific version type, use that parser directly (e.g. `semver`).
#### 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:
```haskell
incPatch :: SemVer -> SemVer
incPatch s = s & svPatch %~ (+ 1)
```
Or, something more involved:
```haskell
-- | Get all major versions of legally parsed SemVers.
majors :: [Text] -> [Int]
majors vs = vs ^.. each . to semver . _Right . svMajor
```
The `to semver . _Right` is clunky, so we provide some direct `Text`
Traverals inspired by
([micro](http://hackage.haskell.org/package/microlens-aeson))
[lens-aeson](http://hackage.haskell.org/package/lens-aeson):
```haskell
-- | Get all major versions of legally parsed SemVers.
majors :: [Text] -> [Int]
majors vs = vs ^.. each . _SemVer . svMajor
```
Note that `_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:
```haskell
-- | 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:
```haskell
incPatch :: Text -> Text
incPatch s = s & _SemVer . svPatch %~ (+ 1)
> incPatch "1.2.3"
"1.2.4"
```