smarter DOTENV_CONFIG_QUIET option that can read from source .env file

Author: motdotla

lib/main.js

@@ -3,7 +3,6 @@ const path = require('path')
 const os = require('os')
 const crypto = require('crypto')
 const packageJson = require('../package.json')
-const envOptions = require('./env-options')
 
 const version = packageJson.version
 
@@ -26,6 +25,13 @@ function _getRandomTip () {
   return TIPS[Math.floor(Math.random() * TIPS.length)]
 }
 
+function parseBoolean (value) {
+  if (typeof value === 'string') {
+    return !['false', '0', 'no', 'off', ''].includes(value.toLowerCase())
+  }
+  return Boolean(value)
+}
+
 function supportsAnsi () {
   return process.stdout.isTTY // && process.env.TERM !== 'dumb'
 }
@@ -217,8 +223,8 @@ function _resolveHome (envPath) {
 }
 
 function _configVault (options) {
-  const debug = Boolean(options && options.debug)
-  const quiet = Boolean(options && options.quiet)
+  const debug = parseBoolean(process.env.DOTENV_CONFIG_DEBUG || (options && options.debug))
+  const quiet = parseBoolean(process.env.DOTENV_CONFIG_QUIET || (options && options.quiet))
 
   if (debug || !quiet) {
     _log('Loading env from encrypted .env.vault')
@@ -239,8 +245,8 @@ function _configVault (options) {
 function configDotenv (options) {
   const dotenvPath = path.resolve(process.cwd(), '.env')
   let encoding = 'utf8'
-  const debug = Boolean(options && options.debug)
-  const quiet = Boolean(options && options.quiet)
+  let debug = parseBoolean(process.env.DOTENV_CONFIG_DEBUG || (options && options.debug))
+  let quiet = parseBoolean(process.env.DOTENV_CONFIG_QUIET || (options && options.quiet))
 
   if (options && options.encoding) {
     encoding = options.encoding
@@ -287,6 +293,10 @@ function configDotenv (options) {
 
   const populated = DotenvModule.populate(processEnv, parsedAll, options)
 
+  // handle user settings DOTENV_CONFIG_ options inside .env file(s)
+  debug = parseBoolean(processEnv.DOTENV_CONFIG_DEBUG || debug)
+  quiet = parseBoolean(process.env.DOTENV_CONFIG_QUIET || quiet)
+
   if (debug || !quiet) {
     const keysCount = Object.keys(populated).length
     const shortPaths = []
@@ -314,23 +324,21 @@ function configDotenv (options) {
 
 // Populates process.env from .env file
 function config (options) {
-  const mergedOptions = Object.assign({}, envOptions, options)
-
   // fallback to original dotenv if DOTENV_KEY is not set
-  if (_dotenvKey(mergedOptions).length === 0) {
-    return DotenvModule.configDotenv(mergedOptions)
+  if (_dotenvKey(options).length === 0) {
+    return DotenvModule.configDotenv(options)
   }
 
-  const vaultPath = _vaultPath(mergedOptions)
+  const vaultPath = _vaultPath(options)
 
   // dotenvKey exists but .env.vault file does not exist
   if (!vaultPath) {
     _warn(`You set DOTENV_KEY but you are missing a .env.vault file at ${vaultPath}. Did you forget to build it?`)
 
-    return DotenvModule.configDotenv(mergedOptions)
+    return DotenvModule.configDotenv(options)
   }
 
-  return DotenvModule._configVault(mergedOptions)
+  return DotenvModule._configVault(options)
 }
 
 function decrypt (encrypted, keyStr) {

tests/test-config-vault.js

@@ -25,60 +25,6 @@ t.afterEach(() => {
   }
 })
 
-t.test('logs when no path is set', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config()
-  ct.ok(logStub.called)
-})
-
-t.test('does log by default', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: testPath })
-  ct.ok(logStub.called)
-})
-
-t.test('does not log if quiet flag passed true', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: testPath, quiet: true })
-  ct.ok(logStub.notCalled)
-})
-
-t.test('does log if quiet flag false', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: testPath, quiet: false })
-  ct.ok(logStub.called)
-})
-
-t.test('does log if quiet flag present and undefined/null', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: testPath, quiet: undefined })
-  ct.ok(logStub.called)
-})
-
-t.test('logs if debug set', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: testPath, debug: true })
-  ct.ok(logStub.called)
-})
-
 t.test('does log when testPath calls to .env.vault directly (interpret what the user meant)', ct => {
   ct.plan(1)
 
@@ -88,18 +34,10 @@ t.test('does log when testPath calls to .env.vault directly (interpret what the
   ct.ok(logStub.called)
 })
 
-t.test('logs when testPath calls to .env.vault directly (interpret what the user meant) and debug true', ct => {
-  ct.plan(1)
-
-  logStub = sinon.stub(console, 'log')
-
-  dotenv.config({ path: `${testPath}.vault`, debug: true })
-  ct.ok(logStub.called)
-})
-
 t.test('warns if DOTENV_KEY exists but .env.vault does not exist', ct => {
   ct.plan(1)
 
+  const testPath = 'tests/.env'
   logStub = sinon.stub(console, 'log')
 
   const existsSync = sinon.stub(fs, 'existsSync').returns(false) // make .env.vault not exist
@@ -113,6 +51,7 @@ t.test('warns if DOTENV_KEY exists but .env.vault does not exist', ct => {
 t.test('warns if DOTENV_KEY exists but .env.vault does not exist (set as array)', ct => {
   ct.plan(1)
 
+  const testPath = 'tests/.env'
   logStub = sinon.stub(console, 'log')
 
   const existsSync = sinon.stub(fs, 'existsSync').returns(false) // make .env.vault not exist
@@ -123,6 +62,15 @@ t.test('warns if DOTENV_KEY exists but .env.vault does not exist (set as array)'
   ct.end()
 })
 
+t.test('logs when testPath calls to .env.vault directly (interpret what the user meant) and debug true', ct => {
+  ct.plan(1)
+
+  logStub = sinon.stub(console, 'log')
+
+  dotenv.config({ path: `${testPath}.vault`, debug: true })
+  ct.ok(logStub.called)
+})
+
 t.test('returns parsed object', ct => {
   ct.plan(1)