HIE.Bios.Config

Logic and datatypes for parsing hie.yaml files.

Documentation

readConfig :: FromJSON a => FilePath -> IO (Config a)

Decode given file to a 'Config a' value. Type variable a can be used to extend the 'hie.yaml' file format to extend configuration in the user-library. If the contents of the file is not a valid 'Config a', an IOException is thrown.

newtype Config a

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 a

Instances

Functor Config

Defined in HIE.Bios.Config

Methods

fmap :: (a -> b) -> Config a -> Config b

(<$) :: a -> Config b -> Config a

Eq a => Eq (Config a)

Defined in HIE.Bios.Config

Methods

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

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

Show (Config a)

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> Config a -> ShowS

show :: Config a -> String

showList :: [Config a] -> ShowS

FromJSON a => FromJSON (Config a)

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser (Config a)

parseJSONList :: Value -> Parser [Config a]

data CradleConfig a

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 a

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

Instances

Functor CradleConfig

Defined in HIE.Bios.Config

Methods

fmap :: (a -> b) -> CradleConfig a -> CradleConfig b

(<$) :: a -> CradleConfig b -> CradleConfig a

Eq a => Eq (CradleConfig a)

Defined in HIE.Bios.Config

Methods

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

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

Show (CradleConfig a)

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> CradleConfig a -> ShowS

show :: CradleConfig a -> String

showList :: [CradleConfig a] -> ShowS

FromJSON a => FromJSON (CradleConfig a)

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser (CradleConfig a)

parseJSONList :: Value -> Parser [CradleConfig a]

data CradleType a

Constructors

Cabal

Fields

• component :: Maybe String

CabalMulti [(FilePath, String)]

Stack

Fields

• component :: Maybe String

StackMulti [(FilePath, String)]

Bios

Fields

• call :: Callable

  Path to program or shell command that retrieves options to compile a file

• depsCall :: Maybe Callable

  Optional path to program or shell command 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.

• ghcPath :: Maybe FilePath

  Optional path to the ghc binary

Direct

Fields

• arguments :: [String]

None

Multi [(FilePath, CradleConfig a)]

Other

Fields

• otherConfig :: a
• originalYamlValue :: Value

Instances

Functor CradleType

Defined in HIE.Bios.Config

Methods

fmap :: (a -> b) -> CradleType a -> CradleType b

(<$) :: a -> CradleType b -> CradleType a

Eq a => Eq (CradleType a)

Defined in HIE.Bios.Config

Methods

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

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

Show (CradleType a)

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> CradleType a -> ShowS

show :: CradleType a -> String

showList :: [CradleType a] -> ShowS

FromJSON a => FromJSON (CradleType a)

Defined in HIE.Bios.Config

Methods

parseJSON :: Value -> Parser (CradleType a)

parseJSONList :: Value -> Parser [CradleType a]

data Callable

Constructors

Program FilePath

Command String

Instances

Eq Callable

Defined in HIE.Bios.Config

Methods

(==) :: Callable -> Callable -> Bool

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

Show Callable

Defined in HIE.Bios.Config

Methods

showsPrec :: Int -> Callable -> ShowS

show :: Callable -> String

showList :: [Callable] -> ShowS