@dotenvx/dotenvx 1.31.0 → 1.31.1

package/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/v1.31.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.31.1...main)
+
+## [1.31.1](https://github.com/dotenvx/dotenvx/compare/v1.31.0...v1.31.1)
+
+### Changed
+
+* 🐞 fix encryption of values containing explicit `\n` newlines ([#495](https://github.com/dotenvx/dotenvx/pull/495))
 
 ## [1.31.0](https://github.com/dotenvx/dotenvx/compare/v1.30.1...v1.31.0)
 

package/README.md

@@ -80,7 +80,7 @@ tar -xzf dotenvx.tar.gz
 </details>
 
 
-<details><summary>or with windows 🟦🟩🟥🟨</summary><br>
+<details><summary>or with windows 🪟</summary><br>
 
 ```sh
 winget install dotenvx

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.31.0",
+  "version": "1.31.1",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -52,7 +52,7 @@
     "sinon": "^14.0.1",
     "standard": "^17.1.0",
     "standard-version": "^9.5.0",
-    "tap": "^19.2.0"
+    "tap": "^21.0.1"
   },
   "publishConfig": {
     "access": "public",

package/src/lib/helpers/dotenvParse.js

@@ -0,0 +1,43 @@
+// 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) {
+  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]
+
+    // Remove surrounding quotes
+    value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
+
+    // Expand newlines if double quoted
+    if (maybeQuote === '"' && !skipExpandForDoubleQuotes) {
+      value = value.replace(/\\n/g, '\n') // newline
+      value = value.replace(/\\r/g, '\r') // carriage return
+      value = value.replace(/\\t/g, '\t') // tabs
+    }
+
+    // Add to object
+    obj[key] = value
+  }
+
+  return obj
+}
+
+module.exports = dotenvParse

package/src/lib/helpers/executeDynamic.js

@@ -1,4 +1,3 @@
-const fsx = require('./fsx')
 const path = require('path')
 const childProcess = require('child_process')
 const { logger } = require('../../shared/logger')
@@ -27,7 +26,29 @@ function executeDynamic (program, command, rawArgs) {
       // logger.warn(`[INSTALLATION_NEEDED] install dotenvx-${command} to use [dotenvx ${command}] commands 🏆`)
       // logger.help('? see installation instructions [https://github.com/dotenvx/dotenvx-pro]')
 
-      const pro = fsx.readFileX(path.join(__dirname, './../../cli/pro.txt'))
+      const pro = `_______________________________________________________________
+|                                                             |
+|  coming soon! (for small business)                          |
+|                                                             |
+|      | |     | |                                            |
+|    __| | ___ | |_ ___ _ ____   ____  __  _ __  _ __ ___     |
+|   / _\` |/ _ \\| __/ _ \\ '_ \\ \\ / /\\ \\/ / | '_ \\| '__/ _ \\    |
+|  | (_| | (_) | ||  __/ | | \\ V /  >  <  | |_) | | | (_) |   |
+|   \\__,_|\\___/ \\__\\___|_| |_|\\_/  /_/\\_\\ | .__/|_|  \\___/    |
+|                                         | |                 |
+|                                         |_|                 |
+| ## learn more on github 🐙                                  |
+|                                                             |
+| >> https://github.com/dotenvx/dotenvx/issues/259            |
+|                                                             |
+| ## subscribe on github to be notified 📣                    |
+|                                                             |
+| >> https://github.com/dotenvx/dotenvx/issues/259            |
+|                                                             |
+| ----------------------------------------------------------- |
+| - thank you for using dotenvx! - @motdotla                  |
+|_____________________________________________________________|`
+
       console.log(pro)
     } else {
       logger.info(`error: unknown command '${command}'`)

package/src/lib/helpers/isFullyEncrypted.js

@@ -1,10 +1,9 @@
-const dotenv = require('dotenv')
-
+const dotenvParse = require('./dotenvParse')
 const isEncrypted = require('./isEncrypted')
 const isPublicKey = require('./isPublicKey')
 
 function isFullyEncrypted (src) {
-  const parsed = dotenv.parse(src)
+  const parsed = dotenvParse(src)
 
   for (const [key, value] of Object.entries(parsed)) {
     const result = isEncrypted(value) || isPublicKey(key, value)

package/src/lib/helpers/replace.js

@@ -1,6 +1,5 @@
-const dotenv = require('dotenv')
-
 const quotes = require('./quotes')
+const dotenvParse = require('./dotenvParse')
 const escapeForRegex = require('./escapeForRegex')
 const escapeDollarSigns = require('./escapeDollarSigns')
 
@@ -8,7 +7,7 @@ function replace (src, key, replaceValue) {
   let output
   let newPart = ''
 
-  const parsed = dotenv.parse(src)
+  const parsed = dotenvParse(src, true) // skip expanding \n
   const _quotes = quotes(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
     const quote = _quotes[key]

package/src/lib/helpers/smartDotenvPrivateKey.js

@@ -1,10 +1,10 @@
 const fsx = require('./fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 
 const PUBLIC_KEY_SCHEMA = 'DOTENV_PUBLIC_KEY'
 const PRIVATE_KEY_SCHEMA = 'DOTENV_PRIVATE_KEY'
 
+const dotenvParse = require('./dotenvParse')
 const guessPrivateKeyName = require('./guessPrivateKeyName')
 
 function searchProcessEnv (privateKeyName) {
@@ -21,7 +21,7 @@ function searchKeysFile (privateKeyName, envFilepath, envKeysFilepath = null) {
 
   if (fsx.existsSync(keysFilepath)) {
     const keysSrc = fsx.readFileX(keysFilepath)
-    const keysParsed = dotenv.parse(keysSrc)
+    const keysParsed = dotenvParse(keysSrc)
 
     if (keysParsed[privateKeyName] && keysParsed[privateKeyName].length > 0) {
       return keysParsed[privateKeyName]
@@ -35,7 +35,7 @@ function invertForPrivateKeyName (envFilepath) {
   }
 
   const envSrc = fsx.readFileX(envFilepath)
-  const envParsed = dotenv.parse(envSrc)
+  const envParsed = dotenvParse(envSrc)
 
   let publicKeyName
   for (const keyName of Object.keys(envParsed)) {

package/src/lib/helpers/smartDotenvPublicKey.js

@@ -1,5 +1,5 @@
 const fsx = require('./fsx')
-const dotenv = require('dotenv')
+const dotenvParse = require('./dotenvParse')
 
 const guessPublicKeyName = require('./guessPublicKeyName')
 
@@ -12,7 +12,7 @@ function searchProcessEnv (publicKeyName) {
 function searchEnvFile (publicKeyName, envFilepath) {
   if (fsx.existsSync(envFilepath)) {
     const keysSrc = fsx.readFileX(envFilepath)
-    const keysParsed = dotenv.parse(keysSrc)
+    const keysParsed = dotenvParse(keysSrc)
 
     if (keysParsed[publicKeyName] && keysParsed[publicKeyName].length > 0) {
       return keysParsed[publicKeyName]

package/src/lib/services/decrypt.js

@@ -1,6 +1,5 @@
 const fsx = require('./../helpers/fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 const picomatch = require('picomatch')
 
 const TYPE_ENV_FILE = 'envFile'
@@ -10,6 +9,7 @@ const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const findPrivateKey = require('./../helpers/findPrivateKey')
 const decryptKeyValue = require('./../helpers/decryptKeyValue')
 const isEncrypted = require('./../helpers/isEncrypted')
+const dotenvParse = require('./../helpers/dotenvParse')
 const replace = require('./../helpers/replace')
 const detectEncoding = require('./../helpers/detectEncoding')
 const determineEnvs = require('./../helpers/determineEnvs')
@@ -63,7 +63,7 @@ class Decrypt {
     try {
       const encoding = this._detectEncoding(filepath)
       let envSrc = fsx.readFileX(filepath, { encoding })
-      const envParsed = dotenv.parse(envSrc)
+      const envParsed = dotenvParse(envSrc)
 
       const privateKey = findPrivateKey(envFilepath, this.envKeysFilepath)
       const privateKeyName = guessPrivateKeyName(envFilepath)

package/src/lib/services/encrypt.js

@@ -1,6 +1,5 @@
 const fsx = require('./../helpers/fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 const picomatch = require('picomatch')
 
 const TYPE_ENV_FILE = 'envFile'
@@ -10,6 +9,7 @@ const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const guessPublicKeyName = require('./../helpers/guessPublicKeyName')
 const encryptValue = require('./../helpers/encryptValue')
 const isEncrypted = require('./../helpers/isEncrypted')
+const dotenvParse = require('./../helpers/dotenvParse')
 const replace = require('./../helpers/replace')
 const detectEncoding = require('./../helpers/detectEncoding')
 const determineEnvs = require('./../helpers/determineEnvs')
@@ -69,7 +69,7 @@ class Encrypt {
     try {
       const encoding = this._detectEncoding(filepath)
       let envSrc = fsx.readFileX(filepath, { encoding })
-      const envParsed = dotenv.parse(envSrc)
+      const envParsed = dotenvParse(envSrc)
 
       let publicKey
       let privateKey
@@ -173,6 +173,7 @@ class Encrypt {
           row.keys.push(key) // track key(s)
 
           const encryptedValue = encryptValue(value, publicKey)
+
           // once newSrc is built write it out
           envSrc = replace(envSrc, key, encryptedValue)
 

package/src/lib/services/genexample.js

@@ -1,10 +1,10 @@
 const fsx = require('./../helpers/fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 
 const Errors = require('../helpers/errors')
 const findEnvFiles = require('../helpers/findEnvFiles')
 const replace = require('../helpers/replace')
+const dotenvParse = require('../helpers/dotenvParse')
 
 class Genexample {
   constructor (directory = '.', envFile) {
@@ -47,7 +47,7 @@ class Genexample {
 
       // get the original src
       let src = fsx.readFileX(filepath)
-      const parsed = dotenv.parse(src)
+      const parsed = dotenvParse(src)
       for (const key in parsed) {
         // used later
         keys.add(key)
@@ -72,7 +72,7 @@ class Genexample {
       // it already exists (which means the user might have it modified a way in which they prefer, so replace exampleSrc with their existing .env.example)
       exampleSrc = fsx.readFileX(this.exampleFilepath)
 
-      const parsed = dotenv.parse(exampleSrc)
+      const parsed = dotenvParse(exampleSrc)
       for (const key of [...keys]) {
         if (key in parsed) {
           preExisted[key] = parsed[key]

package/src/lib/services/run.js

@@ -1,6 +1,5 @@
 const fsx = require('./../helpers/fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 
 const TYPE_ENV = 'env'
 const TYPE_ENV_FILE = 'envFile'
@@ -9,6 +8,7 @@ const TYPE_ENV_VAULT_FILE = 'envVaultFile'
 const decrypt = require('./../helpers/decrypt')
 const Parse = require('./../helpers/parse')
 const Errors = require('./../helpers/errors')
+const dotenvParse = require('./../helpers/dotenvParse')
 const parseEnvironmentFromDotenvKey = require('./../helpers/parseEnvironmentFromDotenvKey')
 const detectEncoding = require('./../helpers/detectEncoding')
 const findPrivateKey = require('./../helpers/findPrivateKey')
@@ -196,7 +196,7 @@ class Run {
   // { "DOTENV_VAULT_DEVELOPMENT": "<ciphertext>" }
   _parsedVault (filepath) {
     const src = fsx.readFileX(filepath)
-    return dotenv.parse(src)
+    return dotenvParse(src)
   }
 
   _decrypted (dotenvKey, parsedVault) {

package/src/lib/services/sets.js

@@ -1,6 +1,5 @@
 const fsx = require('./../helpers/fsx')
 const path = require('path')
-const dotenv = require('dotenv')
 
 const TYPE_ENV_FILE = 'envFile'
 
@@ -10,6 +9,7 @@ const guessPublicKeyName = require('./../helpers/guessPublicKeyName')
 const encryptValue = require('./../helpers/encryptValue')
 const decryptKeyValue = require('./../helpers/decryptKeyValue')
 const replace = require('./../helpers/replace')
+const dotenvParse = require('./../helpers/dotenvParse')
 const detectEncoding = require('./../helpers/detectEncoding')
 const determineEnvs = require('./../helpers/determineEnvs')
 const findPrivateKey = require('./../helpers/findPrivateKey')
@@ -66,7 +66,7 @@ class Sets {
     try {
       const encoding = this._detectEncoding(filepath)
       let envSrc = fsx.readFileX(filepath, { encoding })
-      const envParsed = dotenv.parse(envSrc)
+      const envParsed = dotenvParse(envSrc)
       row.originalValue = envParsed[row.key] || null
       const wasPlainText = !isEncrypted(row.originalValue)
       this.readableFilepaths.add(envFilepath)

package/src/cli/pro.txt

@@ -1,22 +0,0 @@
-_______________________________________________________________
-|                                                             |
-|  coming soon! (for small business)                          |
-|                                                             |
-|      | |     | |                                            |
-|    __| | ___ | |_ ___ _ ____   ____  __  _ __  _ __ ___     |
-|   / _` |/ _ \| __/ _ \ '_ \ \ / /\ \/ / | '_ \| '__/ _ \    |
-|  | (_| | (_) | ||  __/ | | \ V /  >  <  | |_) | | | (_) |   |
-|   \__,_|\___/ \__\___|_| |_|\_/  /_/\_\ | .__/|_|  \___/    |
-|                                         | |                 |
-|                                         |_|                 |
-| ## learn more on github 🐙                                  |
-|                                                             |
-| >> https://github.com/dotenvx/dotenvx/issues/259            |
-|                                                             |
-| ## subscribe on github to be notified 📣                    |
-|                                                             |
-| >> https://github.com/dotenvx/dotenvx/issues/259            |
-|                                                             |
-| ----------------------------------------------------------- |
-| - thank you for using dotenvx! - @motdotla                  |
-|_____________________________________________________________|