@dotenvx/dotenvx 1.11.4 → 1.12.0

package/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 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.11.4...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.12.0...main)
+
+## 1.12.0
+
+* add `dotenvx get --format shell` option ([#363](https://github.com/dotenvx/dotenvx/pull/363))
+
+## 1.11.5
+
+* revert `tinyexec` for `execa` - to support usage in bun
 
 ## 1.11.4
 

package/README.md

@@ -1041,6 +1041,31 @@ More examples
   {"HELLO":"World"}
   ```
 
+  </details>
+* <details><summary>`get --format shell`</summary><br>
+
+  Return a shell formatted response of all key/value pairs in a `.env` file.
+
+  ```sh
+  $ echo "HELLO=World\n" > .env
+  $ echo "KEY=value\n" >> .env
+
+  $ dotenvx get --format shell
+  HELLO="World" KEY="value"
+  ```
+
+  This can be useful when combined with `env` on the command line.
+
+  ```
+  $ env $(dotenvx get format --shell) your-command
+  ```
+
+  or with `export`.
+
+  ```
+  $ export $(dotenvx get format --shell) your-command
+  ```
+
   </details>
 * <details><summary>`get --all`</summary><br>
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.11.4",
+  "version": "1.12.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -39,11 +39,11 @@
     "commander": "^11.1.0",
     "dotenv": "^16.4.5",
     "eciesjs": "^0.4.6",
+    "execa": "^5.1.1",
     "fdir": "^6.2.0",
     "ignore": "^5.3.0",
     "object-treeify": "1.1.33",
     "picomatch": "^4.0.2",
-    "tinyexec": "^0.3.0",
     "which": "^4.0.0"
   },
   "devDependencies": {

package/src/cli/actions/get.js

@@ -20,21 +20,33 @@ function get (key) {
     envs = this.envs
   }
 
-  const value = main.get(key, envs, options.overload, process.env.DOTENV_KEY, options.all)
+  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') {
+      let inline = ''
+      for (const [key, value] of Object.entries(results)) {
+        inline += `${key}="${value}" `
+      }
+      inline = inline.trim()
+
+      process.stdout.write(inline)
+    // json format
+    } else {
+      let space = 0
+      if (options.prettyPrint) {
+        space = 2
+      }
 
-  if (typeof value === 'object' && value !== null) {
-    let space = 0
-    if (options.prettyPrint) {
-      space = 2
+      process.stdout.write(JSON.stringify(results, null, space))
     }
-
-    process.stdout.write(JSON.stringify(value, null, space))
   } else {
-    if (value === undefined) {
+    if (results === undefined) {
       process.stdout.write('')
       process.exit(1)
     } else {
-      process.stdout.write(value)
+      process.stdout.write(results)
     }
   }
 }

package/src/cli/dotenvx.js

@@ -75,6 +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')
   .action(function (...args) {
     this.envs = envs
 

package/src/lib/helpers/detectEncoding.js

@@ -14,12 +14,6 @@ function detectEncoding (filepath) {
     return 'utf8'
   }
 
-  // Check if the file is entirely US-ASCII (0x00 - 0x7F), which is valid UTF-8
-  for (let i = 0; i < buffer.length; i++) {
-    if (buffer[i] > 0x7F) {
-      break
-    }
-  }
   /* c8 ignore stop */
 
   return 'utf8'

package/src/lib/helpers/execute.js

@@ -1,3 +1,9 @@
-const { exec } = require('tinyexec')
+const execa = require('execa')
 
-module.exports = { exec }
+const execute = {
+  execa (command, args, options) {
+    return execa(command, args, options)
+  }
+}
+
+module.exports = execute

package/src/lib/helpers/executeCommand.js

@@ -13,8 +13,6 @@ async function executeCommand (commandArgs, env) {
 
   // handler for SIGINT
   let commandProcess
-  // workaround until error.signal gets added https://github.com/tinylibs/tinyexec/issues/28
-  let signal
   const sigintHandler = () => {
     logger.debug('received SIGINT')
     logger.debug('checking command process')
@@ -22,7 +20,6 @@ async function executeCommand (commandArgs, env) {
 
     if (commandProcess) {
       logger.debug('sending SIGINT to command process')
-      signal = 'SIGINT'
       commandProcess.kill('SIGINT') // Send SIGINT to the command process
     /* c8 ignore start */
     } else {
@@ -40,7 +37,6 @@ async function executeCommand (commandArgs, env) {
 
     if (commandProcess) {
       logger.debug('sending SIGTERM to command process')
-      signal = 'SIGTERM'
       commandProcess.kill('SIGTERM') // Send SIGTEM to the command process
     } else {
       logger.debug('no command process to send SIGTERM to')
@@ -77,11 +73,9 @@ async function executeCommand (commandArgs, env) {
       }
     }
 
-    commandProcess = execute.exec(commandArgs[0], commandArgs.slice(1), {
-      nodeOptions: {
-        stdio: 'inherit',
-        env: { ...process.env, ...env }
-      }
+    commandProcess = execute.execa(commandArgs[0], commandArgs.slice(1), {
+      stdio: 'inherit',
+      env: { ...process.env, ...env }
     })
 
     process.on('SIGINT', sigintHandler)
@@ -92,9 +86,7 @@ async function executeCommand (commandArgs, env) {
     })
 
     // Wait for the command process to finish
-    // exitCode is not in the awaited result, see https://github.com/tinylibs/tinyexec/issues/27
-    await commandProcess
-    const { exitCode } = commandProcess
+    const { exitCode } = await commandProcess
 
     if (exitCode !== 0) {
       logger.debug(`received exitCode ${exitCode}`)
@@ -102,11 +94,11 @@ async function executeCommand (commandArgs, env) {
     }
   } catch (error) {
     // no color on these errors as they can be standard errors for things like jest exiting with exitCode 1 for a single failed test.
-    if (signal !== 'SIGINT' && signal !== 'SIGTERM') {
+    if (error.signal !== 'SIGINT' && error.signal !== 'SIGTERM') {
       if (error.code === 'ENOENT') {
-        logger.errornocolor(`Unknown command: ${error.path}${error.spawnargs ? ' ' + error.spawnargs.join(' ') : ''}`)
+        logger.errornocolor(`Unknown command: ${error.command}`)
       } else if (error.message.includes('Command failed with exit code 1')) {
-        logger.errornocolor(`Command exited with exit code 1: ${error.path}${error.spawnargs ? ' ' + error.spawnargs.join(' ') : ''}`)
+        logger.errornocolor(`Command exited with exit code 1: ${error.command}`)
       } else {
         logger.errornocolor(error.message)
       }