BuildBox.Build

Defines the main Build monad and common utils.

Documentation

module BuildBox.Build.Testable

type Build a = ErrorT BuildError (ReaderT BuildConfig IO) a

The builder monad encapsulates and IO action that can fail with an error, and also read some global configuration info.

data BuildError

The errors we recognise.

Constructors

ErrorOther String

Some generic error

ErrorSystemCmdFailed

Some system command fell over, and it barfed out the given stdout and stderr.

Fields

buildErrorCmd :: String

buildErrorCode :: ExitCode

buildErrorStdout :: String

buildErrorStderr :: String

ErrorIOError IOError

Some other IO action failed.

forall prop . Show prop => ErrorCheckFailed Bool prop

Some property check was supposed to return the given boolean value, but it didn't.

Instances

Error BuildError

Pretty BuildError

data BuildConfig

Global builder configuration.

Constructors

BuildConfig

Fields

buildConfigLogSystem :: Maybe Handle

Log all system commands executed to this file handle.

buildConfigDefault :: BuildConfig

The default build config.

runBuild :: Build a -> IO (Either BuildError a)

Run a build command.

runBuildPrint :: Build a -> IO (Maybe a)

Run a build command, reporting whether it succeeded to the console. If it succeeded then return Just the result, else Nothing.

runBuildPrintWithConfig :: BuildConfig -> Build a -> IO (Maybe a)

Like runBuildPrintWithConfig but also takes a BuildConfig.

throw :: BuildError -> Build a

Throw an error in the build monad.

io :: IO a -> Build a

Lift an IO action into the build monad. If the action throws any exceptions they get caught and turned into ErrorIOError exceptions in our Build monad.

logSystem :: String -> Build ()

Log a system command to the handle in our BuildConfig, if any.

out :: Pretty a => a -> Build ()

Print some text to stdout.

outLn :: Pretty a => a -> Build ()

Print some text to stdout followed by a newline.

outBlank :: Build ()

Print a blank line to stdout

outLine :: Build ()

Print a ----- line to stdout

outLINE :: Build ()

Print a ===== line to stdout

whenM :: Monad m => m Bool -> m () -> m ()

Like when, but with teh monadz.