Safe Haskell	None
Language	Haskell2010

Hinit.Template

Synopsis

data Template
- = Local {
  - path :: Path Abs Dir
  - name :: Text
  - templateConfig :: TemplateConfig
  }
- | Broken {
  - path :: Path Abs Dir
  - name :: Text
  - errors :: [TomlDecodeError]
  }
fromContext :: Context -> Value
underCurrentDir :: Path Rel a -> Bool
copyFileFromTemplate :: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, ToMustache ctx) => ctx -> Path a Dir -> Path b Dir -> Path Rel File -> m ()
copyDirFromTemplate :: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, ToMustache ctx) => ctx -> Path a Dir -> Path b Dir -> Path Rel Dir -> m ()
initFromTemplate :: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, MonadIO m, ToMustache ctx) => [Pattern] -> ctx -> Path a Dir -> Path b Dir -> m ()
readTemplate :: Has (Lift IO) sig m => Path Abs Dir -> m (Maybe Template)
getTemplateDirs :: Has (Lift IO) sig m => m [Path Abs Dir]
getTemplate :: (Has (Lift IO) sig m, Has (Throw IllformedPath) sig m) => Text -> m (Maybe Template)
getTemplates :: Has (Lift IO) sig m => m [Template]
prettyTemplate :: Bool -> Template -> Doc a
prettyTemplates :: Bool -> [Template] -> Doc a

Documentation

data Template Source #

Constructors

Local
Fields path :: Path Abs Dir name :: Text templateConfig :: TemplateConfig
Broken
Fields path :: Path Abs Dir name :: Text errors :: [TomlDecodeError]

Instances

Instances details

Eq Template Source #
Instance details Defined in Hinit.Template Methods (==) :: Template -> Template -> Bool # (/=) :: Template -> Template -> Bool #
Show Template Source #
Instance details Defined in Hinit.Template Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #
Generic Template Source #
Instance details Defined in Hinit.Template Associated Types type Rep Template :: Type -> Type # Methods from :: Template -> Rep Template x # to :: Rep Template x -> Template #
type Rep Template Source #
Instance details Defined in Hinit.Template type Rep Template = D1 ('MetaData "Template" "Hinit.Template" "hinit-0.2.2-inplace" 'False) (C1 ('MetaCons "Local" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "templateConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TemplateConfig))) :+: C1 ('MetaCons "Broken" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TomlDecodeError]))))

fromContext :: Context -> Value Source #

underCurrentDir :: Path Rel a -> Bool Source #

copyFileFromTemplate Source #

Arguments

:: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, ToMustache ctx)
=> ctx	Mustache context
-> Path a Dir	Base dir of the template
-> Path b Dir	Base dir of the target
-> Path Rel File	Source file path relative to the template base
-> m ()

Copy a file from template to the corresponding location in the target directory and apply substitution. Note that this function assumes that the parent directory of the target file exists.

copyDirFromTemplate Source #

Arguments

:: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, ToMustache ctx)
=> ctx	Mustache context
-> Path a Dir	Base dir of the template
-> Path b Dir	Base dir of the target
-> Path Rel Dir	Source dir path relative to the template base
-> m ()

Copy a directory from template to the corresponding location in the target directory and apply substitution. Note that this function assumes that the parent directory of the target directory exists.

initFromTemplate Source #

Arguments

:: (Has (Throw MustacheError) sig m, Has (Throw IllformedPath) sig m, Has (Lift IO) sig m, MonadIO m, ToMustache ctx)
=> [Pattern]	Ignored files
-> ctx	Mustache context
-> Path a Dir	Base dir of the template
-> Path b Dir	Base dir of the target
-> m ()

Initialize a project from a template

readTemplate :: Has (Lift IO) sig m => Path Abs Dir -> m (Maybe Template) Source #

getTemplateDirs :: Has (Lift IO) sig m => m [Path Abs Dir] Source #

getTemplate :: (Has (Lift IO) sig m, Has (Throw IllformedPath) sig m) => Text -> m (Maybe Template) Source #

getTemplates :: Has (Lift IO) sig m => m [Template] Source #

prettyTemplate :: Bool -> Template -> Doc a Source #

prettyTemplates :: Bool -> [Template] -> Doc a Source #