Language.PureScript.Make

Make API

data RebuildPolicy

Determines when to rebuild a module

Constructors

RebuildNever

Never rebuild this module

RebuildAlways

Always rebuild this module

Instances

Eq RebuildPolicy

Methods

(==) :: RebuildPolicy -> RebuildPolicy -> Bool

(/=) :: RebuildPolicy -> RebuildPolicy -> Bool

Ord RebuildPolicy

Methods

compare :: RebuildPolicy -> RebuildPolicy -> Ordering

(<) :: RebuildPolicy -> RebuildPolicy -> Bool

(<=) :: RebuildPolicy -> RebuildPolicy -> Bool

(>) :: RebuildPolicy -> RebuildPolicy -> Bool

(>=) :: RebuildPolicy -> RebuildPolicy -> Bool

max :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy

min :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy

Show RebuildPolicy

Methods

showsPrec :: Int -> RebuildPolicy -> ShowS

show :: RebuildPolicy -> String

showList :: [RebuildPolicy] -> ShowS

data ProgressMessage

Progress messages from the make process

Constructors

CompilingModule ModuleName

Compilation started for the specified module

Instances

Eq ProgressMessage

Methods

(==) :: ProgressMessage -> ProgressMessage -> Bool

(/=) :: ProgressMessage -> ProgressMessage -> Bool

Ord ProgressMessage

Methods

compare :: ProgressMessage -> ProgressMessage -> Ordering

(<) :: ProgressMessage -> ProgressMessage -> Bool

(<=) :: ProgressMessage -> ProgressMessage -> Bool

(>) :: ProgressMessage -> ProgressMessage -> Bool

(>=) :: ProgressMessage -> ProgressMessage -> Bool

max :: ProgressMessage -> ProgressMessage -> ProgressMessage

min :: ProgressMessage -> ProgressMessage -> ProgressMessage

Show ProgressMessage

Methods

showsPrec :: Int -> ProgressMessage -> ShowS

show :: ProgressMessage -> String

showList :: [ProgressMessage] -> ShowS

renderProgressMessage :: ProgressMessage -> String

Render a progress message

data MakeActions m

Actions that require implementations when running in "make" mode.

This type exists to make two things abstract:

• The particular backend being used (JavaScript, C++11, etc.)
• The details of how files are read/written etc.

Constructors

MakeActions

Fields

• getInputTimestamp :: ModuleName -> m (Either RebuildPolicy (Maybe UTCTime))

  Get the timestamp for the input file(s) for a module. If there are multiple files (.purs and foreign files, for example) the timestamp should be for the most recently modified file.

• getOutputTimestamp :: ModuleName -> m (Maybe UTCTime)

  Get the timestamp for the output files for a module. This should be the timestamp for the oldest modified file, or Nothing if any of the required output files are missing.

• readExterns :: ModuleName -> m (FilePath, Externs)

  Read the externs file for a module as a string and also return the actual path for the file.

• codegen :: Module Ann -> Environment -> Externs -> SupplyT m ()

  Run the code generator for the module and write any required output files.

• progress :: ProgressMessage -> m ()

  Respond to a progress update.

type Externs = ByteString

Generated code for an externs file.

rebuildModule :: forall m. (Monad m, MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [ExternsFile] -> Module -> m ExternsFile

Rebuild a single module.

This function is used for fast-rebuild workflows (PSCi and psc-ide are examples).

make :: forall m. (Monad m, MonadBaseControl IO m, MonadError MultipleErrors m, MonadWriter MultipleErrors m) => MakeActions m -> [Module] -> m [ExternsFile]

Compiles in "make" mode, compiling each module separately to a .js file and an externs.json file.

If timestamps have not changed, the externs file can be used to provide the module's types without having to typecheck the module again.

Implementation of Make API using files on disk

newtype Make a

A monad for running make actions

Constructors

Make

Fields

• unMake :: ReaderT Options (ExceptT MultipleErrors (Logger MultipleErrors)) a

Instances

Monad Make

Methods

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

(>>) :: Make a -> Make b -> Make b

return :: a -> Make a

fail :: String -> Make a

Functor Make

Methods

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

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

Applicative Make

Methods

pure :: a -> Make a

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

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

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

MonadIO Make

Methods

liftIO :: IO a -> Make a

MonadReader Options Make

Methods

ask :: Make Options

local :: (Options -> Options) -> Make a -> Make a

reader :: (Options -> a) -> Make a

MonadError MultipleErrors Make

Methods

throwError :: MultipleErrors -> Make a

catchError :: Make a -> (MultipleErrors -> Make a) -> Make a

MonadBaseControl IO Make

Associated Types

type StM (Make :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase Make IO -> IO a) -> Make a

restoreM :: StM Make a -> Make a

MonadWriter MultipleErrors Make

Methods

writer :: (a, MultipleErrors) -> Make a

tell :: MultipleErrors -> Make ()

listen :: Make a -> Make (a, MultipleErrors)

pass :: Make (a, MultipleErrors -> MultipleErrors) -> Make a

MonadBase IO Make

Methods

liftBase :: IO α -> Make α

type StM Make a

type StM Make a = Either MultipleErrors a

runMake :: Options -> Make a -> IO (Either MultipleErrors a, MultipleErrors)

Execute a Make monad, returning either errors, or the result of the compile plus any warnings.

makeIO :: (IOError -> ErrorMessage) -> IO a -> Make a

Run an IO action in the Make monad, by specifying how IO errors should be rendered as ErrorMessage values.

readTextFile :: FilePath -> Make ByteString

Read a text file in the Make monad, capturing any errors using the MonadError instance.

buildMakeActions

Arguments

:: FilePath

the output directory

-> Map ModuleName (Either RebuildPolicy FilePath)

a map between module names and paths to the file containing the PureScript module

-> Map ModuleName FilePath

a map between module name and the file containing the foreign javascript for the module

-> Bool

Generate a prefix comment?

-> MakeActions Make

A set of make actions that read and write modules from the given directory.

inferForeignModules :: forall m. MonadIO m => Map ModuleName (Either RebuildPolicy FilePath) -> m (Map ModuleName FilePath)

Infer the module name for a module by looking for the same filename with a .js extension.