The hgrev package

[Tags:library, mit]
Overview

hgrev provides two modules:

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

Requirements

hgrev requires the hg binary version 3.2 or greater 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
 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.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.2.0, 0.2.1
Dependencies aeson (>=0.8 && <1.1), base (>=4.7 && <4.10), bytestring (==0.10.*), directory (>=1.2 && <1.4), filepath (==1.4.*), process (>=1.2 && <1.5), template-haskell (>=2.10 && <2.12) [details]
License MIT
Author Luke Hoersten
Maintainer luke@hoersten.org
Category Development
Home page https://github.com/LukeHoersten/hgrev
Bug tracker https://github.com/LukeHoersten/hgrev/issues
Source repository head: git clone git://github.com/LukeHoersten/hgrev.git
Uploaded Fri Jan 27 16:58:26 UTC 2017 by LukeHoersten
Distributions NixOS:0.2.1
Downloads 592 total (64 in the last 30 days)
Votes
1 []
Status Docs available [build log]
Last success reported on 2017-01-27 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for hgrev

Readme for hgrev-0.2.1

HgRev

Compile Mercurial (hg) version info into Haskell code

Overview

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.

Requirements

hgrev requires the hg binary version 3.2 or greater 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.