directory-layout-0.2.0.0: Declare, construct and verify directory layout

Safe HaskellNone

System.Directory.Layout

Contents

Synopsis

Layout declaration

data DL f Source

Abstract data type representing directory tree is nice

Instances

Monad DL 
Functor DL 
Read f => Read (DL f) 
Show f => Show (DL f) 
Arbitrary a => Arbitrary (DL a) 

type Layout = DL ()Source

But type synonym is nicer

file :: FilePath -> Text -> LayoutSource

Declare file with specified contents

file_ :: FilePath -> LayoutSource

Declare empty file

directory :: FilePath -> Layout -> LayoutSource

Declare directory with specified listing

directory_ :: FilePath -> LayoutSource

Declare empty directory

Layout construction

data DLMakeWarning Source

Data type representing various warnings that may occur while infecting directory layout

makeSource

Arguments

:: Layout 
-> FilePath

Root directory

-> IO [DLMakeWarning]

List of warnings

Infect file layout with stuff from script

Layout verification

data DLCheckFailure Source

Data type representing various failures that may occur while checking directory layout

checkSource

Arguments

:: Layout 
-> FilePath

Root directory

-> IO [DLCheckFailure]

List of failures

Check directory layout corresponds to specified one

Layout parsers

layout :: Text -> Either String LayoutSource

lazy Text parser

layout' :: Text -> Either String LayoutSource

strict Text parser