@dotenvx/dotenvx 1.16.1 → 1.17.0

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.16.1...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.17.0...main)
+
+## 1.17.0
+
+### Added
+
+* add `--format=eval` option for `get` ([#393](https://github.com/dotenvx/dotenvx/pull/393))
 
 ## 1.16.1
 

package/README.md

@@ -1072,6 +1072,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.
+
+  ```
+  $ 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.17.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