Copyright	(c) 2019-2021 Vaclav Svejcar
License	BSD-3-Clause
Maintainer	vaclav.svejcar@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Headroom.Command.Init

Description

Module representing the init command, responsible for generating all the required files (configuration, templates) for the given project, which are then required by the run or gen commands.

Synopsis

data Env = Env {
- envLogFunc :: LogFunc
- envFileSystem :: FileSystem (RIO Env)
- envInitOptions :: CommandInitOptions
- envPaths :: Paths
}
data Paths = Paths {
- pConfigFile :: FilePath
- pTemplatesDir :: FilePath
}
commandInit :: CommandInitOptions -> IO ()
doesAppConfigExist :: (HasLogFunc env, Has (FileSystem (RIO env)) env, Has Paths env) => RIO env Bool
findSupportedFileTypes :: (Has CommandInitOptions env, HasLogFunc env) => RIO env [FileType]

Documentation

data Env Source #

RIO Environment for the init command.

Constructors

Env
Fields envLogFunc :: LogFunc envFileSystem :: FileSystem (RIO Env) envInitOptions :: CommandInitOptions envPaths :: Paths

Instances

Instances details

HasLogFunc Env Source #
Instance details Defined in Headroom.Command.Init Methods logFuncL :: Lens' Env LogFunc #
Has CommandInitOptions Env Source #
Instance details Defined in Headroom.Command.Init Methods getter :: Env -> CommandInitOptions Source # modifier :: (CommandInitOptions -> CommandInitOptions) -> Env -> Env Source # hasLens :: Lens' Env CommandInitOptions Source # viewL :: MonadReader Env m => m CommandInitOptions Source #
Has Paths Env Source #
Instance details Defined in Headroom.Command.Init Methods getter :: Env -> Paths Source # modifier :: (Paths -> Paths) -> Env -> Env Source # hasLens :: Lens' Env Paths Source # viewL :: MonadReader Env m => m Paths Source #
Has (FileSystem (RIO Env)) Env Source #
Instance details Defined in Headroom.Command.Init Methods getter :: Env -> FileSystem (RIO Env) Source # modifier :: (FileSystem (RIO Env) -> FileSystem (RIO Env)) -> Env -> Env Source # hasLens :: Lens' Env (FileSystem (RIO Env)) Source # viewL :: MonadReader Env m => m (FileSystem (RIO Env)) Source #

data Paths Source #

Paths to various locations of file system.

Constructors

Paths
Fields pConfigFile :: FilePath pTemplatesDir :: FilePath

Instances

Instances details

Has Paths Env Source #
Instance details Defined in Headroom.Command.Init Methods getter :: Env -> Paths Source # modifier :: (Paths -> Paths) -> Env -> Env Source # hasLens :: Lens' Env Paths Source # viewL :: MonadReader Env m => m Paths Source #

commandInit Source #

Arguments

:: CommandInitOptions	`init` command options
-> IO ()	execution result

Handler for init command.

doesAppConfigExist :: (HasLogFunc env, Has (FileSystem (RIO env)) env, Has Paths env) => RIO env Bool Source #

Checks whether application config file already exists.

findSupportedFileTypes :: (Has CommandInitOptions env, HasLogFunc env) => RIO env [FileType] Source #

Recursively scans provided source paths for known file types for which templates can be generated.