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


-- | Tiny dotenv library
--   
--   Loading secrets and confidential configuration values is a software
--   architectural practice. This library enables that with a tiny
--   dependency footprint.
@package dotenv-micro
@version 0.1.0.0


-- | Tiny library for handling environment variables stored in
--   <tt>.env</tt> files.
--   
--   <h2>File format</h2>
--   
--   <tt>.env</tt> files are plain text UTF-8 files with rows of the form:
--   
--   <pre>
--   KEY=VALUE
--   </pre>
--   
--   The rows are separated by newline and the <tt>KEY</tt>s must not
--   contain any equal sign.
--   
--   The <tt>VALUE</tt> strings on the other hand can contain equal signs
--   (the string is ingested up to the newline).
--   
--   NB: Currently this library does <i>not</i> support variables.
--   
--   <h2>Important</h2>
--   
--   Add the paths of your <tt>.env</tt> files to the <tt>.gitignore</tt>
--   file or equivalent, so that they are not checked into source control.
module DotEnv.Micro

-- | Load, parse and apply a <tt>.env</tt> file
--   
--   NB : does not overwrite any preexisting env vars.
--   
--   NB2 : if the given <tt>.env</tt> file is not found or cannot be parsed
--   the program crashes with <tt>fail</tt>.
loadDotEnv :: MonadIO m => Maybe FilePath -> m ()