@dotenvx/dotenvx 1.13.2 → 1.14.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.13.2...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
+
+### Changed
+
+* exit code 1 when `decrypt` fails in any way ([#374](https://github.com/dotenvx/dotenvx/pull/374))
 
 ## 1.13.2
 

package/README.md

@@ -1274,84 +1274,46 @@ More examples
   ```
 
   </details>
+* <details><summary>`keypair`</summary><br>
 
-* <details><summary>`help`</summary><br>
-
-  Output help for `dotenvx`.
+  Print public/private keys for `.env` file.
 
   ```sh
-  $ dotenvx help
-  Usage: @dotenvx/dotenvx [options] [command]
-
-  a better dotenv–from the creator of `dotenv`
-
-  Options:
-    -l, --log-level <level>           set log level (default: "info")
-    -q, --quiet                       sets log level to error
-    -v, --verbose                     sets log level to verbose
-    -d, --debug                       sets log level to debug
-    -V, --version                     output the version number
-    -h, --help                        display help for command
+  $ echo "HELLO=World" > .env
+  $ dotenvx encrypt
 
-  Commands:
-    run [options]                     inject env at runtime [dotenvx run -- yourcommand]
-    get [options] [key]               return a single environment variable
-    set [options] <KEY> <value>       set a single environment variable
-    encrypt [options]                 convert .env file(s) to encrypted .env file(s)
-    decrypt [options]                 convert encrypted .env file(s) to plain .env file(s)
-    pro                               🏆 pro
-    ext [command] [args...]           🔌 extensions
-    help [command]                    display help for command
+  $ dotenvx keypair
+  {"DOTENV_PUBLIC_KEY":"<publicKey>","DOTENV_PRIVATE_KEY":"<privateKey>"}
   ```
 
-  You can get more detailed help per command with `dotenvx help COMMAND`.
-
-  ```sh
-  $ dotenvx help run
-  Usage: @dotenvx/dotenvx run [options]
-
-  inject env at runtime [dotenvx run -- yourcommand]
-
-  Options:
-    -e, --env <strings...>            environment variable(s) set as string (example: "HELLO=World") (default: [])
-    -f, --env-file <paths...>         path(s) to your env file(s) (default: [])
-    -fv, --env-vault-file <paths...>  path(s) to your .env.vault file(s) (default: [])
-    -o, --overload                    override existing env variables
-    --convention <name>               load a .env convention (available conventions: ['nextjs'])
-    -h, --help                        display help for command
-
-  Examples:
-
-    $ dotenvx run -- npm run dev
-    $ dotenvx run -- flask --app index run
-    $ dotenvx run -- php artisan serve
-    $ dotenvx run -- bin/rails s
+  </details>
+* <details><summary>`keypair -f .env.production`</summary><br>
 
-  Try it:
+  Print public/private keys for `.env.production` file.
 
-    $ echo "HELLO=World" > .env
-    $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+  ```sh
+  $ echo "HELLO=Production" > .env.production
+  $ dotenvx encrypt -f .env.production
 
-    $ dotenvx run -- node index.js
-    [dotenvx] injecting env (1) from .env
-    Hello World
+  $ dotenvx keypair -f .env.production
+  {"DOTENV_PUBLIC_KEY_PRODUCTION":"<publicKey>","DOTENV_PRIVATE_KEY_PRODUCTION":"<privateKey>"}
   ```
 
   </details>
-* <details><summary>`--version`</summary><br>
+* <details><summary>`keypair DOTENV_PRIVATE_KEY`</summary><br>
 
-  Check current version of `dotenvx`.
+  Print specific key for `.env` file.
 
   ```sh
-  $ dotenvx --version
-  X.X.X
+  $ echo "HELLO=World" > .env
+  $ dotenvx encrypt
+
+  $ dotenvx keypair DOTENV_PRIVATE_KEY
+  <privateKey>
   ```
 
   </details>
-
-### Extensions 🔌
-
-* <details><summary>`ext ls`</summary><br>
+* <details><summary>`ls`</summary><br>
 
   Print all `.env` files in a tree structure.
 
@@ -1361,7 +1323,7 @@ More examples
   $ mkdir -p apps/backend
   $ touch apps/backend/.env
 
-  $ dotenvx ext ls
+  $ dotenvx ls
   ├─ .env.production
   ├─ .env
   └─ apps
@@ -1370,7 +1332,7 @@ More examples
   ```
 
   </details>
-* <details><summary>`ext ls directory`</summary><br>
+* <details><summary>`ls directory`</summary><br>
 
   Print all `.env` files inside a specified path to a directory.
 
@@ -1380,12 +1342,12 @@ More examples
   $ mkdir -p apps/backend
   $ touch apps/backend/.env
 
-  $ dotenvx ext ls apps/backend
+  $ dotenvx ls apps/backend
   └─ .env
   ```
 
   </details>
-* <details><summary>`ext ls -f`</summary><br>
+* <details><summary>`ls -f`</summary><br>
 
   Glob `.env` filenames matching a wildcard.
 
@@ -1396,7 +1358,7 @@ More examples
   $ touch apps/backend/.env
   $ touch apps/backend/.env.prod
 
-  $ dotenvx ext ls -f **/.env.prod*
+  $ dotenvx ls -f **/.env.prod*
   ├─ .env.production
   └─ apps
      └─ backend
@@ -1404,6 +1366,104 @@ More examples
   ```
 
   </details>
+* <details><summary>`ls -ef`</summary><br>
+
+  Glob `.env` filenames excluding a wildcard.
+
+  ```sh
+  $ touch .env
+  $ touch .env.production
+  $ mkdir -p apps/backend
+  $ touch apps/backend/.env
+  $ touch apps/backend/.env.prod
+  
+  $ dotenvx ls -ef '**/.env.prod*'
+  ├─ .env
+  └─ apps
+     └─ backend
+        └─ .env
+  ```
+
+  </details>
+
+* <details><summary>`help`</summary><br>
+
+  Output help for `dotenvx`.
+
+  ```sh
+  $ dotenvx help
+  Usage: dotenvx [options] [command] [command] [args...]
+
+  a better dotenv–from the creator of `dotenv`
+
+  Options:
+    -l, --log-level <level>      set log level (default: "info")
+    -q, --quiet                  sets log level to error
+    -v, --verbose                sets log level to verbose
+    -d, --debug                  sets log level to debug
+    -V, --version                output the version number
+    -h, --help                   display help for command
+
+  Commands:
+    run [options]                inject env at runtime [dotenvx run -- yourcommand]
+    get [options] [key]          return a single environment variable
+    set [options] <KEY> <value>  set a single environment variable
+    encrypt [options]            convert .env file(s) to encrypted .env file(s)
+    decrypt [options]            convert encrypted .env file(s) to plain .env file(s)
+    ls [options] [directory]     print all .env files in a tree structure
+   
+  Advanced: 
+    pro                          🏆 pro
+    ext                          🔌 extensions
+  ```
+
+  You can get more detailed help per command with `dotenvx help COMMAND`.
+
+  ```sh
+  $ dotenvx help run
+  Usage: @dotenvx/dotenvx run [options]
+
+  inject env at runtime [dotenvx run -- yourcommand]
+
+  Options:
+    -e, --env <strings...>            environment variable(s) set as string (example: "HELLO=World") (default: [])
+    -f, --env-file <paths...>         path(s) to your env file(s) (default: [])
+    -fv, --env-vault-file <paths...>  path(s) to your .env.vault file(s) (default: [])
+    -o, --overload                    override existing env variables
+    --convention <name>               load a .env convention (available conventions: ['nextjs'])
+    -h, --help                        display help for command
+
+  Examples:
+
+    $ dotenvx run -- npm run dev
+    $ dotenvx run -- flask --app index run
+    $ dotenvx run -- php artisan serve
+    $ dotenvx run -- bin/rails s
+
+  Try it:
+
+    $ echo "HELLO=World" > .env
+    $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+    $ dotenvx run -- node index.js
+    [dotenvx] injecting env (1) from .env
+    Hello World
+  ```
+
+  </details>
+* <details><summary>`--version`</summary><br>
+
+  Check current version of `dotenvx`.
+
+  ```sh
+  $ dotenvx --version
+  X.X.X
+  ```
+
+  </details>
+
+### Extensions 🔌
+
 * <details><summary>`ext genexample`</summary><br>
 
   In one command, generate a `.env.example` file from your current `.env` file contents.

package/package.json

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

package/src/cli/actions/decrypt.js

@@ -9,6 +9,8 @@ function decrypt () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
+  let errorCount = 0
+
   // stdout - should not have a try so that exit codes can surface to stdout
   if (options.stdout) {
     const {
@@ -16,9 +18,19 @@ function decrypt () {
     } = main.decrypt(options.envFile, options.key, options.excludeKey)
 
     for (const processedEnvFile of processedEnvFiles) {
-      process.stdout.write(processedEnvFile.envSrc)
+      if (processedEnvFile.error) {
+        errorCount += 1
+        console.error(processedEnvFile.error.message)
+      } else {
+        process.stdout.write(processedEnvFile.envSrc)
+      }
+    }
+
+    if (errorCount > 0) {
+      process.exit(1)
+    } else {
+      process.exit(0) // exit early
     }
-    process.exit(0) // exit early
   } else {
     try {
       const {
@@ -29,12 +41,15 @@ function decrypt () {
 
       for (const processedEnvFile of processedEnvFiles) {
         logger.verbose(`decrypting ${processedEnvFile.envFilepath} (${processedEnvFile.filepath})`)
+
         if (processedEnvFile.error) {
+          errorCount += 1
+
           if (processedEnvFile.error.code === 'MISSING_ENV_FILE') {
-            logger.warn(processedEnvFile.error.message)
+            logger.error(processedEnvFile.error.message)
             logger.help(`? add one with [echo "HELLO=World" > ${processedEnvFile.envFilepath}] and re-run [dotenvx decrypt]`)
           } else {
-            logger.warn(processedEnvFile.error.message)
+            logger.error(processedEnvFile.error.message)
           }
         } else if (processedEnvFile.changed) {
           fs.writeFileSync(processedEnvFile.filepath, processedEnvFile.envSrc, ENCODING)
@@ -52,6 +67,10 @@ function decrypt () {
       } else {
         // do nothing - scenario when no .env files found
       }
+
+      if (errorCount > 0) {
+        process.exit(1)
+      }
     } catch (error) {
       logger.error(error.message)
       if (error.help) {

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