@dotenvx/dotenvx 1.16.1 → 1.18.0

package/CHANGELOG.md

@@ -2,7 +2,46 @@
 
 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.16.1...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.18.0...main)
+
+## 1.18.0
+
+### Added
+
+* `set` and `encrypt` preserve leading spaces ([#395](https://github.com/dotenvx/dotenvx/pull/395/))
+
+```sh
+     HELLO=world
+```
+
+### Changed
+
+* improve escape and quote handling for `set`, `encrypt`, and `decrypt` ([#395](https://github.com/dotenvx/dotenvx/pull/395))
+* 🐞 fix `encrypt`, then `decrypt`, then `encrypt` on a json value ([#377](https://github.com/dotenvx/dotenvx/issues/377))
+
+Note: the underlying `replace` engine to support these changes now wraps your values in single quotes. the prior `replace` engine wrapped in double quotes.
+
+So where your `.env` used to look like this with double quotes:
+
+```sh
+HELLO="encrypted:1234"
+API_KEY="encrypted:5678"
+```
+
+It will now begin looking like this with single quotes:
+
+```sh
+HELLO='encrypted:1234'
+API_KEY='encrypted:5678'
+```
+
+It's an aesthetic side effect only. Your values will continue to be decrypted and encrypted correctly.
+
+## 1.17.0
+
+### Added
+
+* add `--format=eval` option for `get` ([#393](https://github.com/dotenvx/dotenvx/pull/393))
 
 ## 1.16.1
 

package/README.md

@@ -260,6 +260,18 @@ More examples
   Hello World
   ```
 
+  </details>
+* <details><summary>Kotlin 📐</summary><br>
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ echo 'fun main() { val hello = System.getenv("HELLO") ?: ""; println("Hello $hello") }' > index.kt
+  $ kotlinc index.kt -include-runtime -d index.jar
+
+  $ dotenvx run -- java -jar index.jar
+  Hello World
+  ```
+
   </details>
 * <details><summary>.NET 🔵</summary><br>
 
@@ -1072,6 +1084,33 @@ More examples
   ```
 
   </details>
+* <details><summary>`get --format eval`</summary><br>
+
+  Return an `eval`-ready shell formatted response of all key/value pairs in a `.env` file.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ echo "KEY=value" >> .env
+
+  $ dotenvx get --format eval
+  HELLO="World"
+  KEY="value"
+  ```
+
+  Note that this exports newlines and quoted strings.
+
+  This can be useful for more complex .env values (spaces, escaped characters, quotes, etc) combined with `eval` on the command line.
+
+  ```sh
+  $ echo "console.log('Hello ' + process.env.KEY + ' ' + process.env.HELLO)" > index.js
+  $ eval $(dotenvx get --format=eval) node index.js
+  Hello value World
+  ```
+
+  Be careful with `eval` as it allows for arbitrary execution of commands. Prefer `dotenvx run --` but in some cases `eval` is a sharp knife that is useful to have.
+
+  </details>
+
 * <details><summary>`get --all`</summary><br>
 
   Return preset machine envs as well.

package/package.json

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

package/src/cli/actions/get.js

@@ -1,6 +1,7 @@
 const { logger } = require('./../../shared/logger')
 
 const conventions = require('./../../lib/helpers/conventions')
+const escape = require('./../../lib/helpers/escape')
 
 const main = require('./../../lib/main')
 
@@ -23,8 +24,15 @@ function get (key) {
   const results = main.get(key, envs, options.overload, process.env.DOTENV_KEY, options.all)
 
   if (typeof results === 'object' && results !== null) {
-    // inline shell format - env $(dotenvx get --format shell) your-command
-    if (options.format === 'shell') {
+    if (options.format === 'eval') {
+      let inline = ''
+      for (const [key, value] of Object.entries(results)) {
+        inline += `${key}=${escape(value)}\n`
+      }
+      inline = inline.trim()
+
+      console.log(inline)
+    } else if (options.format === 'shell') {
       let inline = ''
       for (const [key, value] of Object.entries(results)) {
         inline += `${key}=${value} `
@@ -32,7 +40,6 @@ function get (key) {
       inline = inline.trim()
 
       console.log(inline)
-    // json format
     } else {
       let space = 0
       if (options.prettyPrint) {

package/src/cli/dotenvx.js

@@ -75,7 +75,7 @@ program.command('get')
   .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
   .option('-a, --all', 'include all machine envs as well')
   .option('-pp, --pretty-print', 'pretty print output')
-  .option('--format <type>', 'format of the output (json, shell)', 'json')
+  .option('--format <type>', 'format of the output (json, shell, eval)', 'json')
   .action(function (...args) {
     this.envs = envs
 

package/src/lib/helpers/escape.js

@@ -0,0 +1,5 @@
+function escape (value) {
+  return JSON.stringify(value)
+}
+
+module.exports = escape

package/src/lib/helpers/escapeForRegex.js

@@ -0,0 +1,5 @@
+function escapeForRegex (str) {
+  return str.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d')
+}
+
+module.exports = escapeForRegex

package/src/lib/helpers/replace.js

@@ -1,38 +1,55 @@
+const util = require('util')
 const dotenv = require('dotenv')
 
-function replace (src, key, value) {
+const escapeForRegex = require('./escapeForRegex')
+
+function replace (src, key, replaceValue) {
   let output
-  let formatted = `${key}="${value}"`
+  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')
+  }
+  let newPart = `${key}=${escapedValue}`
 
   const parsed = dotenv.parse(src)
   if (Object.prototype.hasOwnProperty.call(parsed, key)) {
-    const regex = new RegExp(
-      // Match the key at the start of a line, following a newline, or prefaced by export
-      `(^|\\n)\\s*(export\\s+)?${key}\\s*=\\s*` +
-      // `(^|\\n)${key}\\s*=\\s*` +
-      // Non-capturing group to handle different types of quotations and unquoted values
-      '(?:' +
-        '(["\'`])' + // Match an opening quote
-        '.*?' + // Non-greedy match for any characters within quotes
-        // '\\2' + // Match the corresponding closing quote
-        '\\3' + // Match the corresponding closing quote
-      '|' +
-        // Match unquoted values; account for escaped newlines
-        '(?:[^#\\n\\\\]|\\\\.)*' + // Use non-capturing group for any character except #, newline, or backslash, or any escaped character
-      ')',
-      'gs' // Global and dotAll mode to treat string as single line
+    const originalValue = parsed[key]
+    const escapedOriginalValue = escapeForRegex(originalValue)
+
+    // conditionally enforce end of line
+    let enforceEndOfLine = ''
+    if (escapedOriginalValue === '') {
+      enforceEndOfLine = '$' // EMPTY scenario
+    }
+
+    const currentPart = new RegExp(
+      '^' + // start of line
+      '(\\s*)?' + // spaces
+      '(export\\s+)?' + // export
+      key + // KEY
+      '\\s*=\\s*' + // spaces (KEY = value)
+      '["\'`]?' + // open quote
+      escapedOriginalValue + // escaped value
+      '["\'`]?' + // close quote
+      enforceEndOfLine
+      ,
+      'gm' // (g)lobal (m)ultiline
     )
 
-    output = src.replace(regex, `$1$2${formatted}`)
+    // $1 preserves spaces
+    // $2 preserves export
+    output = src.replace(currentPart, `$1$2${newPart}`)
   } else {
     // append
     if (src.endsWith('\n')) {
-      formatted = formatted + '\n'
+      newPart = newPart + '\n'
     } else {
-      formatted = '\n' + formatted
+      newPart = '\n' + newPart
     }
 
-    output = src + formatted
+    output = src + newPart
   }
 
   return output

package/src/lib/services/genexample.js

@@ -83,7 +83,7 @@ class Genexample {
         if (key in parsed) {
           preExisted[key] = parsed[key]
         } else {
-          exampleSrc += `${key}=""\n`
+          exampleSrc += `${key}=''\n`
 
           addedKeys.add(key)