@dotenvx/dotenvx 0.21.0 → 0.23.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.21.0",
+  "version": "0.23.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -32,7 +32,7 @@
     "clipboardy": "^2.3.0",
     "commander": "^11.1.0",
     "conf": "^10.2.0",
-    "dotenv": "16.4.5",
+    "dotenv": "^16.4.5",
     "dotenv-expand": "^11.0.6",
     "execa": "^5.1.1",
     "glob": "^10.3.10",

package/src/cli/actions/precommit.js

@@ -6,8 +6,28 @@ function precommit () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const precommit = new Precommit(options)
-  precommit.run()
+  try {
+    const {
+      successMessage,
+      warnings
+    } = new Precommit(options).run()
+
+    for (const warning of warnings) {
+      logger.warnv(warning.message)
+      if (warning.help) {
+        logger.help(warning.help)
+      }
+    }
+
+    logger.successvp(successMessage)
+  } catch (error) {
+    logger.errorvp(error.message)
+    if (error.help) {
+      logger.help(error.help)
+    }
+
+    process.exit(1)
+  }
 }
 
 module.exports = precommit

package/src/lib/helpers/dotenvVault.js

@@ -3,6 +3,7 @@ const path = require('path')
 const encrypt = require('./encrypt')
 const changed = require('./changed')
 const guessEnvironment = require('./guessEnvironment')
