name:                hgrev
version:             0.1.2
synopsis:            Compile Mercurial (hg) version info into Haskell code
license:             MIT
license-file:        LICENSE
author:              Luke Hoersten
maintainer:          luke@hoersten.org
category:            Development
build-type:          Simple
cabal-version:       >=1.10
homepage:      https://github.com/LukeHoersten/hgrev
bug-reports:   https://github.com/LukeHoersten/hgrev/issues

description:
  [Overview]
  .
  `hgrev` provides two modules:
  - `Development.HgRev` - <https://mercurial.selenic.com 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 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 <https://hackage.haskell.org/package/gitrev gitrev> package for similar git functionality.

source-repository head
  type: git
  location: git://github.com/LukeHoersten/hgrev.git

library
  exposed-modules: Development.HgRev
                 , Development.HgRev.TH

  build-depends: aeson            >= 0.8  && < 0.10
               , base             >= 4.7  && < 4.9
               , bytestring       >= 0.10 && < 0.11
               , directory        >= 1.2  && < 1.3
               , filepath         >= 1.4  && < 1.5
               , process          >= 1.2  && < 1.4
               , template-haskell >= 2.10 && < 2.11

  hs-source-dirs:      src
  default-language:    Haskell2010