@dotenvx/dotenvx 1.20.0 → 1.21.0

package/CHANGELOG.md

@@ -2,7 +2,25 @@
 
 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.20.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.21.0...main)
+
+## 1.21.0
+
+### Changed
+
+* treat single quotes literally ([#423](https://github.com/dotenvx/dotenvx/pull/423))
+* respect user chosen quotes ([#423](https://github.com/dotenvx/dotenvx/pull/423) [#377](https://github.com/dotenvx/dotenvx/issues/377))
+
+🎓 now if you choose to single quote, double quote, no quote, or backtick your value it will be respected - including for encrypted values. this more intuitively handles complex cases like escaped characters, literals, and json.
+
+## 1.20.1
+
+### Changed
+
+* update [eciesjs](https://github.com/ecies/js/issues/802) ([#421](https://github.com/dotenvx/dotenvx/pull/421))
+* remove default values for ts interface - no longer permitted by latest ts ([#419](https://github.com/dotenvx/dotenvx/pull/419))
+
+## 1.20.0
 
 ### Changed
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.20.0",
+  "version": "1.21.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -38,7 +38,7 @@
   "dependencies": {
     "commander": "^11.1.0",
     "dotenv": "^16.4.5",
-    "eciesjs": "^0.4.6",
+    "eciesjs": "^0.4.10",
     "execa": "^5.1.1",
     "fdir": "^6.2.0",
     "ignore": "^5.3.0",

package/src/lib/helpers/parseDecryptEvalExpand.js

@@ -3,6 +3,7 @@ const dotenvEval = require('./dotenvEval')
 const dotenvExpand = require('./dotenvExpand')
 const decryptValue = require('./decryptValue')
 const truncate = require('./truncate')
+const quotes = require('./quotes')
 
 function warning (e, key, privateKey = null) {
   const warning = new Error(`[${e.code}] could not decrypt ${key} using private key '${truncate(privateKey)}'`)
@@ -15,8 +16,10 @@ function warning (e, key, privateKey = null) {
 function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.env) {
   const warnings = []
 
-  // parse
+  // parse and quotes
   const parsed = dotenv.parse(src)
+  const _quotes = quotes(src)
+  const originalParsed = { ...parsed }
   for (const key in parsed) {
     try {
       const decryptedValue = decryptValue(parsed[key], privateKey)
@@ -39,7 +42,13 @@ function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.en
     parsed: evaled
   }
   const expanded = dotenvExpand.expand(inputEvaled)
+
   for (const key in expanded.parsed) {
+    // unset eval and expansion for single quotes
+    if (_quotes[key] === "'") {
+      expanded.parsed[key] = originalParsed[key] // reset to original
+    }
+
     try {
       const decryptedValue = decryptValue(expanded.parsed[key], privateKey)
       expanded.parsed[key] = decryptedValue
@@ -48,6 +57,11 @@ function parseDecryptEvalExpand (src, privateKey = null, processEnv = process.en
     }
   }
   for (const key in processEnv) {
+    // unset eval and expansion for single quotes
+    if (_quotes[key] === "'") {
+      processEnv[key] = originalParsed[key] // reset to original
+    }
+
     try {
       const decryptedValue = decryptValue(processEnv[key], privateKey)
       processEnv[key] = decryptedValue

package/src/lib/helpers/quotes.js

@@ -0,0 +1,36 @@
+const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
+
+function quotes (src) {
+  const obj = {}
+  // Convert buffer to string
+  let lines = src.toString()
+
+  // Convert line breaks to same format
+  lines = lines.replace(/\r\n?/mg, '\n')
+
+  let match
+  while ((match = LINE.exec(lines)) != null) {
+    const key = match[1]
+
+    // Default undefined or null to empty string
+    let value = (match[2] || '')
+
+    // Remove whitespace
+    value = value.trim()
+
+    // Check if double quoted
+    const maybeQuote = value[0]
+
+    value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
+
+    if (maybeQuote === value[0]) {
+      obj[key] = ''
+    } else {
+      obj[key] = maybeQuote
+    }
+  }
+
+  return obj
+}
+
+module.exports = quotes

package/src/lib/helpers/replace.js

@@ -1,28 +1,19 @@
-const util = require('util')
 const dotenv = require('dotenv')
 
+const quotes = require('./quotes')
 const escapeForRegex = require('./escapeForRegex')
 const escapeDollarSigns = require('./escapeDollarSigns')
 
 function replace (src, key, replaceValue) {
   let output
-  let escapedValue = util.inspect(replaceValue, { showHidden: false, depth: null, colors: false })
-
-  if (replaceValue.includes('\n')) {
-    escapedValue = JSON.stringify(replaceValue) // use JSON stringify if string contains newlines
-    escapedValue = escapedValue.replace(/\\n/g, '\n') // fix up newlines
-    escapedValue = escapedValue.replace(/\\r/g, '\r')
-  }
-
-  // prevents test\test (and similar) from becoming test\\test and then test\\\\test, etc recursively after each encrypt/decrypt combo
-  if (replaceValue.includes('\\')) {
-    escapedValue = escapedValue.replace(/\\\\/g, '\\')
-  }
-
-  let newPart = `${key}=${escapedValue}`
+  let newPart = ''
 
   const parsed = dotenv.parse(src)
+  const _quotes = quotes(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
+    const quote = _quotes[key]
+    newPart += `${key}=${quote}${replaceValue}${quote}`
+
     const originalValue = parsed[key]
     const escapedOriginalValue = escapeForRegex(originalValue)
 
@@ -52,6 +43,8 @@ function replace (src, key, replaceValue) {
     // $2 preserves export
     output = src.replace(currentPart, `$1$2${saferInput}`)
   } else {
+    newPart += `${key}="${replaceValue}"`
+
     // append
     if (src.endsWith('\n')) {
       newPart = newPart + '\n'

package/src/lib/main.d.ts

@@ -203,10 +203,10 @@ export function ls(
  */
 export function get(
   key?: string,
-  envs: string[] = [],
-  overload = false,
-  DOTENV_KEY = '',
-  all = false
+  envs?: string[],
+  overload?: boolean,
+  DOTENV_KEY?: string,
+  all?: boolean
 ): Record<string, string | undefined> | string | undefined;
 
 export type SetOutput = {