Headroom.Command.Init

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.

Documentation

data Env

RIO Environment for the init command.

Constructors

Env

Fields

• envLogFunc :: !LogFunc
• envInitOptions :: !CommandInitOptions
• envPaths :: !Paths

Instances

HasLogFunc Env

Defined in Headroom.Command.Init

Methods

logFuncL :: Lens' Env LogFunc

Has CommandInitOptions Env

Defined in Headroom.Command.Init

Methods

getter :: Env -> CommandInitOptions

modifier :: (CommandInitOptions -> CommandInitOptions) -> Env -> Env

hasLens :: Lens' Env CommandInitOptions

viewL :: MonadReader Env m => m CommandInitOptions

Has Paths Env

Defined in Headroom.Command.Init

Methods

getter :: Env -> Paths

modifier :: (Paths -> Paths) -> Env -> Env

hasLens :: Lens' Env Paths

viewL :: MonadReader Env m => m Paths

data Paths

Paths to various locations of file system.

Constructors

Paths

Fields

• pConfigFile :: !FilePath
• pTemplatesDir :: !FilePath

Instances

Has Paths Env

Defined in Headroom.Command.Init

Methods

getter :: Env -> Paths

modifier :: (Paths -> Paths) -> Env -> Env

hasLens :: Lens' Env Paths

viewL :: MonadReader Env m => m Paths

commandInit

Arguments

:: CommandInitOptions

init command options

-> IO ()

execution result

Handler for init command.

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

Checks whether application config file already exists.

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

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