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


-- | Loads environment variables from dotenv files
--   
--   In most applications, <a>configuration should be separated from
--   code</a>. While it usually works well to keep configuration in the
--   environment, there are cases where you may want to store configuration
--   in a file outside of version control.
--   
--   <a>Dotenv</a> files have become popular for storing configuration,
--   especially in development and test environments. In <a>Ruby</a>,
--   <a>Python</a> and <a>Javascript</a> there are libraries to facilitate
--   loading of configuration options from configuration files. This
--   library loads configuration to environment variables for programs
--   written in Haskell.
--   
--   To use, call <a>loadFile</a> from your application:
--   
--   <pre>
--   import Configuration.Dotenv
--   loadFile False "/my/dotenvfile"
--   </pre>
--   
--   This package also includes an executable that can be used to inspect
--   the results of applying one or more Dotenv files to the environment,
--   or for invoking your executables with an environment after one or more
--   Dotenv files is applied.
--   
--   See the <a>Github</a> page for more information on this package.
@package dotenv
@version 0.3.0.2


-- | Parser for files in dotenv format. These files generally consist of
--   lines with the form key=value. Comments and blank lines are also
--   supported. More information on the dotenv format can be found in the
--   project README and the test suite.
module Configuration.Dotenv.Parse

-- | Returns a parser for a Dotenv configuration file. Accepts key and
--   value arguments separated by "=". Comments are allowed on lines by
--   themselves and on blank lines.
configParser :: Parser [(String, String)]


-- | This module contains common functions to load and read dotenv files.
module Configuration.Dotenv

-- | Loads the given list of options into the environment. Optionally
--   override existing variables with values from Dotenv files.
load :: Bool -> [(String, String)] -> IO ()

-- | Loads the options in the given file to the environment. Optionally
--   override existing variables with values from Dotenv files.
loadFile :: Bool -> FilePath -> IO ()

-- | Parses the given dotenv file and returns values <i>without</i> adding
--   them to the environment.
parseFile :: FilePath -> IO [(String, String)]


-- | Provides a Data.Text interface for retrieving variables in a dotenv
--   file.
module Configuration.Dotenv.Text

-- | Parses the given dotenv file and returns values <i>without</i> adding
--   them to the environment.
parseFile :: FilePath -> IO [(Text, Text)]