diff --git a/CHANGELOG.md b/CHANGELOG.md
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,12 @@
## MASTER
+## Dotenv 0.12.0.0
+### Modified
+* Ensure support from GHC 8.10 up to GHC 9.6
+
+### Possible breaking change
+* New attribute for `Config` data type to print env vars without actually
+running the command (kudos to @flandrade).
+
## Dotenv 0.11.0.2
### Modified
* Allow optparse-applicative 0.18
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
[](https://github.com/stackbuilders/dotenv-hs/actions/workflows/build.yml)[](http://hackage.haskell.org/package/dotenv)
+
+[](#contributors-)
+
# Dotenv files for Haskell
@@ -122,6 +125,8 @@
A `False` in the `configVerbose` means that Dotenv will not print any message
when loading the envs. A `True` means that Dotenv will print a message when a variable is loaded.
+When `configDryRyn` is `True`, Dotenv will print out the loaded environment variables without executing the program.
+
A `False` on `allowDuplicates` means that Dotenv will not allow duplicate keys, and instead it will throw
an error. A `True` means that Dotenv will allow duplicate keys, and it will use the last one defined in the file (default behavior).
@@ -181,12 +186,14 @@
```
This will fail:
+
```shell
$ dotenv -f .env --example .env.example "myprogram --myflag myargument"
> dotenv: The following variables are present in .env.example, but not set in the current environment, or .env: BAR
```
This will succeed:
+
```shell
$ export BAR=123 # Or you can do something like: "echo 'BAR=123' >> .env"
$ dotenv -f .env --example .env.example "myprogram --myflag myargument"
@@ -197,6 +204,56 @@
of `myprogram` above you can see what the environment will look like
after evaluating multiple Dotenv files.
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+
+
+
+
+
+
+
+
+
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
## License
MIT, see [the LICENSE file](LICENSE).
@@ -206,5 +263,6 @@
Do you want to contribute to this project? Please take a look at our [contributing guideline](/docs/CONTRIBUTING.md) to know how you can help us build it.
---
+
[Check out our libraries](https://github.com/stackbuilders/) | [Join our team](https://www.stackbuilders.com/join-us/)
diff --git a/app/Main.hs b/app/Main.hs
--- a/app/Main.hs
+++ b/app/Main.hs
@@ -20,6 +20,7 @@
, dotenvExampleFiles :: [String]
, override :: Bool
, verbose :: Bool
+ , dryRun :: Bool
, duplicates :: Bool
, program :: String
, args :: [String]
@@ -33,6 +34,7 @@
{ configExamplePath = dotenvExampleFiles
, configOverride = override
, configVerbose = verbose
+ , configDryRun = dryRun
, allowDuplicates = duplicates
, configPath =
if null dotenvFiles
@@ -40,8 +42,10 @@
else dotenvFiles
}
in do
- loadFile configDotenv
- system (program ++ concatMap (" " ++) args) >>= exitWith
+ loadFile configDotenv
+ if configDryRun configDotenv
+ then putStrLn "[INFO]: Dry run mode enabled. Not executing the program."
+ else system (program ++ concatMap (" " ++) args) >>= exitWith
where
opts = info (helper <*> versionOption <*> config)
( fullDesc
@@ -72,6 +76,9 @@
<*> switch ( long "verbose"
<> help "Specify this flag to print out the variables loaded and other useful insights" )
+
+ <*> switch ( long "dry-run"
+ <> help "Specify this flag to print out the variables loaded without executing the program" )
<*> flag True False ( long "no-dups"
<> short 'D'
diff --git a/dotenv.cabal b/dotenv.cabal
--- a/dotenv.cabal
+++ b/dotenv.cabal
@@ -1,5 +1,5 @@
name: dotenv
-version: 0.11.0.2
+version: 0.12.0.0
synopsis: Loads environment variables from dotenv files
homepage: https://github.com/stackbuilders/dotenv-hs
description:
@@ -34,6 +34,7 @@
license: MIT
license-file: LICENSE
author: Justin Leitgeb
+tested-with: ghc ==8.10 ghc ==9.0 ghc ==9.2 ghc ==9.4 ghc ==9.6
maintainer: hackage@stackbuilders.com
copyright: 2015-Present Stack Builders Inc.
category: Configuration
@@ -62,7 +63,7 @@
executable dotenv
main-is: Main.hs
- build-depends: base >= 4.9 && < 5.0
+ build-depends: base >= 4.14 && < 5.0
, base-compat >= 0.4
, dotenv
, optparse-applicative >= 0.11 && < 0.19
diff --git a/spec/Configuration/DotenvSpec.hs b/spec/Configuration/DotenvSpec.hs
--- a/spec/Configuration/DotenvSpec.hs
+++ b/spec/Configuration/DotenvSpec.hs
@@ -77,7 +77,7 @@
lookupEnv "FOO" `shouldReturn` Nothing
lookupEnv "BAR" `shouldReturn` Nothing
- loadFile (Config ["spec/fixtures/.dotenv.dup"] [] False False True)
+ loadFile (Config ["spec/fixtures/.dotenv.dup"] [] False False False True)
lookupEnv "FOO" `shouldReturn` Just "last"
lookupEnv "BAR" `shouldReturn` Just "tender"
@@ -165,8 +165,14 @@
loadFile sampleConfig { allowDuplicates = False }
lookupEnv "DOTENV" `shouldReturn` Just "true"
+ describe "onConfigDryRun" $ after_ clearEnvs $
+ context "when dry-run is enabled " $
+ it "loads the variables" $ do
+ loadFile sampleConfig { configPath = ["spec/fixtures/.dotenv"], configDryRun = True }
+ lookupEnv "DOTENV" `shouldReturn` Just "true"
+
sampleConfig :: Config
-sampleConfig = Config ["spec/fixtures/.dotenv"] [] False False True
+sampleConfig = Config ["spec/fixtures/.dotenv"] [] False False False True
clearEnvs :: IO ()
clearEnvs =
diff --git a/src/Configuration/Dotenv.hs b/src/Configuration/Dotenv.hs
--- a/src/Configuration/Dotenv.hs
+++ b/src/Configuration/Dotenv.hs
@@ -128,9 +128,13 @@
info :: MonadIO m => (String, String) -> DotEnv m ()
info (key, value) = do
Config {..} <- ask
- when configVerbose $
+ when (configVerbose || configDryRun) $
lift . liftIO $
- putStrLn $ "[INFO]: Load env '" ++ key ++ "' with value '" ++ value ++ "'"
+ putStrLn $ infoStr (key, value)
+
+-- | The function prints out the variables
+infoStr :: (String, String) -> String
+infoStr (key, value) = "[INFO]: Load env '" ++ key ++ "' with value '" ++ value ++ "'"
-- | The helper allows to avoid exceptions in the case of missing files and
-- perform some action instead.
diff --git a/src/Configuration/Dotenv/Types.hs b/src/Configuration/Dotenv/Types.hs
--- a/src/Configuration/Dotenv/Types.hs
+++ b/src/Configuration/Dotenv/Types.hs
@@ -23,6 +23,7 @@
, 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
} deriving (Eq, Show)
@@ -35,6 +36,7 @@
, configOverride = False
, configPath = [ ".env" ]
, configVerbose = False
+ , configDryRun = False
, allowDuplicates = True
}
