HIE.Bios.Config

Logic and datatypes for parsing hie.yaml files.

Documentation

readConfig :: FilePath -> IO Config

Decode given file to a Config value. If the contents of the file is not a valid Config, an IOException is thrown.

newtype Config

Configuration that can be used to load a Cradle. A configuration has roughly the following form:

cradle:
  cabal:
    component: "lib:hie-bios"

Constructors

Config

Fields

• cradle :: CradleConfig

Instances

Eq Config

Defined in HIE.Bios.Config

Methods

(==) :: Config -> Config -> Bool

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

Show Config

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

FromJSON Config

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

data CradleConfig

Constructors

CradleConfig

Fields

• cradleDependencies :: [FilePath]

  Dependencies of a cradle. Dependencies are expected to be relative to the root directory. The given files are not required to exist.

• cradleType :: CradleType

  Type of the cradle to use. Actions to obtain compiler flags from are dependant on this field.

Instances

Eq CradleConfig

Defined in HIE.Bios.Config

Methods

(==) :: CradleConfig -> CradleConfig -> Bool

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

Show CradleConfig

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> CradleConfig -> ShowS

show :: CradleConfig -> String

showList :: [CradleConfig] -> ShowS

FromJSON CradleConfig

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser CradleConfig

parseJSONList :: Value -> Parser [CradleConfig]

data CradleType

Constructors

Cabal

Fields

• component :: Maybe String

CabalMulti [(FilePath, String)]

Stack

Fields

• component :: Maybe String

StackMulti [(FilePath, String)]

Bios

Fields

• prog :: FilePath

  Path to program that retrieves options to compile a file

• depsProg :: Maybe FilePath

  Optional Path to program to obtain cradle dependencies. Each cradle dependency is to be expected to be on a separate line and relative to the root dir of the cradle, not relative to the location of this program.

Direct

Fields

• arguments :: [String]

None

Multi [(FilePath, CradleConfig)]

Instances

Eq CradleType

Defined in HIE.Bios.Config

Methods

(==) :: CradleType -> CradleType -> Bool

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

Show CradleType

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> CradleType -> ShowS

show :: CradleType -> String

showList :: [CradleType] -> ShowS

FromJSON CradleType

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser CradleType

parseJSONList :: Value -> Parser [CradleType]