-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Reasonable conventions for embedding YAML configuration with Template Haskell
--   
--   Please see the README on GitHub at
--   <a>https://github.com/simspace/embed-config#readme</a>
@package embed-config
@version 0.0.0.0


-- | Provides kebab-case instances for <tt>aeson</tt>.
module Data.Yaml.Config.Kebab

-- | A DerivingVia wrapper that only turns all fields into kebab-case. No
--   other field processing occurs, which also means no field prefix
--   stripping.
newtype AesonKebab a
AesonKebab :: a -> AesonKebab a

-- | Default <a>Options</a> which sets <a>fieldLabelModifier</a> to use
--   <a>kebab</a>.
aesonKebabOptions :: Options

-- | Convert a <tt>camelCase</tt> string to <tt>kebab-case</tt>.
kebab :: String -> String

-- | Gets the given identifier name as a <a>String</a> but converts it to
--   <tt>kebab-case</tt>. Useful for
--   
--   <pre>
--   fooBar = True
--   kebabName 'fooBar == "foo-bar"
--   </pre>
kebabName :: Name -> String

-- | Gets the given identifier name as a <a>String</a>.
--   
--   If <tt>DuplicateRecordFields</tt> is enabled, detects the names in the
--   form of <tt>$sel:name:Type</tt> and extracts the <tt>name</tt>.
getName :: Name -> String
instance (GHC.Generics.Generic a, Data.Aeson.Types.Class.GToJSON Data.Aeson.Types.Generic.Zero (GHC.Generics.Rep a), Data.Aeson.Types.Class.GToEncoding Data.Aeson.Types.Generic.Zero (GHC.Generics.Rep a)) => Data.Aeson.Types.ToJSON.ToJSON (Data.Yaml.Config.Kebab.AesonKebab a)
instance (GHC.Generics.Generic a, Data.Aeson.Types.FromJSON.GFromJSON Data.Aeson.Types.Generic.Zero (GHC.Generics.Rep a)) => Data.Aeson.Types.FromJSON.FromJSON (Data.Yaml.Config.Kebab.AesonKebab a)


-- | Reasonable conventions for embedding YAML configuration with Template
--   Haskell
module Data.Yaml.Config.Embed

-- | TH function for loading <tt>config/settings.yml</tt> relative to the
--   project in which the TH splice is written.
--   
--   <pre>
--   loadConfig :: IO MyConfig
--   loadConfig = $(embedConfig)
--   </pre>
embedConfig :: Q Exp

-- | TH function for loading the supplied config file path relative to the
--   project in which the TH splice is written.
--   
--   <pre>
--   loadConfig :: IO MyConfig
--   loadConfig = $(embedConfigRelativeToProject "path/to/settings.yml")
--   </pre>
embedConfigRelativeToProject :: FilePath -> Q Exp

-- | Given the file content, read a YAML config file.
loadFromBytes :: FromJSON a => ByteString -> IO a

-- | Given the file content as an Aeson <a>Value</a>, read a YAML config
--   file.
loadFromValue :: FromJSON a => Value -> IO a

-- | A DerivingVia wrapper that only turns all fields into kebab-case. No
--   other field processing occurs, which also means no field prefix
--   stripping.
newtype AesonKebab a
AesonKebab :: a -> AesonKebab a