@dotenvx/dotenvx 1.37.0 → 1.38.1

package/CHANGELOG.md

@@ -2,7 +2,22 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.37.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.38.1...main)
+
+## [1.38.1](https://github.com/dotenvx/dotenvx/compare/v1.38.0...v1.38.1)
+
+### Changed
+
+* Support `encrypt` when mutliline contains windows `CRLF` (`\\r\\n`) ([#534](https://github.com/dotenvx/dotenvx/pull/534))
+
+Note: dotenvx will convert these `\\r\\n` newlines to `\\n`. Our recommendation is to stop using CRLF - its origin is from typewriter days. Instead, set your editor or gitattributes to use LF.
+
+## [1.38.0](https://github.com/dotenvx/dotenvx/compare/v1.37.0...v1.38.0)
+
+### Changed
+
+* Command substitution failures no longer halt further processing of keys in a .env file ([#533](https://github.com/dotenvx/dotenvx/pull/533))
+* A more helpful error is raised if a command substitution failure occurs ([#533](https://github.com/dotenvx/dotenvx/pull/533))
 
 ## [1.37.0](https://github.com/dotenvx/dotenvx/compare/v1.36.0...v1.37.0)
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.37.0",
+  "version": "1.38.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/lib/helpers/append.js

@@ -7,7 +7,7 @@ function append (src, key, appendValue) {
   let output
   let newPart = ''
 
-  const parsed = dotenvParse(src, true) // skip expanding \n
+  const parsed = dotenvParse(src, true, true) // skip expanding \n and skip converting \r\n
   const _quotes = quotes(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
     const quote = _quotes[key]

package/src/lib/helpers/dotenvParse.js

@@ -1,14 +1,16 @@
 // historical dotenv.parse - https://github.com/motdotla/dotenv)
 const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
 
-function dotenvParse (src, skipExpandForDoubleQuotes = false) {
+function dotenvParse (src, skipExpandForDoubleQuotes = false, skipConvertingWindowsNewlines = false) {
   const obj = {}
 
   // Convert buffer to string
   let lines = src.toString()
 
   // Convert line breaks to same format
-  lines = lines.replace(/\r\n?/mg, '\n')
+  if (!skipConvertingWindowsNewlines) {
+    lines = lines.replace(/\r\n?/mg, '\n')
+  }
 
   let match
   while ((match = LINE.exec(lines)) != null) {

package/src/lib/helpers/errors.js

@@ -8,6 +8,7 @@ class Errors {
     this.key = options.key
     this.privateKey = options.privateKey
     this.privateKeyName = options.privateKeyName
+    this.command = options.command
 
     this.message = options.message
   }
@@ -84,6 +85,17 @@ class Errors {
     e.code = code
     return e
   }
+
+  commandSubstitutionFailed () {
+    const code = 'COMMAND_SUBSTITUTION_FAILED'
+    const message = `[${code}] could not eval ${this.key} containing command '${this.command}': ${this.message}`
+    const help = `[${code}] https://github.com/dotenvx/dotenvx/issues/532`
+
+    const e = new Error(message)
+    e.code = code
+    e.help = help
+    return e
+  }
 }
 
 module.exports = Errors

package/src/lib/helpers/evalKeyValue.js

@@ -0,0 +1,23 @@
+const { execSync } = require('child_process')
+const chomp = require('./chomp')
+const Errors = require('./errors')
+
+function evalKeyValue (key, value, processEnv, runningParsed) {
+  // Match everything between the outermost $() using a regex with non-capturing groups
+  const matches = value.match(/\$\(([^)]+(?:\)[^(]*)*)\)/g) || []
+  return matches.reduce((newValue, match) => {
+    const command = match.slice(2, -1) // Extract command by removing $() wrapper
+    let result
+
+    try {
+      result = execSync(command, { env: { ...processEnv, ...runningParsed } }).toString() // execute command (including runningParsed)
+    } catch (e) {
+      throw new Errors({ key, command, message: e.message.trim() }).commandSubstitutionFailed()
+    }
+
+    result = chomp(result) // chomp it
+    return newValue.replace(match, result) // Replace match with result
+  }, value)
+}
+
+module.exports = evalKeyValue

package/src/lib/helpers/parse.js

@@ -1,7 +1,6 @@
-const chomp = require('./chomp')
 const decryptKeyValue = require('./decryptKeyValue')
+const evalKeyValue = require('./evalKeyValue')
 const resolveEscapeSequences = require('./resolveEscapeSequences')
-const { execSync } = require('child_process')
 
 class Parse {
   static LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
@@ -49,7 +48,12 @@ class Parse {
       let evaled = false
       if (quote !== "'" && (!this.inProcessEnv(key) || this.processEnv[key] === this.parsed[key])) {
         const priorEvaled = this.parsed[key]
-        this.parsed[key] = this.eval(priorEvaled)
+        // eval
+        try {
+          this.parsed[key] = this.eval(key, priorEvaled)
+        } catch (e) {
+          this.errors.push(e)
+        }
         if (priorEvaled !== this.parsed[key]) {
           evaled = true
         }
@@ -133,14 +137,8 @@ class Parse {
     return decryptKeyValue(key, value, this.privateKeyName, this.privateKey)
   }
 
-  eval (value) {
-    // Match everything between the outermost $() using a regex with non-capturing groups
-    const matches = value.match(/\$\(([^)]+(?:\)[^(]*)*)\)/g) || []
-    return matches.reduce((newValue, match) => {
-      const command = match.slice(2, -1) // Extract command by removing $() wrapper
-      const result = chomp(execSync(command, { env: { ...this.processEnv, ...this.runningParsed } }).toString()) // execute command (including runningParsed)
-      return newValue.replace(match, result) // Replace match with result
-    }, value)
+  eval (key, value) {
+    return evalKeyValue(key, value, this.processEnv, this.runningParsed)
   }
 
   expand (value) {

package/src/lib/helpers/replace.js

@@ -7,7 +7,7 @@ function replace (src, key, replaceValue) {
   let output
   let newPart = ''
 
-  const parsed = dotenvParse(src, true) // skip expanding \n
+  const parsed = dotenvParse(src, true, true) // skip expanding \n and skip converting \r\n
   const _quotes = quotes(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
     const quote = _quotes[key]