Safe Haskell	Safe-Inferred
Language	Haskell2010

Hpack

Contents

Version
Running Hpack
Options

Synopsis

version :: Version
hpack :: Verbose -> Options -> IO ()
hpackResult :: Options -> IO Result
hpackResultWithError :: Options -> IO (Either HpackError Result)
printResult :: Verbose -> Result -> IO ()
data Result = Result {
- resultWarnings :: [String]
- resultCabalFile :: String
- resultStatus :: Status
}
data Status
defaultOptions :: Options
setProgramName :: ProgramName -> Options -> Options
setTarget :: FilePath -> Options -> Options
setDecode :: (FilePath -> IO (Either String ([String], Value))) -> Options -> Options
setFormatYamlParseError :: (FilePath -> ParseException -> String) -> Options -> Options
getOptions :: FilePath -> [String] -> IO (Maybe (Verbose, Options))
data Verbose
- = Verbose
- | NoVerbose
data Options = Options {
}
data Force
- = Force
- | NoForce
data GenerateHashStrategy
- = ForceHash
- | ForceNoHash
- | PreferHash
- | PreferNoHash

Documentation

NOTE: This module is exposed to allow integration of Hpack into other tools. It is not meant for general use by end users. The following caveats apply:

The API is undocumented, consult the source instead.
The exposed types and functions primarily serve Hpack's own needs, not that of a public API. Breaking changes can happen as Hpack evolves.

As an Hpack user you either want to use the hpack executable or a build tool that supports Hpack (e.g. stack or cabal2nix).

Version

version :: Version Source #

Running Hpack

hpack :: Verbose -> Options -> IO () Source #

hpackResult :: Options -> IO Result Source #

hpackResultWithError :: Options -> IO (Either HpackError Result) Source #

printResult :: Verbose -> Result -> IO () Source #

data Result Source #

Constructors

Result
Fields resultWarnings :: [String] resultCabalFile :: String resultStatus :: Status

Instances

Instances details

Show Result Source #
Instance details Defined in Hpack Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Eq Result Source #
Instance details Defined in Hpack Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #

data Status Source #

Constructors

Generated
ExistingCabalFileWasModifiedManually
AlreadyGeneratedByNewerHpack
OutputUnchanged

Instances

Instances details

Show Status Source #
Instance details Defined in Hpack Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
Eq Status Source #
Instance details Defined in Hpack Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #

Options

defaultOptions :: Options Source #

setProgramName :: ProgramName -> Options -> Options Source #

setTarget :: FilePath -> Options -> Options Source #

setDecode :: (FilePath -> IO (Either String ([String], Value))) -> Options -> Options Source #

setFormatYamlParseError :: (FilePath -> ParseException -> String) -> Options -> Options Source #

This is used to format any ParseExceptions encountered during decoding of defaults.

Note that:

This is not used to format ParseExceptions encountered during decoding of the main package.yaml. To customize this you have to set a custom decode function.
Some of the constructors of ParseException are never produced by Hpack (e.g. AesonException as Hpack uses it's own mechanism to decode Values).

Example:

example :: IO (Either HpackError Result)
example = hpackResultWithError options
  where
    options :: Options
    options = setCustomYamlParseErrorFormat format defaultOptions

    format :: FilePath -> ParseException -> String
    format file err = file ++ ": " ++ displayException err

setCustomYamlParseErrorFormat :: (FilePath -> ParseException -> String) -> Options -> Options
setCustomYamlParseErrorFormat format = setDecode decode >>> setFormatYamlParseError format
  where
    decode :: FilePath -> IO (Either String ([String], Value))
    decode file = first (format file) <$> decodeYamlWithParseError file

getOptions :: FilePath -> [String] -> IO (Maybe (Verbose, Options)) Source #

data Verbose Source #

Constructors

Verbose
NoVerbose

Instances

Instances details

Show Verbose Source #
Instance details Defined in Hpack.Options Methods showsPrec :: Int -> Verbose -> ShowS # show :: Verbose -> String # showList :: [Verbose] -> ShowS #
Eq Verbose Source #
Instance details Defined in Hpack.Options Methods (==) :: Verbose -> Verbose -> Bool # (/=) :: Verbose -> Verbose -> Bool #

data Options Source #

Constructors

Options
Fields optionsDecodeOptions :: DecodeOptions optionsForce :: Force optionsGenerateHashStrategy :: GenerateHashStrategy optionsToStdout :: Bool

data Force Source #

Constructors

Force
NoForce

Instances

Instances details

Show Force Source #
Instance details Defined in Hpack.Options Methods showsPrec :: Int -> Force -> ShowS # show :: Force -> String # showList :: [Force] -> ShowS #
Eq Force Source #
Instance details Defined in Hpack.Options Methods (==) :: Force -> Force -> Bool # (/=) :: Force -> Force -> Bool #

data GenerateHashStrategy Source #

Constructors

ForceHash
ForceNoHash
PreferHash
PreferNoHash

Instances

Instances details

Show GenerateHashStrategy Source #
Instance details Defined in Hpack Methods showsPrec :: Int -> GenerateHashStrategy -> ShowS # show :: GenerateHashStrategy -> String # showList :: [GenerateHashStrategy] -> ShowS #
Eq GenerateHashStrategy Source #
Instance details Defined in Hpack Methods (==) :: GenerateHashStrategy -> GenerateHashStrategy -> Bool # (/=) :: GenerateHashStrategy -> GenerateHashStrategy -> Bool #