hgrev: Compile Mercurial (hg) version info into Haskell code

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.




hgrev provides two modules: - Development.HgRev - Mercurial (hg) Haskell API - Development.HgRev.TH - Template Haskell splice to compile version info into Haskell code

Use $(hgRevStateTH defFormat) with Template Haskell enabled to insert the formatted version string.


hgrev requires the hg binary is installed and available on the system. Development.HgRev.HgRev and Development.HgRev.HgState are obtained via two separate calls to hg because working directory state isn't available programmatically.

Usage Example
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TemplateHaskell   #-}

module Example where

import           Data.Monoid          ((<>))
import           Data.Text            (Text, pack)
import           Development.HgRev.TH (defFormat, hgRevStateTH, jsonFormat)
import           Options.Applicative  (Parser, ParserInfo, execParser, fullDesc,
                                       help, helper, info, infoOption, long,
                                       progDesc, short)

main :: IO ()
main = execParser parserInfo >> return ()

verSwitch :: Parser (a -> a)
verSwitch =
    infoOption ("HG rev: " <> $(hgRevStateTH defFormat))
    $  long "version"
    <> short 'v'
    <> help "Display version information"

jsonSwitch :: Parser (a -> a)
jsonSwitch =
    infoOption $(hgRevStateTH jsonFormat)
    $  long "json"
    <> short 'J'
    <> help "Display JSON version information"

parserInfo :: ParserInfo (a -> a)
parserInfo = info (helper <*> verSwitch <* jsonSwitch) fullDesc

Check out the gitrev package for similar git functionality.


Versions0.1.0.0, 0.1.1, 0.1.2, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.2.0, 0.2.1, 0.2.2
Change logNone available
Dependenciesaeson (>=0.8 && <0.10), base (>=4.7 && <4.9), bytestring (==0.10.*), directory (==1.2.*), filepath (==1.4.*), process (>=1.2 && <1.4), template-haskell (==2.10.*) [details]
AuthorLuke Hoersten
Home pagehttps://github.com/LukeHoersten/hgrev
Bug trackerhttps://github.com/LukeHoersten/hgrev/issues
Source repositoryhead: git clone git://github.com/LukeHoersten/hgrev.git
UploadedSat Sep 26 18:13:27 UTC 2015 by LukeHoersten




Maintainers' corner

For package maintainers and hackage trustees