@dotenvx/dotenvx 1.13.3 → 1.14.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.13.3...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.14.0...main)
+
+## 1.14.0
+
+### Added
+
+* add `dotenvx keypair` command for printing your public/private keypairs ([#375](https://github.com/dotenvx/dotenvx/pull/375))
 
 ## 1.13.3
 

package/README.md

@@ -1273,6 +1273,45 @@ More examples
   $ dotenvx decrypt --stdout > somefile.txt
   ```
 
+  </details>
+* <details><summary>`keypair`</summary><br>
+
+  Print public/private keys for `.env` file.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ dotenvx encrypt
+
+  $ dotenvx keypair
+  {"DOTENV_PUBLIC_KEY":"<publicKey>","DOTENV_PRIVATE_KEY":"<privateKey>"}
+  ```
+
+  </details>
+* <details><summary>`keypair -f .env.production`</summary><br>
+
+  Print public/private keys for `.env.production` file.
+
+  ```sh
+  $ echo "HELLO=Production" > .env.production
+  $ dotenvx encrypt -f .env.production
+
+  $ dotenvx keypair -f .env.production
+  {"DOTENV_PUBLIC_KEY_PRODUCTION":"<publicKey>","DOTENV_PRIVATE_KEY_PRODUCTION":"<privateKey>"}
+  ```
+
+  </details>
+* <details><summary>`keypair DOTENV_PRIVATE_KEY`</summary><br>
+
+  Print specific key for `.env` file.
+
+  ```sh
+  $ echo "HELLO=World" > .env
+  $ dotenvx encrypt
+
+  $ dotenvx keypair DOTENV_PRIVATE_KEY
+  <privateKey>
+  ```
+
   </details>
 * <details><summary>`ls`</summary><br>
 

package/package.json

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

package/src/cli/actions/keypair.js

@@ -0,0 +1,32 @@
+const { logger } = require('./../../shared/logger')
+
+const main = require('./../../lib/main')
+
+function keypair (key) {
+  if (key) {
+    logger.debug(`key: ${key}`)
+  }
+
+  const options = this.opts()
+  logger.debug(`options: ${JSON.stringify(options)}`)
+
+  const results = main.keypair(options.envFile, key)
+
+  if (typeof results === 'object' && results !== null) {
+    let space = 0
+    if (options.prettyPrint) {
+      space = 2
+    }
+
+    process.stdout.write(JSON.stringify(results, null, space))
+  } else {
+    if (results === undefined) {
+      process.stdout.write('')
+      process.exit(1)
+    } else {
+      process.stdout.write(results)
+    }
+  }
+}
+
+module.exports = keypair

package/src/cli/dotenvx.js

@@ -115,6 +115,15 @@ program.command('decrypt')
   .option('--stdout', 'send to stdout')
   .action(decryptAction)
 
+// dotenvx keypair
+const keypairAction = require('./actions/keypair')
+program.command('keypair')
+  .description('print public/private keys for .env file(s)')
+  .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')
+  .action(keypairAction)
+
 // dotenvx ls
 const lsAction = require('./actions/ls')
 program.command('ls')

package/src/lib/helpers/smartDotenvPublicKey.js

@@ -0,0 +1,44 @@
+const fs = require('fs')
+const dotenv = require('dotenv')
+
+const ENCODING = 'utf8'
+
+const guessPublicKeyName = require('./guessPublicKeyName')
+
+function searchProcessEnv (publicKeyName) {
+  if (process.env[publicKeyName] && process.env[publicKeyName].length > 0) {
+    return process.env[publicKeyName]
+  }
+}
+
+function searchEnvFile (publicKeyName, envFilepath) {
+  if (fs.existsSync(envFilepath)) {
+    const keysSrc = fs.readFileSync(envFilepath, { encoding: ENCODING })
+    const keysParsed = dotenv.parse(keysSrc)
+
+    if (keysParsed[publicKeyName] && keysParsed[publicKeyName].length > 0) {
+      return keysParsed[publicKeyName]
+    }
+  }
+}
+
+function smartDotenvPublicKey (envFilepath) {
+  let publicKey = null
+  const publicKeyName = guessPublicKeyName(envFilepath) // DOTENV_PUBLIC_KEY_${ENVIRONMENT}
+
+  // 1. attempt process.env first
+  publicKey = searchProcessEnv(publicKeyName)
+  if (publicKey) {
+    return publicKey
+  }
+
+  // 2. attempt .env.keys second (path/to/.env.keys)
+  publicKey = searchEnvFile(publicKeyName, envFilepath)
+  if (publicKey) {
+    return publicKey
+  }
+
+  return null
+}
+
+module.exports = smartDotenvPublicKey

package/src/lib/main.js

@@ -11,6 +11,7 @@ const Ls = require('./services/ls')
 const Get = require('./services/get')
 const Run = require('./services/run')
 const Sets = require('./services/sets')
+const Keypair = require('./services/keypair')
 const Encrypt = require('./services/encrypt')
 const Decrypt = require('./services/decrypt')
 const Genexample = require('./services/genexample')
@@ -210,6 +211,11 @@ const decrypt = function (envFile, key, excludeKey) {
   return new Decrypt(envFile, key, excludeKey).run()
 }
 
+/** @type {import('./main').keypair} */
+const keypair = function (envFile, key) {
+  return new Keypair(envFile, key).run()
+}
+
 module.exports = {
   // dotenv proxies
   config,
@@ -221,6 +227,7 @@ module.exports = {
   ls,
   get,
   set,
+  keypair,
   genexample,
   // expose for libs depending on @dotenvx/dotenvx - like dotenvx-pro
   setLogLevel,

package/src/lib/services/keypair.js

@@ -0,0 +1,45 @@
+const guessPublicKeyName = require('./../helpers/guessPublicKeyName')
+const smartDotenvPublicKey = require('./../helpers/smartDotenvPublicKey')
+const guessPrivateKeyName = require('./../helpers/guessPrivateKeyName')
+const smartDotenvPrivateKey = require('./../helpers/smartDotenvPrivateKey')
+
+class Keypair {
+  constructor (envFile = '.env', key = undefined) {
+    this.envFile = envFile
+    this.key = key
+  }
+
+  run () {
+    const out = {}
+
+    const envFilepaths = this._envFilepaths()
+    for (const envFilepath of envFilepaths) {
+      // public key
+      const publicKeyName = guessPublicKeyName(envFilepath)
+      const publicKeyValue = smartDotenvPublicKey(envFilepath)
+      out[publicKeyName] = publicKeyValue
+
+      // private key
+      const privateKeyName = guessPrivateKeyName(envFilepath)
+      const privateKeyValue = smartDotenvPrivateKey(envFilepath)
+
+      out[privateKeyName] = privateKeyValue
+    }
+
+    if (this.key) {
+      return out[this.key]
+    } else {
+      return out
+    }
+  }
+
+  _envFilepaths () {
+    if (!Array.isArray(this.envFile)) {
+      return [this.envFile]
+    }
+
+    return this.envFile
+  }
+}
+
+module.exports = Keypair