Safe Haskell	None

Web.Herringbone

Contents

Creating a Herringbone
Assets
Preprocessors
WAI

Description

herringbone is a Haskell library for compiling and serving web assets. It aims to make it dead simple to create a Middleware or 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, 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 (fromJust . makeLogicalPath $ ["application.js"])

 -- Or serve them with a Wai application
 app = toApplication hb

Synopsis

Creating a Herringbone

data Herringbone Source

The 'main' datatype in this library. Just a container for the configuration. All of the important functions will take a Herringbone as their first argument.

Constructors

Herringbone
Fields hbSourceDirs :: [FilePath] A list of source directories; this is where assets should be placed. hbDestDir :: FilePath Where to copy assets to after they've been compiled. hbPPs :: PPs Preprocessors

Instances

Eq Herringbone
Show Herringbone

herringbone :: ConfigBuilder -> Herringbone Source

Preferred way of creating Herringbone instances.

type ConfigBuilder = Herringbone -> Herringbone Source

addSourceDir :: FilePath -> ConfigBuilder Source

Adds a directory to the list of source directories.

setDestDir :: FilePath -> ConfigBuilder Source

Sets the destination directory. Note that this will overwrite the destination directory if one is already set.

addPreprocessors :: [PP] -> ConfigBuilder Source

Add the preprocessors in the list to the preprocessor collection.

defaultHerringbone :: Herringbone Source

Assets

data LogicalPath Source

All assets in Herringbone are referenced by their logical path. This is the path to an asset, relative to any of the source directories.

Instances

Eq LogicalPath
Show LogicalPath

fromLogicalPath :: LogicalPath -> [Text]Source

toFilePath :: LogicalPath -> FilePath Source

data Asset Source

A preprocessed asset. Any function that returns this will already have done the preprocessing (if necessary).

Constructors

Asset

Fields

assetSize :: Integer: Size of the asset in bytes.
assetSourcePath :: FilePath: Path to the asset's source file on disk.
assetFilePath :: FilePath: Path to the preprocessed asset on disk. Note that assets which do not require preprocessing will still be copied to the destination directory.
assetLogicalPath :: LogicalPath: The logical path referencing this asset.
assetModifiedTime :: UTCTime: Modification time of the asset's source file.

Instances

Show Asset

findAsset :: Herringbone -> LogicalPath -> IO (Either AssetError Asset)Source

Preprocessors

data PP Source

A preprocessor something which is run on the asset before it is served. Preprocessors are run when a file extension matches the preprocessor extension. For example, if you have a preprocessor for "coffee" files, you request "application.js", and there is a file named "application.js.coffee", Herringbone will run the coffee preprocessor on that file and serve you the result.

You can add more preprocessors by adding more file extensions; "application.js.coffee.erb" will be preprocessed first by "erb", then by "coffee" (assuming you have registered preprocessors for those files).

Constructors

PP
Fields ppExtension :: Text The file extension this preprocessor acts upon, eg "sass" or "hamlet" ppAction :: ByteString -> PPM (Either CompileError ByteString) Perform the preprocessing.

Instances

Eq PP	Beware: This instance is only here for testing. It only looks at the extensions to decide whether two `PP`s are equal. Don't use this!
Ord PP
Show PP

data PPs Source

A collection of preprocessors.

Instances

Eq PPs
Show PPs

data AssetError Source

Constructors

AssetNotFound
AssetCompileError CompileError
AmbiguousSources [FilePath]

Instances

Eq AssetError
Show AssetError

type CompileError = ByteString Source

A string which should contain information about why an asset failed to compile.

WAI

toApplication :: Herringbone -> Application Source

Convert a Herringbone to a WAI Application.