Configuration.Dotenv

This module contains common functions to load and read dotenv files.

Dotenv Load Functions

load

Arguments

:: MonadIO m

=> Bool

Override existing settings?

-> [(String, String)]

List of values to be set in environment

-> m ()

Loads the given list of options into the environment. Optionally override existing variables with values from Dotenv files.

loadFile

Arguments

:: MonadIO m

=> Config

Dotenv configuration

-> m ()

loadFile parses the environment variables defined in the dotenv example file and checks if they are defined in the dotenv file or in the environment. It also allows to override the environment variables defined in the environment with the values defined in the dotenv file.

parseFile

Arguments

:: MonadIO m

=> FilePath

A file containing options to read

-> m [(String, String)]

Variables contained in the file

Parses the given dotenv file and returns values without adding them to the environment.

onMissingFile

Arguments

:: MonadCatch m

=> m a

Action to perform that may fail because of missing file

-> m a

Action to perform if file is indeed missing

-> m a

The helper allows to avoid exceptions in the case of missing files and perform some action instead.

Since: 0.3.1.0

Dotenv Types

data ReaderT r m a

Instances

Monad m => Monad (ReaderT r m)

Defined in Configuration.Dotenv.Types

Methods

(>>=) :: ReaderT r m a -> (a -> ReaderT r m b) -> ReaderT r m b

(>>) :: ReaderT r m a -> ReaderT r m b -> ReaderT r m b

return :: a -> ReaderT r m a

Functor m => Functor (ReaderT r m)

Defined in Configuration.Dotenv.Types

Methods

fmap :: (a -> b) -> ReaderT r m a -> ReaderT r m b

(<$) :: a -> ReaderT r m b -> ReaderT r m a

Applicative m => Applicative (ReaderT r m)

Defined in Configuration.Dotenv.Types

Methods

pure :: a -> ReaderT r m a

(<*>) :: ReaderT r m (a -> b) -> ReaderT r m a -> ReaderT r m b

liftA2 :: (a -> b -> c) -> ReaderT r m a -> ReaderT r m b -> ReaderT r m c

(*>) :: ReaderT r m a -> ReaderT r m b -> ReaderT r m b

(<*) :: ReaderT r m a -> ReaderT r m b -> ReaderT r m a

data Config

Configuration Data Types with extra options for executing dotenv.

Constructors

Config

Fields

• configPath :: [FilePath]

  The paths for the .env files

• configExamplePath :: [FilePath]

  The paths for the .env.example files

• configOverride :: Bool

  Flag to allow override env variables

• configVerbose :: Bool

  Flag to log the loaded variables and other useful information

• allowDuplicates :: Bool

  Flag to allow duplicate variables

Instances

Eq Config

Defined in Configuration.Dotenv.Types

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Show Config

Defined in Configuration.Dotenv.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

defaultConfig :: Config

Default configuration. Use .env file without .env.example strict envs and without overriding.

liftReaderT :: m a -> ReaderT r m a

ask :: Monad m => ReaderT r m r