Headroom.AppConfig

This module adds support for loading and parsing application configuration. Such configuration can be loaded either from YAML config file, or from command line arguments. Provided Semigroup and Monoid instances allows to merge multiple loaded configurations into one.

Documentation

data AppConfig

Application configuration, loaded either from configuration file or command line options.

Constructors

AppConfig

Fields

• acRunMode :: RunMode

  selected mode of Run command

• acSourcePaths :: [FilePath]

  paths to source code files

• acTemplatePaths :: [FilePath]

  paths to template files

• acVariables :: HashMap Text Text

  variables to replace

Instances

Eq AppConfig

Defined in Headroom.AppConfig

Methods

(==) :: AppConfig -> AppConfig -> Bool

(/=) :: AppConfig -> AppConfig -> Bool

Show AppConfig

Defined in Headroom.AppConfig

Methods

showsPrec :: Int -> AppConfig -> ShowS

show :: AppConfig -> String

showList :: [AppConfig] -> ShowS

Generic AppConfig

Defined in Headroom.AppConfig

Associated Types

type Rep AppConfig :: Type -> Type

Methods

from :: AppConfig -> Rep AppConfig x

to :: Rep AppConfig x -> AppConfig

Semigroup AppConfig

Defined in Headroom.AppConfig

Methods

(<>) :: AppConfig -> AppConfig -> AppConfig

sconcat :: NonEmpty AppConfig -> AppConfig

stimes :: Integral b => b -> AppConfig -> AppConfig

Monoid AppConfig

Defined in Headroom.AppConfig

Methods

mempty :: AppConfig

mappend :: AppConfig -> AppConfig -> AppConfig

mconcat :: [AppConfig] -> AppConfig

FromJSON AppConfig

Support for reading configuration from YAML.

Defined in Headroom.AppConfig

Methods

parseJSON :: Value -> Parser AppConfig

parseJSONList :: Value -> Parser [AppConfig]

ToJSON AppConfig

Support for writing configuration to YAML.

Defined in Headroom.AppConfig

Methods

toJSON :: AppConfig -> Value

toEncoding :: AppConfig -> Encoding

toJSONList :: [AppConfig] -> Value

toEncodingList :: [AppConfig] -> Encoding

type Rep AppConfig

Defined in Headroom.AppConfig

type Rep AppConfig = D1 ('MetaData "AppConfig" "Headroom.AppConfig" "headroom-0.1.3.0-inplace" 'False) (C1 ('MetaCons "AppConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acRunMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunMode) :*: S1 ('MetaSel ('Just "acSourcePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])) :*: (S1 ('MetaSel ('Just "acTemplatePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: S1 ('MetaSel ('Just "acVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text Text)))))

loadAppConfig

Arguments

:: MonadIO m

=> FilePath

path to configuration file

-> m AppConfig

parsed configuration

Loads and parses application configuration from given file.

makePathsRelativeTo

Arguments

:: FilePath

file path to use

-> AppConfig

input application configuration

-> AppConfig

result with relativized file paths

Rewrites all file paths in AppConfig to be relative to given file path.

parseAppConfig

Arguments

:: MonadThrow m

=> ByteString

raw input to parse

-> m AppConfig

parsed application configuration

Parses application configuration from given raw input.

parseVariables

Arguments

:: MonadThrow m

=> [Text]

list of raw variables

-> m (HashMap Text Text)

parsed variables

Parses variables from raw input in key=value format.

>>> parseVariables ["key1=value1"]
fromList [("key1","value1")]

prettyPrintAppConfig

Arguments

:: AppConfig

application config to write to YAML

-> Text

pretty printed YAML text

Writes the given AppConfig to YAML text, using the pretty printer.

validateAppConfig

Arguments

:: MonadThrow m

=> AppConfig

application config to validate

-> m AppConfig

validated application config (or errors)

Validates whether given AppConfig contains valid data.