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


-- | Include the value of an environment variable at compile time
--   
--   Embed secrets (e.g. API keys) inside production artifacts at compile
--   time.
@package include-env
@version 0.5.0.0


-- | Include the value of an environment variable in the binary at compile
--   time.
--   
--   <h2>Rationale</h2>
--   
--   Users might want to embed secrets (e.g. API keys, database connection
--   strings) inside production artifacts without checking these into the
--   repository.
--   
--   <h2>Examples</h2>
--   
--   NB : all library functions require the <tt>TemplateHaskell</tt>
--   language extension.
--   
--   <h3>Include a single variable</h3>
--   
--   In this case, the name of the user's current shell) :
--   
--   <pre>
--   import IncludeEnv.TH (includeEnv)
--   
--   $(<a>includeEnv</a> "SHELL" "shl")
--   shl :: String
--   
--   main :: IO ()
--   main = putStrLn $ unwords ["your current shell :", shl]
--   </pre>
--   
--   <h3>Include a group of variables as a name-value map</h3>
--   
--   <pre>
--   import IncludeEnv.TH (includeEnvMap)
--   
--   env = $(<a>includeEnvMap</a> ["TERM", "USER"])
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; env
--   fromList [("TERM","dumb"),("USER","marco")]
--   </pre>
module IncludeEnv.TH

-- | Include the value of an environment variable at compile time.
--   
--   A fresh variable of type <a>String</a> is declared each time this is
--   computation is evaluated.
--   
--   Note : will crash with <a>error</a> if the environment variable is not
--   found.
includeEnv :: String -> String -> Q [Dec]

-- | Like <a>includeEnv</a> but only prints a warning if the environment
--   variable cannot be found.
--   
--   NB : If the lookup fails, the declared value will contain an _empty
--   string_ .
includeEnvLenient :: String -> String -> Q [Dec]

-- | Like <a>includeEnv</a> but produces a 'Maybe String'
--   
--   Use case : The program needs to be compiled against two different
--   environments that may have different sets of environment variables.
--   <a>includeEnvMaybe</a> lets you account for the results of multiple
--   such lookups at runtime.
includeEnvMaybe :: String -> Q Exp

-- | Lookup a number of environment variables and populate a <a>Map</a>
--   with the result
--   
--   NB: if a variable name cannot be found, the corresponding entry will
--   be missing
includeEnvMap :: Foldable t => t String -> Q Exp