CHANGELOG.md

@@ -2,7 +2,13 @@
 
 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/v0.43.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v0.43.1...main)
+
+## 0.43.1
+
+### Added
+
+* Improved `replace` function regex - to handle more edge case scenarios with replacing KEY/values ([#227](https://github.com/dotenvx/dotenvx/pull/227))
 
 ## 0.43.0
 

README.md

@@ -32,7 +32,7 @@ brew install dotenvx/brew/dotenvx
 ```
 > * [other global ways to install](https://dotenvx.com/docs/install)
 >
-> Intall globally as a cli to unlock dotenv for ANY language, framework, or platform. 💥
+> Install globally as a cli to unlock dotenv for ANY language, framework, or platform. 💥
 >
 > I am using (and recommending) this approach going forward. – [motdotla](https://github.com/motdotla)
 

package.json

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

src/lib/helpers/replace.js

@@ -6,8 +6,19 @@ function replace (src, key, value) {
 
   const parsed = dotenv.parse(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
-    // replace
-    const regex = new RegExp(`^${key}=(?:(["'\`])[^\\1]*\\1|[^\\n]*)(\\n[^A-Z0-9_].*)*`, 'm')
+    const regex = new RegExp(
+      `^${key}=` + // start of line with key
+      '(?:' + // begin non-capturing group for handling both quoted and unquoted values
+        '(["\'`])' + // capture opening quote (' or " or `)
+        '[^\\1]*' + // match any character except the quote captured initially
+        '\\1' + // match the same closing quote as captured at the start
+      '|' + // OR
+        '[^#\\n]*' + // match any characters until a # (comment) or newline
+      ')' + // end non-capturing group
+      '(\\n[^A-Z0-9_].*)*', // match subsequent lines that don't start with a letter, number, or underscore (continuation lines)
+      'm' // apply multiline mode, so ^ and $ match start and end of lines, not just the whole string
+    )
+
     output = src.replace(regex, formatted)
   } else {
     // append

tests/lib/helpers/replace.test.js

@@ -94,3 +94,175 @@ t.test('#replace evals', ct => {
 
   ct.end()
 })
+
+t.test('#replace empty', ct => {
+  const src = 'HELLO='
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace empty backticks', ct => {
+  const src = 'HELLO=``'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace spaced single quotes', ct => {
+  const src = 'HELLO=\'    single quote   \''
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace spaced double quotes', ct => {
+  const src = 'HELLO="    single quote   "'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace double quotes inside single quotes', ct => {
+  const src = 'HELLO=\'double "quotes" inside single quotes'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace single quotes inside double quotes', ct => {
+  const src = 'HELLO="single \'quotes\' inside single quotes"'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace double quotes and single quotes inside backticks', ct => {
+  const src = 'HELLO=`double "quotes" and single \'quotes\' inside backticks`'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace newlines', ct => {
+  const src = 'HELLO="expand\nnew\nlines"'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace unquoted newlines', ct => {
+  const src = 'HELLO=dontexpand\nnewlines'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace inline comments', ct => {
+  const src = 'HELLO=inline comments # work #very #well'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"# work #very #well')
+
+  ct.end()
+})
+
+t.test('#replace inline comments', ct => {
+  const src = 'HELLO=inline comments # work #very #well'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"# work #very #well') // make a little smarter to handle the spaces
+
+  ct.end()
+})
+
+t.test('#replace hashtag in quotes', ct => {
+  const src = 'HELLO="hash #tag quoted"'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace equal signs', ct => {
+  const src = 'HELLO=equals=='
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace inner quotes', ct => {
+  const src = 'HELLO={"foo": "bar"}'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace inner quotes as string', ct => {
+  const src = 'HELLO=\'{"foo": "bar"}\''
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+t.test('#replace inner quotes as backticks', ct => {
+  const src = 'HELLO=`{"foo": "bar\'s"}`'
+
+  const newSrc = replace(src, 'HELLO', 'Universe')
+  ct.same(newSrc, 'HELLO="Universe"')
+
+  ct.end()
+})
+
+// TODO: handle leading space
+// t.test('#replace spaced key', ct => {
+//   const src = '     HELLO=parsed'
+//
+//   const newSrc = replace(src, 'HELLO', 'Universe')
+//   ct.same(newSrc, '     HELLO="Universe"')
+//
+//   ct.end()
+// })
+
+t.test('#replace somewhere in the middle', ct => {
+  const src = `VAR_1=val_1
+VAR_2=val_2
+VAR_3=val_3
+VAR_4=val_4`
+
+  const newSrc = replace(src, 'VAR_2', 'val_2b')
+
+  const expected = `VAR_1=val_1
+VAR_2="val_2b"
+VAR_3=val_3
+VAR_4=val_4`
+
+  ct.same(newSrc, expected)
+
+  ct.end()
+})