BuildEnv.Script

This modules provides a tiny build script DSL.

A BuildScript is a series of simple build steps (process calls).

A BuildScript can be executed in the IO monad, using executeBuildScript.

A BuildScript can be turned into a shell script which can be executed later, using script.

Interpreting build scripts

Executing build scripts

executeBuildScript

Arguments

:: SymbolicPath CWD (Dir Project)

Working directory.

-> Maybe Counter

Optional counter to use to report progress.

-> BuildScript

The build script to execute.

-> IO ()

Execute a BuildScript in the IO monad.

Shell-script output

script :: ScriptConfig -> BuildScript -> Text

Obtain the textual contents of a build script.

Build scripts

type BuildScript = BuildScriptM ()

A build script: a list of build steps, given a ScriptConfig context.

newtype BuildScriptM a

Build script monad.

Constructors

BuildScript

Fields

• runBuildScript :: ReaderT ScriptConfig (Writer BuildSteps) a

Instances

Applicative BuildScriptM

Defined in BuildEnv.Script

Methods

pure :: a -> BuildScriptM a

(<*>) :: BuildScriptM (a -> b) -> BuildScriptM a -> BuildScriptM b

liftA2 :: (a -> b -> c) -> BuildScriptM a -> BuildScriptM b -> BuildScriptM c

(*>) :: BuildScriptM a -> BuildScriptM b -> BuildScriptM b

(<*) :: BuildScriptM a -> BuildScriptM b -> BuildScriptM a

Functor BuildScriptM

Defined in BuildEnv.Script

Methods

fmap :: (a -> b) -> BuildScriptM a -> BuildScriptM b

(<$) :: a -> BuildScriptM b -> BuildScriptM a

Monad BuildScriptM

Defined in BuildEnv.Script

Methods

(>>=) :: BuildScriptM a -> (a -> BuildScriptM b) -> BuildScriptM b

(>>) :: BuildScriptM a -> BuildScriptM b -> BuildScriptM b

return :: a -> BuildScriptM a

Monoid BuildScript

Defined in BuildEnv.Script

Methods

mempty :: BuildScript

mappend :: BuildScript -> BuildScript -> BuildScript

mconcat :: [BuildScript] -> BuildScript

Semigroup BuildScript

Defined in BuildEnv.Script

Methods

(<>) :: BuildScript -> BuildScript -> BuildScript

sconcat :: NonEmpty BuildScript -> BuildScript

stimes :: Integral b => b -> BuildScript -> BuildScript

emptyBuildScript :: BuildScript

The empty build script: no build steps.

askScriptConfig :: BuildScriptM ScriptConfig

Retrieve the ScriptConfig from the ReaderT environment.

buildSteps :: ScriptConfig -> BuildScript -> BuildSteps

Obtain the build steps of a BuildScript.

Individual build steps

data BuildStep

A build step.

Constructors

forall dir. CallProcess (CallProcess dir)

Call a processs with the given arguments.

forall dir. CreateDir (AbsolutePath (Dir dir))

Create the given directory.

LogMessage String

Log a message to stdout.

ReportProgress

Report one unit of progress.

Fields

• outputProgress :: Bool

  Whether to log the progress to stdout.

type BuildSteps = [BuildStep]

A list of build steps.

step :: BuildStep -> BuildScript

Declare a build step.

callProcess :: CallProcess dir -> BuildScript

Call a process with given arguments.

createDir :: AbsolutePath (Dir dir) -> BuildScript

Create the given directory.

logMessage :: Verbosity -> Verbosity -> String -> BuildScript

Log a message.

reportProgress :: Verbosity -> BuildScript

Report one unit of progress.

Configuring build scripts

data ScriptOutput

How to interpret the build script: run it in IO, or turn it into a shell script?

Constructors

Run

Run the build script in IO

Shell

Generate a shell script.

Fields

• useVariables :: !Bool

  Replace various values with variables, so that they can be set before running the build script.

  Values:

  • GHC and GHC-PKG,
  • fetched sources directory SOURCES,
  • PREFIX and DESTDIR.

data ScriptConfig

Configuration options for a BuildScript.

Constructors

ScriptConfig

Fields

• scriptOutput :: !ScriptOutput

  Whether we are outputting a shell script, so that we can know whether we should:

  • add quotes around command-line arguments?
  • add ./ to run an executable in the current working directory?
• scriptWorkingDir :: !(SymbolicPath CWD (Dir Project))

  Working directory for the script.

• scriptStyle :: !Style

  Whether to use Posix or Windows style conventions. See Style.

• scriptTotal :: !(Maybe Word)

  Optional: the total number of units we are building; used to report progress.

hostRunCfg

Arguments

:: SymbolicPath CWD (Dir Project)

-> Maybe Word

Optional: total to report progress against.

-> ScriptConfig

Configure a script to run on the host (in IO).

data EscapeVars

Whether to expand or escape variables in a shell script.

Constructors

ExpandVars

Allow the shell to expand variables.

EscapeVars

Escape variables so that the shell doesn't expand them.

Instances

Show EscapeVars

Defined in BuildEnv.Script

Methods

showsPrec :: Int -> EscapeVars -> ShowS

show :: EscapeVars -> String

showList :: [EscapeVars] -> ShowS

quoteArg :: (IsString r, Monoid r) => EscapeVars -> ScriptConfig -> String -> r

Quote a command-line argument, if the ScriptConfig requires arguments to be quoted.

No need to call this on the cwd or prog fields of BuildStep, as these will be quoted by the shell-script backend no matter what.