Lykah.Assets

Low-level module for Assets that are used to build websites.

Documentation

type Identifier = String

data Pathed c

Constructors

Pathed

Fields

• aPath :: FilePath
• aId :: Identifier
• aName :: Maybe T.Text
• aParent :: Maybe (Pathed ())
• aContent :: c

Instances

Functor Pathed

Methods

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

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

Foldable Pathed

Methods

fold :: Monoid m => Pathed m -> m

foldMap :: Monoid m => (a -> m) -> Pathed a -> m

foldr :: (a -> b -> b) -> b -> Pathed a -> b

foldr' :: (a -> b -> b) -> b -> Pathed a -> b

foldl :: (b -> a -> b) -> b -> Pathed a -> b

foldl' :: (b -> a -> b) -> b -> Pathed a -> b

foldr1 :: (a -> a -> a) -> Pathed a -> a

foldl1 :: (a -> a -> a) -> Pathed a -> a

toList :: Pathed a -> [a]

null :: Pathed a -> Bool

length :: Pathed a -> Int

elem :: Eq a => a -> Pathed a -> Bool

maximum :: Ord a => Pathed a -> a

minimum :: Ord a => Pathed a -> a

sum :: Num a => Pathed a -> a

product :: Num a => Pathed a -> a

Traversable Pathed

Methods

traverse :: Applicative f => (a -> f b) -> Pathed a -> f (Pathed b)

sequenceA :: Applicative f => Pathed (f a) -> f (Pathed a)

mapM :: Monad m => (a -> m b) -> Pathed a -> m (Pathed b)

sequence :: Monad m => Pathed (m a) -> m (Pathed a)

Show c => Show (Pathed c)

Methods

showsPrec :: Int -> Pathed c -> ShowS

show :: Pathed c -> String

showList :: [Pathed c] -> ShowS

IDO (Pathed a)

Methods

getId :: Pathed a -> Identifier

data Env a

Environment for the currently rendered Ehtml's asset

Constructors

Env

Fields

• ePaths :: M.Map Identifier (Pathed ())

  all available resources by ID

• eIDs :: M.Map FilePath Identifier

  the reverse: mapping Path to IDs (unused so far)

• eCur :: a

  the environment of the currently rendered asset

Instances

Functor Env

Methods

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

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

class IDO a where

Minimal complete definition

getId

Methods

getId :: a -> Identifier

Instances

IDO String

Methods

getId :: String -> Identifier

IDO (Pathed a)

Methods

getId :: Pathed a -> Identifier

root :: Pathed a -> Pathed ()

returns top-most parent

isRoot :: Pathed c -> Bool

lookupNamedId :: (MonadWriter [Identifier] m, MonadReader (Env a) m) => Identifier -> m (Pathed ())

reference :: (IDO a, MonadWriter [Identifier] m, MonadTrans t) => a -> t m ()

reference a Pathed value to ensure it is included in output

lookupId :: (MonadWriter [Identifier] m, MonadReader (Env a) m) => Identifier -> m (Pathed ())

data Asset

is the result of the render method from the Content class

Constructors

Copy FilePath

the asset can be generated by copying this file

CopyDir FilePath

the asset can be generated by copying this directory

Write T.Text

the asset can be generated by writing this text

WriteIO (IO T.Text)

the asset can be generated by writing the result of an IO action

Concat [Asset]

the asset can be generated by concatenating the contents described by a list of assets

Instances

Monoid Asset

Methods

mempty :: Asset

mappend :: Asset -> Asset -> Asset

mconcat :: [Asset] -> Asset

toConcatList :: Asset -> [Asset]

type Assets = [Pathed Asset]

strip :: Pathed a -> Pathed ()

uniquify :: [Pathed ()] -> Env ()

generate a map of Pathed objects with unique IDs and paths

generateAssets

Arguments

:: Bool

Debug

-> FilePath

target directory

-> Assets

-> IO ()

Generates all assets and their depending assets in the target dir (careful: removes preexisting target dir)

onlyUsed :: [Identifier] -> Assets -> Assets

Extract only these assets of a list of IDs that are actually used