Configuration.Dotenv.Internal

Documentation

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

• configDryRun :: Bool

  Flag to print out the variables loaded without executing the program

• allowDuplicates :: Bool

  Flag to allow duplicate variables

Instances

Show Config

Defined in Configuration.Dotenv.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Default Config

Defined in Configuration.Dotenv.Types

Methods

def :: Config

Eq Config

Defined in Configuration.Dotenv.Types

Methods

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

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

defaultConfig :: Config

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

configParser :: Parser [ParsedVariable]

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

data ParsedVariable

Name and value pair

Constructors

ParsedVariable VarName VarValue

Instances

Show ParsedVariable

Defined in Configuration.Dotenv.ParsedVariable

Methods

showsPrec :: Int -> ParsedVariable -> ShowS

show :: ParsedVariable -> String

showList :: [ParsedVariable] -> ShowS

Eq ParsedVariable

Defined in Configuration.Dotenv.ParsedVariable

Methods

(==) :: ParsedVariable -> ParsedVariable -> Bool

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

type VarName = String

Variable name

data VarValue

Possible state of values

Constructors

Unquoted VarContents

SingleQuoted VarContents

DoubleQuoted VarContents

Instances

Show VarValue

Defined in Configuration.Dotenv.ParsedVariable

Methods

showsPrec :: Int -> VarValue -> ShowS

show :: VarValue -> String

showList :: [VarValue] -> ShowS

Eq VarValue

Defined in Configuration.Dotenv.ParsedVariable

Methods

(==) :: VarValue -> VarValue -> Bool

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

type VarContents = [VarFragment]

List of VarFragment

data VarFragment

Placeholder for possible values

Constructors

VarInterpolation String

VarLiteral String

CommandInterpolation String [String]

Instances

Show VarFragment

Defined in Configuration.Dotenv.ParsedVariable

Methods

showsPrec :: Int -> VarFragment -> ShowS

show :: VarFragment -> String

showList :: [VarFragment] -> ShowS

Eq VarFragment

Defined in Configuration.Dotenv.ParsedVariable

Methods

(==) :: VarFragment -> VarFragment -> Bool

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

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

Interpotales parsed variables

parseFile

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.