@dotenvx/dotenvx 0.10.4 → 0.10.6

package/README.md

@@ -11,10 +11,30 @@
 
 ### Quickstart
 
+Install and use it in code just like `dotenv`.
+
+```sh
+npm install @dotenvx/dotenvx --save
+```
+```js
+// index.js
+require('@dotenvx/dotenvx').config()
+
+console.log(`Hello ${process.env.HELLO}`)
+```
+
+ 
+
+Or install globally
+
 ```sh
 brew install dotenvx/brew/dotenvx
 ```
-> * [other ways to install](https://dotenvx.com/docs/install)
+> * [other global ways to install](https://dotenvx.com/docs/install)
+>
+> Installing globally as a cli unlocks dotenv for ANY language, framework, or platform. 💥
+>
+> I am using (and recommending) this approach going forward. – [motdotla](https://github.com/motdotla)
 
  
 
@@ -134,6 +154,14 @@ More examples
   World
   ```
 
+  </details>
+* <details><summary>Cron ⏰</summary><br>
+
+  ```sh
+  # run every day at 8am
+  0 8 * * * dotenvx run -- /path/to/myscript.sh
+  ```
+
   </details>
 * <details><summary>Frameworks ▲</summary><br>
 
@@ -329,6 +357,33 @@ More examples
   ```
 
   </details>
+* <details><summary>`--quiet` flag</summary><br>
+
+  Use `--quiet` to suppress all output (except errors).
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --quiet -- node index.js
+  Hello production
+  ```
+
+  </details>
+* <details><summary>`--log-level` flag</summary><br>
+
+  Set `--log-level` to whatever you wish. For example, to supress warnings (risky), set log level to `error`:
+
+  ```sh
+  $ echo "HELLO=production" > .env.production
+
+  $ dotenvx run --env-file=.env.production --log-level=error -- node index.js
+  Hello production
+  ```
+
+  Available log levels are `error, warn, info, verbose, debug, silly`
+
+  </details>
+
 
 &nbsp;
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.4",
+  "version": "0.10.6",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -30,7 +30,7 @@
     "clipboardy": "^2.3.0",
     "commander": "^11.1.0",
     "conf": "^10.2.0",
-    "dotenv": "^16.3.1",
+    "dotenv": "^16.4.0",
     "execa": "^5.1.1",
     "ignore": "^5.3.0",
     "open": "^8.4.2",

package/src/cli/actions/{predockerbuild.js → prebuild.js}

@@ -5,13 +5,13 @@ const ignore = require('ignore')
 const logger = require('./../../shared/logger')
 const helpers = require('./../helpers')
 
-function predockerbuild () {
+function prebuild () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
   // 1. check for .dockerignore file
   if (!fs.existsSync('.dockerignore')) {
-    logger.errorvpd('.dockerignore missing')
+    logger.errorvpb('.dockerignore missing')
     logger.help2('? add it with [touch .dockerignore]')
     process.exit(1)
   }
@@ -45,7 +45,7 @@ function predockerbuild () {
         case '.env.vault':
           break
         default:
-          logger.errorvpd(`${file} not properly dockerignored`)
+          logger.errorvpb(`${file} not properly dockerignored`)
           logger.help2(`? add ${file} to .dockerignore with [echo ".env*" >> .dockerignore]`)
           process.exit(1) // 3.1 exit early with error code
           break
@@ -55,10 +55,10 @@ function predockerbuild () {
 
   // 3. outpout success
   if (warningCount > 0) {
-    logger.successvpd(`success (with ${helpers.pluralize('warning', warningCount)})`)
+    logger.successvpb(`success (with ${helpers.pluralize('warning', warningCount)})`)
   } else {
-    logger.successvpd('success')
+    logger.successvpb('success')
   }
 }
 
-module.exports = predockerbuild
+module.exports = prebuild

package/src/cli/dotenvx.js

@@ -73,11 +73,11 @@ program.command('precommit')
   .option('-i, --install', 'install to .git/hooks/pre-commit')
   .action(require('./actions/precommit'))
 
-// dotenvx predockerbuild
-program.command('predockerbuild')
-  .description('prevent including .env files in docker build')
-  .addHelpText('after', examples.predockerbuild)
-  .action(require('./actions/predockerbuild'))
+// dotenvx prebuild
+program.command('prebuild')
+  .description('prevent including .env files in docker builds')
+  .addHelpText('after', examples.prebuild)
+  .action(require('./actions/prebuild'))
 
 // dotenvx hub
 program.addCommand(require('./commands/hub'))

package/src/cli/examples.js

@@ -66,19 +66,19 @@ Try it:
   `
 }
 
-const predockerbuild = function () {
+const prebuild = function () {
   return `
 Examples:
 
   \`\`\`
-  $ dotenvx predockerbuild
+  $ dotenvx prebuild
   \`\`\`
 
 Try it:
 
   \`\`\`
-  $ dotenvx predockerbuild
-  [dotenvx@0.10.0][predockerbuild] success
+  $ dotenvx prebuild
+  [dotenvx@0.10.0][prebuild] success
   \`\`\`
   `
 }
@@ -87,5 +87,5 @@ module.exports = {
   run,
   encrypt,
   precommit,
-  predockerbuild
+  prebuild
 }

package/src/lib/main.js

@@ -6,7 +6,21 @@ const config = function (options) {
 }
 
 const decrypt = function (encrypted, keyStr) {
-  return dotenv.decrypt(encrypted, keyStr)
+  try {
+    return dotenv.decrypt(encrypted, keyStr)
+  } catch (e) {
+    switch (e.code) {
+      case 'DECRYPTION_FAILED':
+        // more helpful error when decryption fails
+        logger.error('[DECRYPTION_FAILED] Unable to decrypt .env.vault with DOTENV_KEY.')
+        logger.help('[DECRYPTION_FAILED] Run with debug flag [dotenvx run --debug -- yourcommand] or manually run [echo $DOTENV_KEY] to compare it to the one in .env.keys.')
+        logger.debug(`[DECRYPTION_FAILED] DOTENV_KEY is ${process.env.DOTENV_KEY}`)
+        process.exit(1)
+        break
+      default:
+        throw e
+    }
+  }
 }
 
 const configDotenv = function (options) {

package/src/shared/logger.js

@@ -12,15 +12,15 @@ const levels = {
   error: 0,
   errorv: 0,
   errorvp: 0,
-  errorvpd: 0,
+  errorvpb: 0,
   warn: 1,
   warnv: 1,
   warnvp: 1,
-  warnvpd: 1,
+  warnvpb: 1,
   success: 2,
   successv: 2,
   successvp: 2,
-  successvpd: 2,
+  successvpb: 2,
   info: 2,
   help: 2,
   help2: 2,
@@ -51,24 +51,24 @@ const dotenvxFormat = printf(({ level, message, label, timestamp }) => {
       return error(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'errorvp':
       return error(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
-    case 'errorvpd':
-      return error(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
+    case 'errorvpb':
+      return error(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     case 'warn':
       return warn(formattedMessage)
     case 'warnv':
       return warn(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'warnvp':
       return warn(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
-    case 'warnvpd':
-      return warn(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
+    case 'warnvpb':
+      return warn(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     case 'success':
       return success(formattedMessage)
     case 'successv': // success with 'version'
       return successv(`[dotenvx@${packageJson.version}] ${formattedMessage}`)
     case 'successvp': // success with 'version' and precommit
       return success(`[dotenvx@${packageJson.version}][precommit] ${formattedMessage}`)
-    case 'successvpd': // success with 'version' and precommit
-      return success(`[dotenvx@${packageJson.version}][predockerbuild] ${formattedMessage}`)
+    case 'successvpb': // success with 'version' and precommit
+      return success(`[dotenvx@${packageJson.version}][prebuild] ${formattedMessage}`)
     case 'info':
       return formattedMessage
     case 'help':