@dotenvx/dotenvx 0.36.1 → 0.37.1

package/README.md

@@ -490,7 +490,25 @@ More examples
   Available log levels are `error, warn, info, verbose, debug, silly`
 
   </details>
+* <details><summary>`--convention` flag</summary><br>
 
+  Want to load envs conveniently usng the same convention as Next.js? Set `--convention` to `nextjs`:
+
+  ```sh
+  $ echo "HELLO=development local" > .env.development.local
+  $ echo "HELLO=local" > .env.local
+  $ echo "HELLO=development" > .env.development
+  $ echo "HELLO=env" > .env
+
+  $ dotenvx run --convention=nextjs -- node index.js
+  Hello development local
+  ```
+
+  See [next.js environment variable load order](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#environment-variable-load-order)
+
+  (more conventions available upon request)
+
+  </details>
 
 &nbsp;
 

package/package.json

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

package/src/cli/actions/run.js

@@ -5,6 +5,8 @@ const logger = require('./../../shared/logger')
 
 const Run = require('./../../lib/services/run')
 
+const conventions = require('./../../lib/helpers/conventions')
+
 const executeCommand = async function (commandArgs, env) {
   const signals = [
     'SIGHUP', 'SIGQUIT', 'SIGILL', 'SIGTRAP', 'SIGABRT',
@@ -102,9 +104,15 @@ async function run () {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const envs = this.envs
-
   try {
+    let envs = []
+    // handle shorthand conventions - like --convention=nextjs
+    if (options.convention) {
+      envs = conventions(options.convention).concat(this.envs)
+    } else {
+      envs = this.envs
+    }
+
     const {
       processedEnvs,
       readableStrings,

package/src/cli/actions/status.js

@@ -9,40 +9,69 @@ function status (directory) {
   const options = this.opts()
   logger.debug(`options: ${JSON.stringify(options)}`)
 
-  const { changes, nochanges } = main.status(directory)
+  try {
+    const { changes, nochanges, untracked } = main.status(directory)
 
-  const changeFilenames = []
-  const nochangeFilenames = []
+    const changeFilenames = []
+    const nochangeFilenames = []
+    const untrackedFilenames = []
 
-  for (const row of nochanges) {
-    nochangeFilenames.push(row.filename)
-  }
+    for (const row of nochanges) {
+      nochangeFilenames.push(row.filename)
+    }
 
-  if (nochangeFilenames.length > 0) {
-    logger.blank(`no changes (${nochangeFilenames.join(', ')})`)
-  }
+    if (nochangeFilenames.length > 0) {
+      logger.blank(`no changes (${nochangeFilenames.join(', ')})`)
+    }
 
-  for (const row of changes) {
-    changeFilenames.push(row.filename)
-  }
+    for (const row of changes) {
+      changeFilenames.push(row.filename)
+    }
 
-  if (changeFilenames.length > 0) {
-    logger.warn(`changes (${changeFilenames.join(', ')})`)
-  }
+    if (changeFilenames.length > 0) {
+      logger.warn(`changes (${changeFilenames.join(', ')})`)
+    }
 
-  for (const row of changes) {
-    logger.blank('')
-    const padding = '    '
-    logger.blank(`${padding}\`\`\`${row.filename}`)
-    const paddedResult = row.coloredDiff.split('\n').map(line => padding + line).join('\n')
-    console.log(paddedResult)
-    logger.blank(`${padding}\`\`\``)
-  }
+    for (const row of changes) {
+      logger.blank('')
+      const padding = '    '
+      logger.blank(`${padding}\`\`\`${row.filename}`)
+      const paddedResult = row.coloredDiff.split('\n').map(line => padding + line).join('\n')
+      console.log(paddedResult)
+      logger.blank(`${padding}\`\`\``)
+    }
+
+    if (changeFilenames.length > 0) {
+      logger.blank('')
+      const optionalDirectory = directory === '.' ? '' : ` ${directory}`
+      logger.blank(`run [dotenvx encrypt${optionalDirectory}] to apply changes to .env.vault`)
+    }
+
+    if (nochangeFilenames.length < 1 && changeFilenames.length < 1) {
+      logger.warn('no .env* files.')
+      logger.help('? add one with [echo "HELLO=World" > .env] and then run [dotenvx status]')
+    }
+
+    for (const row of untracked) {
+      untrackedFilenames.push(row.filename)
+    }
 
-  if (changeFilenames.length > 0) {
-    logger.blank('')
-    const optionalDirectory = directory === '.' ? '' : ` ${directory}`
-    logger.blank(`run [dotenvx encrypt${optionalDirectory}] to apply changes to .env.vault`)
+    if (untrackedFilenames.length > 0) {
+      logger.warn(`untracked (${untrackedFilenames.join(', ')})`)
+      logger.help(`? track them with [dotenvx encrypt ${directory}]`)
+    }
+  } catch (error) {
+    logger.error(error.message)
+    if (error.help) {
+      logger.help(error.help)
+    }
+    if (error.debug) {
+      logger.debug(error.debug)
+    }
+    if (error.code) {
+      logger.debug(`ERROR_CODE: ${error.code}`)
+    }
+    process.exit(1)
   }
 }
 

package/src/cli/dotenvx.js

@@ -69,6 +69,7 @@ program.command('run')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
   .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
   .option('-o, --overload', 'override existing env variables')
+  .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
   .action(function (...args) {
     this.envs = envs
 

package/src/lib/helpers/conventions.js

@@ -0,0 +1,29 @@
+function conventions (convention) {
+  if (convention === 'nextjs') {
+    const nodeEnv = process.env.NODE_ENV || 'development'
+
+    const envs = []
+
+    if (['development', 'test', 'production'].includes(nodeEnv)) {
+      envs.push({ type: 'envFile', value: `.env.${nodeEnv}.local` })
+    }
+
+    if (['development', 'production'].includes(nodeEnv)) {
+      envs.push({ type: 'envFile', value: '.env.local' })
+    }
+
+    if (['development', 'test', 'production'].includes(nodeEnv)) {
+      envs.push({ type: 'envFile', value: `.env.${nodeEnv}` })
+    }
+
+    if (['development', 'test', 'production'].includes(nodeEnv)) {
+      envs.push({ type: 'envFile', value: '.env' })
+    }
+
+    return envs
+  } else {
+    throw new Error(`INVALID_CONVENTION: '${convention}'. permitted conventions: ['nextjs']`)
+  }
+}
+
+module.exports = conventions

package/src/lib/services/status.js

@@ -16,6 +16,7 @@ class Status {
     this.directory = directory
     this.changes = []
     this.nochanges = []
+    this.untracked = [] // not tracked in .env.vault
   }
 
   run () {
@@ -60,7 +61,14 @@ class Status {
 
       // grab decrypted
       const { processedEnvs } = new Decrypt(this.directory, row.environment).run()
-      row.decrypted = processedEnvs[0].decrypted
+      const result = processedEnvs[0]
+
+      // handle warnings
+      row.decrypted = result.decrypted
+      if (result.warning) {
+        this.untracked.push(row)
+        continue
+      }
 
       // differences
       row.differences = diff.diffWords(row.decrypted, row.raw)
@@ -78,7 +86,8 @@ class Status {
 
     return {
       changes: this.changes,
-      nochanges: this.nochanges
+      nochanges: this.nochanges,
+      untracked: this.untracked
     }
   }