herringbone-0.0.2: Web/Herringbone.hs

{- |
wai-herringbone is a Haskell/Wai library for compiling and serving web assets.
It aims to make it dead simple to create a 'Network.Wai.Middleware' or
'Network.Wai.Application' which deals with all of your static assets, including
preprocessing for languages like Fay, CoffeeScript, Sass, and LESS.

It takes most of its inspiration from the Ruby library,
<https://github.com/sstephenson/sprockets Sprockets>, hence the name.

Example:

> import Web.Herringbone
>
> fay, sass :: PP
>
> hb = Herringbone
> hb = herringbone
>     ( addSourceDir "assets"
>     . setDestDir   "compiled_assets"
>     . addPreprocessors [fay, sass]
>     )
>
> -- You can now access assets programmatically
> asset <- findAsset hb (makeLogicalPath ["application.js"])
>
> -- Or make a WAI Application to do it for you
> app = toApplication hb
-}
module Web.Herringbone (
    -- * Creating a Herringbone
    Herringbone(..),
    module Web.Herringbone.Configuration,
    -- * Assets
    LogicalPath,
    fromLogicalPath,
    toFilePath,
    Asset(..),
    findAsset,
    -- * Preprocessors
    PP(..),
    PPs,
    AssetError(..),
    CompileError,
    -- * WAI
    toApplication
) where

import Web.Herringbone.Configuration
import Web.Herringbone.Types
import Web.Herringbone.FindAsset
import Web.Herringbone.Adapter.Wai