Safe Haskell	None
Language	Haskell2010

HIE.Bios.Config

Description

Logic and datatypes for parsing hie.yaml files.

Synopsis

readConfig :: FromJSON a => FilePath -> IO (Config a)
newtype Config a = Config {
- cradle :: CradleConfig a
}
data CradleConfig a = CradleConfig {
- cradleDependencies :: [FilePath]
- cradleType :: CradleType a
}
data CabalType
pattern CabalType :: Maybe String -> CabalType
cabalComponent :: CabalType -> Maybe String
data StackType
pattern StackType :: Maybe String -> Maybe String -> StackType
stackComponent :: StackType -> Maybe String
stackYaml :: StackType -> Maybe String
data CradleType a
- = Cabal {
  - cabalType :: !CabalType
  }
- | CabalMulti {
  - defaultCabal :: !CabalType
  - subCabalComponents :: [(FilePath, CabalType)]
  }
- | Stack {
  - stackType :: !StackType
  }
- | StackMulti {
  - defaultStack :: !StackType
  - subStackComponents :: [(FilePath, StackType)]
  }
- | Bios {
  - call :: Callable
  - depsCall :: Maybe Callable
  - ghcPath :: Maybe FilePath
  }
- | Direct {
  - arguments :: [String]
  }
- | None
- | Multi [(FilePath, CradleConfig a)]
- | Other {
  - otherConfig :: a
  - originalYamlValue :: Value
  }
data Callable
- = Program FilePath
- | Command String

Documentation

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

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 Source #

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

Instances details

Functor Config Source #
Instance details Defined in HIE.Bios.Config Methods fmap :: (a -> b) -> Config a -> Config b # (<$) :: a -> Config b -> Config a #
Eq a => Eq (Config a) Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: Config a -> Config a -> Bool # (/=) :: Config a -> Config a -> Bool #
Show (Config a) Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> Config a -> ShowS # show :: Config a -> String # showList :: [Config a] -> ShowS #
FromJSON a => FromJSON (Config a) Source #
Instance details Defined in HIE.Bios.Config Methods parseJSON :: Value -> Parser (Config a) parseJSONList :: Value -> Parser [Config a]

data CradleConfig a Source #

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

Instances details

Functor CradleConfig Source #
Instance details Defined in HIE.Bios.Config Methods fmap :: (a -> b) -> CradleConfig a -> CradleConfig b # (<$) :: a -> CradleConfig b -> CradleConfig a #
Eq a => Eq (CradleConfig a) Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: CradleConfig a -> CradleConfig a -> Bool # (/=) :: CradleConfig a -> CradleConfig a -> Bool #
Show (CradleConfig a) Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> CradleConfig a -> ShowS # show :: CradleConfig a -> String # showList :: [CradleConfig a] -> ShowS #
FromJSON a => FromJSON (CradleConfig a) Source #
Instance details Defined in HIE.Bios.Config Methods parseJSON :: Value -> Parser (CradleConfig a) parseJSONList :: Value -> Parser [CradleConfig a]

data CabalType Source #

Instances

Instances details

Eq CabalType Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: CabalType -> CabalType -> Bool # (/=) :: CabalType -> CabalType -> Bool #
Show CabalType Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> CabalType -> ShowS # show :: CabalType -> String # showList :: [CabalType] -> ShowS #
Semigroup CabalType Source #
Instance details Defined in HIE.Bios.Config Methods (<>) :: CabalType -> CabalType -> CabalType # sconcat :: NonEmpty CabalType -> CabalType # stimes :: Integral b => b -> CabalType -> CabalType #
Monoid CabalType Source #
Instance details Defined in HIE.Bios.Config Methods mempty :: CabalType # mappend :: CabalType -> CabalType -> CabalType # mconcat :: [CabalType] -> CabalType #

pattern CabalType :: Maybe String -> CabalType Source #

cabalComponent :: CabalType -> Maybe String Source #

data StackType Source #

Instances

Instances details

Eq StackType Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: StackType -> StackType -> Bool # (/=) :: StackType -> StackType -> Bool #
Show StackType Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> StackType -> ShowS # show :: StackType -> String # showList :: [StackType] -> ShowS #
Semigroup StackType Source #
Instance details Defined in HIE.Bios.Config Methods (<>) :: StackType -> StackType -> StackType # sconcat :: NonEmpty StackType -> StackType # stimes :: Integral b => b -> StackType -> StackType #
Monoid StackType Source #
Instance details Defined in HIE.Bios.Config Methods mempty :: StackType # mappend :: StackType -> StackType -> StackType # mconcat :: [StackType] -> StackType #

pattern StackType :: Maybe String -> Maybe String -> StackType Source #

stackComponent :: StackType -> Maybe String Source #

stackYaml :: StackType -> Maybe String Source #

data CradleType a Source #

Constructors

Cabal
Fields cabalType :: !CabalType
CabalMulti
Fields defaultCabal :: !CabalType subCabalComponents :: [(FilePath, CabalType)]
Stack
Fields stackType :: !StackType
StackMulti
Fields defaultStack :: !StackType subStackComponents :: [(FilePath, StackType)]
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

Instances details

Functor CradleType Source #
Instance details Defined in HIE.Bios.Config Methods fmap :: (a -> b) -> CradleType a -> CradleType b # (<$) :: a -> CradleType b -> CradleType a #
Eq a => Eq (CradleType a) Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: CradleType a -> CradleType a -> Bool # (/=) :: CradleType a -> CradleType a -> Bool #
Show (CradleType a) Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> CradleType a -> ShowS # show :: CradleType a -> String # showList :: [CradleType a] -> ShowS #
FromJSON a => FromJSON (CradleType a) Source #
Instance details Defined in HIE.Bios.Config Methods parseJSON :: Value -> Parser (CradleType a) parseJSONList :: Value -> Parser [CradleType a]

data Callable Source #

Constructors

Program FilePath
Command String

Instances

Instances details

Eq Callable Source #
Instance details Defined in HIE.Bios.Config Methods (==) :: Callable -> Callable -> Bool # (/=) :: Callable -> Callable -> Bool #
Show Callable Source #
Instance details Defined in HIE.Bios.Config Methods showsPrec :: Int -> Callable -> ShowS # show :: Callable -> String # showList :: [Callable] -> ShowS #