Development.Rattle

General rules for writing consistent rattle build systems:

• Never write to the same file twice. Never read then write.
• Don't delete files that have been produced. Each command should make new files, not delete old files.

Documentation

rattle :: RattleOptions -> Run a -> IO a

Given an Action to run, and a list of previous commands that got run, run it again

data Run a

Type of actions to run. Executed using rattle.

Instances

Monad Run

Defined in Development.Rattle

Methods

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

(>>) :: Run a -> Run b -> Run b

return :: a -> Run a

fail :: String -> Run a

Functor Run

Defined in Development.Rattle

Methods

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

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

Applicative Run

Defined in Development.Rattle

Methods

pure :: a -> Run a

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

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

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

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

MonadIO Run

Defined in Development.Rattle

Methods

liftIO :: IO a -> Run a

data Hazard

Type of exception thrown if there is a hazard when running the build system.

Instances

Show Hazard

Defined in Development.Rattle.Server

Methods

showsPrec :: Int -> Hazard -> ShowS

show :: Hazard -> String

showList :: [Hazard] -> ShowS

Exception Hazard

Defined in Development.Rattle.Server

Methods

toException :: Hazard -> SomeException

fromException :: SomeException -> Maybe Hazard

displayException :: Hazard -> String

data RattleOptions

Basic options for configuring rattle.

Constructors

RattleOptions

Fields

• rattleFiles :: FilePath

  Where all my shared files go

• rattleSpeculate :: Maybe String

  Should I speculate? Under which key?

• rattleShare :: Bool

  Should I share files from the cache

• rattleProcesses :: Int

  Number of simulateous processes

Instances

Show RattleOptions

Defined in Development.Rattle.Server

Methods

showsPrec :: Int -> RattleOptions -> ShowS

show :: RattleOptions -> String

showList :: [RattleOptions] -> ShowS

rattleOptions :: RattleOptions

Default RattleOptions value.

cmd :: [String] -> Run ()

Run a system command with the given arguments.

parallel :: [Run a] -> Run [a]

Run a sequence of Run actions in parallel. They will be run in parallel with no limit on simultaneous executions.

forP :: (a -> Run b) -> [a] -> Run [b]

Parallel version of forM.

liftIO :: MonadIO m => IO a -> m a

Lift a computation from the IO monad.