Safe Haskell	Safe-Inferred
Language	Haskell2010

Configuration.Dotenv.Internal

Synopsis

data Config = Config {
- configPath :: [FilePath]
- configExamplePath :: [FilePath]
- configOverride :: Bool
- configVerbose :: Bool
- configDryRun :: Bool
- allowDuplicates :: Bool
}
defaultConfig :: Config
configParser :: Parser [ParsedVariable]
data ParsedVariable = ParsedVariable VarName VarValue
type VarName = String
data VarValue
type VarContents = [VarFragment]
data VarFragment
- = VarInterpolation String
- | VarLiteral String
- | CommandInterpolation String [String]
interpolateParsedVariables :: [ParsedVariable] -> IO [(String, String)]
parseFile :: MonadIO m => FilePath -> m [(Text, Text)]

Documentation

data Config Source #

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
configDryRun :: Bool
Flag to print out the variables loaded without executing the program
allowDuplicates :: Bool
Flag to allow duplicate variables

Instances

Instances details

Show Config Source #
Instance details Defined in Configuration.Dotenv.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Default Config Source #
Instance details Defined in Configuration.Dotenv.Types Methods def :: Config #
Eq Config Source #
Instance details Defined in Configuration.Dotenv.Types Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #

defaultConfig :: Config Source #

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

configParser :: Parser [ParsedVariable] Source #

Returns a parser for a Dotenv configuration file. Accepts key and value arguments separated by =. Comments in all positions are handled appropriately.

data ParsedVariable Source #

Name and value pair

Constructors

ParsedVariable VarName VarValue

Instances

Instances details

Show ParsedVariable Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods showsPrec :: Int -> ParsedVariable -> ShowS # show :: ParsedVariable -> String # showList :: [ParsedVariable] -> ShowS #
Eq ParsedVariable Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods (==) :: ParsedVariable -> ParsedVariable -> Bool # (/=) :: ParsedVariable -> ParsedVariable -> Bool #

type VarName = String Source #

Variable name

data VarValue Source #

Possible state of values

Constructors

Unquoted VarContents
SingleQuoted VarContents
DoubleQuoted VarContents

Instances

Instances details

Show VarValue Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods showsPrec :: Int -> VarValue -> ShowS # show :: VarValue -> String # showList :: [VarValue] -> ShowS #
Eq VarValue Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods (==) :: VarValue -> VarValue -> Bool # (/=) :: VarValue -> VarValue -> Bool #

type VarContents = [VarFragment] Source #

List of VarFragment

data VarFragment Source #

Placeholder for possible values

Constructors

VarInterpolation String
VarLiteral String
CommandInterpolation String [String]

Instances

Instances details

Show VarFragment Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods showsPrec :: Int -> VarFragment -> ShowS # show :: VarFragment -> String # showList :: [VarFragment] -> ShowS #
Eq VarFragment Source #
Instance details Defined in Configuration.Dotenv.ParsedVariable Methods (==) :: VarFragment -> VarFragment -> Bool # (/=) :: VarFragment -> VarFragment -> Bool #

interpolateParsedVariables :: [ParsedVariable] -> IO [(String, String)] Source #

Interpotales parsed variables

parseFile Source #

Arguments

:: MonadIO m
=> FilePath	A file containing options to read
-> m [(Text, Text)]	Variables contained in the file

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