Development.Shake

Main module for defining Shake build systems. You may also want to include Development.Shake.FilePath.

Documentation

shake :: ShakeOptions -> Rules () -> IO ()

Main entry point for running Shake build systems.

Core of Shake

data ShakeOptions

Options to specify how to control shake.

Constructors

ShakeOptions

Fields

shakeFiles :: FilePath

Where shall I store the database and journal files (defaults to .)

shakeParallel :: Int

What is the maximum number of rules I should run in parallel (defaults to 1)

shakeVersion :: Int

What is the version of your build system, increment to force everyone to rebuild

shakeVerbosity :: Int

1 = normal, 0 = quiet, 2 = loud

shakeOptions :: ShakeOptions

A default set of ShakeOptions.

run :: ShakeOptions -> Rules () -> IO ()

This function is not actually exported, but Haddock is buggy. Please ignore.

class (Show key, Typeable key, Eq key, Hashable key, Binary key, Show value, Typeable value, Eq value, Hashable value, Binary value) => Rule key value | key -> value where

Define a pair of types that can be used as a Shake rule.

Methods

validStored :: key -> value -> IO Bool

Given that the database contains key/value, does that still match the on-disk contents? Return True if no work needs to be done.

Instances

Rule File FileTime

Rule GetDir GetDir_

Rule Exist Bool

data Rules a

Define a set of rules. Rules can be created with calls to 'rule'/'action'. Rules are combined with either the Monoid instance, or more commonly using the Monad instance and do notation.

Instances

Monad Rules

Functor Rules

Monoid a => Monoid (Rules a)

defaultRule :: Rule key value => (key -> Maybe (Action value)) -> Rules ()

Like rule, but lower priority, if no rule exists then defaultRule is checked.

rule :: Rule key value => (key -> Maybe (Action value)) -> Rules ()

Add a rule to build a key, returning an appropriate Action. All rules must be disjoint. To define lower priority rules use defaultRule.

action :: Action a -> Rules ()

Run an action, usually used for specifying top-level requirements.

data Action a

The Action monad, use liftIO to raise IO actions into it, and need to execute files. Action values are used by rule and action.

Instances

Monad Action

Functor Action

MonadIO Action

apply :: Rule key value => [key] -> Action [value]

Execute a rule, returning the associated values. If possible, the rules will be run in parallel. This function requires that appropriate rules have been added with 'rule'/'defaultRule'.

apply1 :: Rule key value => key -> Action value

Apply a single rule, equivalent to calling apply with a singleton list. Where possible, use apply to allow the potential for parallelism.

traced :: String -> IO a -> Action a

Write an action to the trace list, along with the start/end time of running the IO action. The system' command automatically calls traced.

currentRule :: Action (Maybe Key)

Get the Key for the currently executing rule - usally used to improve error messages. Returns Nothing if being run by action.

putLoud, putQuiet, putNormal :: String -> Action ()

Write a message to the output when the verbosity is appropriate. The output will not be interleaved with any other Shake messages (other than those generated by system commands).

Utility functions

system' :: [String] -> Action ()

copyFile' :: FilePath -> FilePath -> Action ()

readFile' :: FilePath -> Action String

writeFile' :: FilePath -> String -> Action ()

readFileLines :: FilePath -> Action [String]

writeFileLines :: FilePath -> [String] -> Action ()

File rules

type FilePattern = String

need :: [FilePath] -> Action ()

want :: [FilePath] -> Rules ()

defaultRuleFile :: Rules ()

This function is not actually exported, but Haddock is buggy. Please ignore.

(?==) :: FilePattern -> FilePath -> Bool

(?>) :: (FilePath -> Bool) -> (FilePath -> Action ()) -> Rules ()

(**>) :: [FilePattern] -> (FilePath -> Action ()) -> Rules ()

(*>) :: FilePattern -> (FilePath -> Action ()) -> Rules ()

Directory rules

doesFileExist :: FilePath -> Action Bool

getDirectoryContents :: FilePath -> Action [FilePath]

getDirectoryFiles :: FilePath -> FilePattern -> Action [FilePath]

getDirectoryDirs :: FilePath -> Action [FilePath]

defaultRuleDirectory :: Rules ()

This function is not actually exported, but Haddock is buggy. Please ignore.