@dotenvx/dotenvx 1.14.2 → 1.16.0

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 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.14.2...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.16.0...main)
+
+## 1.16.0
+
+### Changed
+
+* for `dotenvx keypair` call out to `dotenvx pro keypair` if [pro](https://github.com/dotenvx/dotenvx/issues/259) installed ([#390](https://github.com/dotenvx/dotenvx/pull/390))
+
+## 1.15.0
+
+### Added
+
+* add `--format=shell` option for `keypair` ([#389](https://github.com/dotenvx/dotenvx/pull/389))
 
 ## 1.14.2
 

package/README.md

@@ -1057,13 +1057,18 @@ More examples
   This can be useful when combined with `env` on the command line.
 
   ```
-  $ env $(dotenvx get format --shell) your-command
+  $ echo "console.log('Hello ' + process.env.KEY + ' ' + process.env.HELLO)" > index.js
+  $ env $(dotenvx get --format=shell) node index.js
+  Hello value World
   ```
 
   or with `export`.
 
   ```
-  $ export $(dotenvx get format --shell) your-command
+  $ echo "console.log('Hello ' + process.env.KEY + ' ' + process.env.HELLO)" > index.js
+  $ export $(dotenvx get --format=shell)
+  $ node index.js
+  Hello value World
   ```
 
   </details>
@@ -1302,7 +1307,7 @@ More examples
   </details>
 * <details><summary>`keypair DOTENV_PRIVATE_KEY`</summary><br>
 
-  Print specific key for `.env` file.
+  Print specific keypair for `.env` file.
 
   ```sh
   $ echo "HELLO=World" > .env
@@ -1312,6 +1317,19 @@ More examples
   <privateKey>
   ```
 
+  </details>
+* <details><summary>`keypair --format shell`</summary><br>
+
+  Print a shell formatted reponse of public/private keys.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ dotenx encrypt
+
+  $ dotenvx keypair --format shell
+  DOTENV_PUBLIC_KEY=<publicKey> DOTENV_PRIVATE_KEY=<privateKey>
+  ```
+
   </details>
 * <details><summary>`ls`</summary><br>
 

package/package.json

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

package/src/cli/actions/keypair.js

@@ -13,12 +13,24 @@ function keypair (key) {
   const results = main.keypair(options.envFile, key)
 
   if (typeof results === 'object' && results !== null) {
-    let space = 0
-    if (options.prettyPrint) {
-      space = 2
-    }
+    // inline shell format - env $(dotenvx keypair --format=shell) your-command
+    if (options.format === 'shell') {
+      let inline = ''
+      for (const [key, value] of Object.entries(results)) {
+        inline += `${key}=${value || ''} `
+      }
+      inline = inline.trim()
+
+      console.log(inline)
+    // json format
+    } else {
+      let space = 0
+      if (options.prettyPrint) {
+        space = 2
+      }
 
-    console.log(JSON.stringify(results, null, space))
+      console.log(JSON.stringify(results, null, space))
+    }
   } else {
     if (results === undefined) {
       console.log('')

package/src/cli/dotenvx.js

@@ -122,6 +122,7 @@ program.command('keypair')
   .argument('[key]', 'environment variable key name')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
   .option('-pp, --pretty-print', 'pretty print output')
+  .option('--format <type>', 'format of the output (json, shell)', 'json')
   .action(keypairAction)
 
 // dotenvx ls

package/src/lib/services/run.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const dotenv = require('dotenv')
+const childProcess = require('child_process')
 
 const ENCODING = 'utf8'
 const TYPE_ENV = 'env'
@@ -13,10 +14,12 @@ const inject = require('./../helpers/inject')
 const decrypt = require('./../helpers/decrypt')
 const parseDecryptEvalExpand = require('./../helpers/parseDecryptEvalExpand')
 const parseEnvironmentFromDotenvKey = require('./../helpers/parseEnvironmentFromDotenvKey')
-const smartDotenvPrivateKey = require('./../helpers/smartDotenvPrivateKey')
 const guessPrivateKeyFilename = require('./../helpers/guessPrivateKeyFilename')
+const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
 const detectEncoding = require('./../helpers/detectEncoding')
 
+const Keypair = require('./../services/keypair')
+
 class Run {
   constructor (envs = [], overload = false, DOTENV_KEY = '', processEnv = process.env) {
     this.dotenvPrivateKeyNames = Object.keys(processEnv).filter(key => key.startsWith('DOTENV_PRIVATE_KEY')) // important, must be first. used by determineEnvs
@@ -94,8 +97,7 @@ class Run {
       const src = fs.readFileSync(filepath, { encoding })
       this.readableFilepaths.add(envFilepath)
 
-      // if DOTENV_PRIVATE_KEY_* already set in process.env then use it
-      const privateKey = smartDotenvPrivateKey(envFilepath)
+      const privateKey = this._determinePrivateKey(envFilepath)
       const { parsed, processEnv, warnings } = parseDecryptEvalExpand(src, privateKey, this.processEnv)
       row.parsed = parsed
       row.warnings = warnings
@@ -270,6 +272,29 @@ class Run {
 
     return decrypt(ciphertext, dotenvKey)
   }
+
+  _determinePrivateKey (envFilepath) {
+    const privateKeyName = guessPrivateKeyName(envFilepath)
+
+    let privateKey
+    try {
+      // if installed as sibling module
+      const projectRoot = path.resolve(process.cwd())
+      const dotenvxProPath = require.resolve('@dotenvx/dotenvx-pro', { paths: [projectRoot] })
+      const { keypair } = require(dotenvxProPath)
+      privateKey = keypair(envFilepath, privateKeyName)
+    } catch (_e) {
+      try {
+        // if installed as binary cli
+        privateKey = childProcess.execSync(`dotenvx-pro keypair ${privateKeyName} -f ${envFilepath} 2>/dev/null`).toString().trim()
+      } catch (_e) {
+        // fallback to local KeyPair - smart enough to handle process.env, .env.keys, etc
+        privateKey = new Keypair(envFilepath, privateKeyName).run()
+      }
+    }
+
+    return privateKey
+  }
 }
 
 module.exports = Run