+const removePersonal = require('./removePersonal')
 
 class DotenvVault {
   constructor (dotenvFiles = {}, dotenvKeys = {}, dotenvVaults = {}) {
@@ -23,8 +24,10 @@ class DotenvVault {
       let ciphertext = this.dotenvVaults[vault]
       const dotenvKey = this.dotenvKeys[`DOTENV_KEY_${environment.toUpperCase()}`]
 
-      if (!ciphertext || ciphertext.length === 0 || changed(ciphertext, raw, dotenvKey)) {
-        ciphertext = encrypt(raw, dotenvKey)
+      const cleanRaw = removePersonal(raw)
+
+      if (!ciphertext || ciphertext.length === 0 || changed(ciphertext, cleanRaw, dotenvKey)) {
+        ciphertext = encrypt(cleanRaw, dotenvKey)
         this.dotenvVaults[vault] = ciphertext
         addedVaults.add(vault) // for info logging to user
 

package/src/lib/helpers/installPrecommitHook.js

@@ -1,8 +1,6 @@
 const fs = require('fs')
 const path = require('path')
 
-const logger = require('./../../shared/logger')
-
 const HOOK_SCRIPT = `#!/bin/sh
 
 if ! command -v dotenvx &> /dev/null
@@ -21,20 +19,30 @@ class InstallPrecommitHook {
   }
 
   run () {
+    let successMessage
+
     try {
       // Check if the pre-commit file already exists
       if (this._exists()) {
         // Check if 'dotenvx precommit' already exists in the file
-        if (!this._currentHook().includes('dotenvx precommit')) {
-          this._appendHook()
+        if (this._currentHook().includes('dotenvx precommit')) {
+          // do nothing
+          successMessage = `dotenvx precommit exists [${this.hookPath}]`
         } else {
-          logger.warnvp(`dotenvx precommit exists [${this.hookPath}]`)
+          this._appendHook()
+          successMessage = `dotenvx precommit appended [${this.hookPath}]`
         }
       } else {
         this._createHook()
+        successMessage = `dotenvx precommit installed [${this.hookPath}]`
+      }
+
+      return {
+        successMessage
       }
     } catch (err) {
-      logger.errorvp(`failed to modify pre-commit hook: ${err.message}`)
+      const error = new Error(`failed to modify pre-commit hook: ${err.message}`)
+      throw error
     }
   }
 
@@ -50,13 +58,11 @@ class InstallPrecommitHook {
     // If the pre-commit file doesn't exist, create a new one with the hookScript
     fs.writeFileSync(this.hookPath, HOOK_SCRIPT)
     fs.chmodSync(this.hookPath, '755') // Make the file executable
-    logger.successvp(`dotenvx precommit installed [${this.hookPath}]`)
   }
 
   _appendHook () {
     // Append 'dotenvx precommit' to the existing file
     fs.appendFileSync(this.hookPath, '\n' + HOOK_SCRIPT)
-    logger.successvp(`dotenvx precommit appended [${this.hookPath}]`)
   }
 }
 

package/src/lib/helpers/pluralize.js

@@ -0,0 +1,10 @@
+function pluralize (word, count) {
+  // simple pluralization: add 's' at the end
+  if (count === 0 || count > 1) {
+    return word + 's'
+  } else {
+    return word
+  }
+}
+
+module.exports = pluralize

package/src/lib/helpers/removePersonal.js

@@ -0,0 +1,9 @@
+const SPLIT_REGEX = /#\s*personal\.dotenv\s*/i
+
+function removePersonal (raw) {
+  const parts = raw.split(SPLIT_REGEX)
+
+  return parts[0]
+}
+
+module.exports = removePersonal

package/src/lib/main.js

@@ -1,5 +1,6 @@
 const logger = require('./../shared/logger')
 const dotenv = require('dotenv')
+const dotenvExpand = require('dotenv-expand')
 
 // services
 const Encrypt = require('./services/encrypt')
@@ -9,7 +10,15 @@ const Genexample = require('./services/genexample')
 
 // proxies to dotenv
 const config = function (options) {
-  return dotenv.config(options)
+  const env = dotenv.config(options)
+
+  // if processEnv passed also pass to expand
+  if (options && options.processEnv) {
+    env.processEnv = options.processEnv
+  }
+  const expanded = dotenvExpand.expand(env)
+
+  return expanded
 }
 
 const configDotenv = function (options) {

package/src/lib/services/precommit.js

@@ -1,9 +1,8 @@
 /* istanbul ignore file */
 const fs = require('fs')
 const ignore = require('ignore')
-const logger = require('./../../shared/logger')
-const helpers = require('./../../cli/helpers')
 
+const pluralize = require('./../helpers/pluralize')
 const InstallPrecommitHook = require('./../helpers/installPrecommitHook')
 
 class Precommit {
@@ -13,66 +12,59 @@ class Precommit {
 
   run () {
     if (this.install) {
-      this._installPrecommitHook()
+      const {
+        successMessage
+      } = this._installPrecommitHook()
 
-      return true
-    }
+      return {
+        successMessage,
+        warnings: []
+      }
+    } else {
+      const warnings = []
 
-    // 1. check for .gitignore file
-    if (!fs.existsSync('.gitignore')) {
-      logger.errorvp('.gitignore missing')
-      logger.help2('? add it with [touch .gitignore]')
-      process.exit(1)
-    }
+      // 1. check for .gitignore file
+      if (!fs.existsSync('.gitignore')) {
+        const error = new Error('.gitignore missing')
+        error.help = '? add it with [touch .gitignore]'
+        throw error
+      }
 
-    // 2. check .env* files against .gitignore file
-    let warningCount = 0
-    const ig = ignore().add(fs.readFileSync('.gitignore').toString())
-    const files = fs.readdirSync(process.cwd())
-    const dotenvFiles = files.filter(file => file.match(/^\.env(\..+)?$/))
-    dotenvFiles.forEach(file => {
-      // check if that file is being ignored
-      if (ig.ignores(file)) {
-        switch (file) {
-          case '.env.example':
-            warningCount += 1
-            logger.warnv(`${file} (currently ignored but should not be)`)
-            logger.help2(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
-            break
-          case '.env.vault':
-            warningCount += 1
-            logger.warnv(`${file} (currently ignored but should not be)`)
-            logger.help2(`? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`)
-            break
-          default:
-            break
-        }
-      } else {
-        switch (file) {
-          case '.env.example':
-            break
-          case '.env.vault':
-            break
-          default:
-            logger.errorvp(`${file} not properly gitignored`)
-            logger.help2(`? add ${file} to .gitignore with [echo ".env*" >> .gitignore]`)
-            process.exit(1) // 3.1 exit early with error code
-            break
+      // 2. check .env* files against .gitignore file
+      const ig = ignore().add(fs.readFileSync('.gitignore').toString())
+      const files = fs.readdirSync(process.cwd())
+      const dotenvFiles = files.filter(file => file.match(/^\.env(\..+)?$/))
+      dotenvFiles.forEach(file => {
+        // check if that file is being ignored
+        if (ig.ignores(file)) {
+          if (file === '.env.example' || file === '.env.vault') {
+            const warning = new Error(`${file} (currently ignored but should not be)`)
+            warning.help = `? add !${file} to .gitignore with [echo "!${file}" >> .gitignore]`
+            warnings.push(warning)
+          }
+        } else {
+          if (file !== '.env.example' && file !== '.env.vault') {
+            const error = new Error(`${file} not properly gitignored`)
+            error.help = `? add ${file} to .gitignore with [echo ".env*" >> .gitignore]`
+            throw error
+          }
         }
+      })
+
+      let successMessage = 'success'
+      if (warnings.length > 0) {
+        successMessage = `success (with ${pluralize('warning', warnings.length)})`
       }
-    })
 
-    // 3. outpout success
-    if (warningCount > 0) {
-      logger.successvp(`success (with ${helpers.pluralize('warning', warningCount)})`)
-    } else {
-      logger.successvp('success')
+      return {
+        successMessage,
+        warnings
+      }
     }
   }
 
-  /* istanbul ignore next */
   _installPrecommitHook () {
-    new InstallPrecommitHook().run()
+    return new InstallPrecommitHook().run()
   }
 }